Published API contract date. Omit or use latest for the latest contract; explicit dates stay pinned. Applies to request validation and response format.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"QFEX API Documentation","colors":{"primary":"#38A5A0","light":"#38A5A0","dark":"#38A5A0"},"logo":{"light":"https://mintcdn.com/qfex/_KzvrZZNknwtc25D/logo/light.svg?fit=max\u0026auto=format\u0026n=_KzvrZZNknwtc25D\u0026q=85\u0026s=d91fb93b918683d2d0a4c0517ca8c4af","dark":"https://mintcdn.com/qfex/_KzvrZZNknwtc25D/logo/dark.svg?fit=max\u0026auto=format\u0026n=_KzvrZZNknwtc25D\u0026q=85\u0026s=4a7afe5885910915c87c239f874ffc62","href":"https://qfex.com"},"favicon":"https://mintcdn.com/qfex/_KzvrZZNknwtc25D/favicon.svg?fit=max\u0026auto=format\u0026n=_KzvrZZNknwtc25D\u0026q=85\u0026s=b46838d937d798434426fba1b1771841","background":{"color":{"light":"#F9FAFB","dark":"#172027"}},"navbar":{"links":[{"href":"mailto:support@qfex.com","label":"Support"}],"primary":{"type":"button","label":"Trade Now","href":"https://qfex.com/trade"}},"footer":{"socials":{"x":"https://x.com/QFEX","github":"https://github.com/QFEX-org","linkedin":"https://linkedin.com/company/qfex","discord":"https://discord.qfex.com"}},"fonts":{"family":"DM Sans"},"thumbnails":{"fonts":{"family":"Noto Sans SC"}},"styling":{"latex":true},"navigation":{"global":{"anchors":[{"anchor":"Status / 运行状态","icon":"signal-bars","href":"https://status.qfex.com"}]},"languages":[{"language":"en","default":true,"href":"qfex/about"},{"language":"cn","href":"cn/qfex/about"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"qfex","hasAudioNarration":false,"actualSubdomain":"qfex","customDomains":["docs.qfex.com"],"gitSource":{"type":"github","owner":"qfex-org","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6af454573ff658938299d205","clientVersion":"0.0.4111","searchFilterCounts":[{"language":"default","tag":"API Reference","count":87},{"language":"default","tag":"REST API","count":86},{"language":"en","tag":"API Reference","count":51},{"language":"cn","tag":"API 参考","count":51},{"language":"default","tag":"user","count":50},{"language":"en","tag":"WebSocket","count":34},{"language":"cn","tag":"WebSocket","count":34},{"language":"default","tag":"market-data","count":28},{"language":"en","tag":"QFEX","count":23},{"language":"cn","tag":"QFEX","count":23},{"language":"en","tag":"Trade","count":21},{"language":"cn","tag":"交易","count":21},{"language":"en","tag":"Trading Rulebook","count":13},{"language":"cn","tag":"交易规则","count":13},{"language":"en","tag":"API Documentation","count":10},{"language":"en","tag":"Market Data","count":10},{"language":"cn","tag":"API 文档","count":10},{"language":"cn","tag":"行情数据","count":10},{"language":"en","tag":"Legal","count":4},{"language":"cn","tag":"法律文件","count":4},{"language":"default","tag":"builder","count":4},{"language":"en","tag":"Builder Codes","count":3},{"language":"en","tag":"Intro","count":3},{"language":"cn","tag":"Builder Codes","count":3},{"language":"cn","tag":"简介","count":3},{"language":"default","tag":"pnl","count":2},{"language":"default","tag":"public","count":2},{"language":"default","tag":"API Documentation","count":1}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[],"page":{"pagePath":"api-reference/rest/user/user-referral-rewards","slug":"/api-reference/rest/user/user-referral-rewards","pageMetadata":{"title":"User Referral Rewards","description":"Return daily referral rewards for the authenticated user.","deprecated":null,"version":null,"openapi":"https://api.qfex.com/openapi.yaml get /user/referral-rewards","href":"/api-reference/rest/user/user-referral-rewards","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Return daily referral rewards for the authenticated user.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"User Referral Rewards","description":"Return daily referral rewards for the authenticated user.","deprecated":null,"version":null,"openapi":"https://api.qfex.com/openapi.yaml get /user/referral-rewards","href":"/api-reference/rest/user/user-referral-rewards","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/qfex/56c86559303091d8/fetch-enums.js","/_mintlify/custom/qfex/67fc06a5fec38fcc/generate-specification-index.js","/_mintlify/custom/qfex/247bca39b96714fa/generate-roll-schedules.js"],"openApiReferenceData":{"operation":{"description":"Return daily referral rewards for the authenticated user.","operationId":"read-user-referral-rewards","parameters":["6dfdb08a-5e9e-4b7c-a8fe-9fc38746a883","75a993c9-f599-47cd-b255-01cf701cdd34"],"responses":{"200":"80748022-c22e-42f3-8d70-3d6b2ec28904","default":"8b73ca24-af13-49d4-9a68-0d6486033e33"},"security":["c626738d-7425-4ff3-a104-f83dd253965c"],"summary":"User Referral Rewards","tags":["user"],"method":"get","type":"path","servers":["2191e3c6-5b9d-4022-8ad8-a2a3a3a92874"],"path":"/user/referral-rewards","baseUrlOptions":["https://api.qfex.com"],"title":"User Referral Rewards","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"6dfdb08a-5e9e-4b7c-a8fe-9fc38746a883":{"explode":false,"in":"query","name":"duration","schema":{"default":"1w","type":"string","uniqueKey":"","typeLabel":"string"}},"75a993c9-f599-47cd-b255-01cf701cdd34":{"description":"Published API contract date. Omit or use latest for the latest contract; explicit dates stay pinned. Applies to request validation and response format.","in":"query","name":"api_version","schema":{"examples":["2026-10-30"],"type":"string","description":"Published API contract date. Omit or use latest for the latest contract; explicit dates stay pinned. Applies to request validation and response format.","uniqueKey":"","typeLabel":"string"}}},"responses":{"80748022-c22e-42f3-8d70-3d6b2ec28904":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"count":{"format":"int64","type":"integer","isRequired":true,"uniqueKey":"count","typeLabel":"integer\u003cint64>"},"data":{"oneOf":[{"items":{"additionalProperties":false,"properties":{"amount":{"format":"double","type":"number","isRequired":true,"uniqueKey":"data.oneOf.0.items.[INDEX].amount","typeLabel":"number\u003cdouble>"},"reward_date":{"format":"date-time","type":"string","isRequired":true,"uniqueKey":"data.oneOf.0.items.[INDEX].reward_date","typeLabel":"string\u003cdate-time>"}},"required":["reward_date","amount"],"type":"object","uniqueKey":"data.oneOf.0.items.[INDEX]","typeLabel":"object"},"type":"array","isRequired":true,"uniqueKey":"data.oneOf.0","typeLabel":"object[]"},{"items":{"additionalProperties":false,"properties":{"amount":{"format":"double","type":"number"},"reward_date":{"format":"date-time","type":"string"}},"required":["reward_date","amount"],"type":"object"},"type":"null","isRequired":true,"uniqueKey":"data.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data","typeLabel":"object[] | null"},"duration":{"type":"string","isRequired":true,"uniqueKey":"duration","typeLabel":"string"},"end":{"format":"date-time","type":"string","isRequired":true,"uniqueKey":"end","typeLabel":"string\u003cdate-time>"},"interval":{"type":"string","isRequired":true,"uniqueKey":"interval","typeLabel":"string"},"total_amount":{"format":"double","type":"number","isRequired":true,"uniqueKey":"total_amount","typeLabel":"number\u003cdouble>"},"$schema":{"description":"A URL to the JSON Schema for this object.","examples":["https://api.qfex.com/contracts/2026-10-30/schemas/ReferralRewardsResponseBody.json"],"format":"uri","readOnly":true,"type":"string","uniqueKey":"$schema","typeLabel":"string\u003curi>"},"start":{"format":"date-time","type":"string","uniqueKey":"start","typeLabel":"string\u003cdate-time>"}},"required":["duration","interval","end","data","count","total_amount"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"count":123,"data":[{"amount":123,"reward_date":"2023-11-07T05:31:56Z"}],"duration":"\u003cstring>","end":"2023-11-07T05:31:56Z","interval":"\u003cstring>","total_amount":123,"$schema":"https://api.qfex.com/contracts/2026-10-30/schemas/ReferralRewardsResponseBody.json","start":"2023-11-07T05:31:56Z"}}},"exampleType":"generated"}},"description":"OK","exampleType":"generated"},"8b73ca24-af13-49d4-9a68-0d6486033e33":{"content":{"application/problem+json":{"schema":{"additionalProperties":false,"properties":{"$schema":{"description":"A URL to the JSON Schema for this object.","examples":["https://api.qfex.com/contracts/2026-10-30/schemas/ErrorModel.json"],"format":"uri","readOnly":true,"type":"string","uniqueKey":"$schema","typeLabel":"string\u003curi>"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","examples":["Property foo is required but is missing."],"type":"string","uniqueKey":"detail","typeLabel":"string"},"errors":{"oneOf":[{"description":"Optional list of individual error details","items":{"additionalProperties":false,"properties":{"location":{"description":"Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'","type":"string","uniqueKey":"errors.oneOf.0.items.[INDEX].location","typeLabel":"string"},"message":{"description":"Error message text","type":"string","uniqueKey":"errors.oneOf.0.items.[INDEX].message","typeLabel":"string"},"value":{"description":"The value at the given location","uniqueKey":"errors.oneOf.0.items.[INDEX].value","typeLabel":"any"}},"type":"object","uniqueKey":"errors.oneOf.0.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"errors.oneOf.0","typeLabel":"object[]"},{"description":"Optional list of individual error details","items":{"additionalProperties":false,"properties":{"location":{"description":"Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'","type":"string"},"message":{"description":"Error message text","type":"string"},"value":{"description":"The value at the given location"}},"type":"object"},"type":"null","uniqueKey":"errors.oneOf.1","typeLabel":"null"}],"uniqueKey":"errors","typeLabel":"object[] | null"},"instance":{"description":"A URI reference that identifies the specific occurrence of the problem.","examples":["https://example.com/error-log/abc123"],"format":"uri","type":"string","uniqueKey":"instance","typeLabel":"string\u003curi>"},"status":{"description":"HTTP status code","examples":[400],"format":"int64","type":"integer","uniqueKey":"status","typeLabel":"integer\u003cint64>"},"title":{"description":"A short, human-readable summary of the problem type. This value should not change between occurrences of the error.","examples":["Bad Request"],"type":"string","uniqueKey":"title","typeLabel":"string"},"type":{"default":"about:blank","description":"A URI reference to human-readable documentation for the error.","examples":["https://example.com/errors/example"],"format":"uri","type":"string","uniqueKey":"type","typeLabel":"string\u003curi>"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"$schema":"https://api.qfex.com/contracts/2026-10-30/schemas/ErrorModel.json","detail":"Property foo is required but is missing.","errors":[{"location":"\u003cstring>","message":"\u003cstring>","value":"\u003cunknown>"}],"instance":"https://example.com/error-log/abc123","status":400,"title":"Bad Request","type":"https://example.com/errors/example"}}},"exampleType":"generated"}},"description":"Error","exampleType":"generated"}},"security":{"c626738d-7425-4ff3-a104-f83dd253965c":{"HMACSignature":{"description":"HMAC-SHA256 signature (hex-encoded).","in":"header","name":"x-qfex-hmac-signature","type":"apiKey","x-stoplight":{"hideExamples":true},"scopes":[],"schemeName":"HMACSignature"},"Nonce":{"description":"Unique request nonce (hex encoded, max 100 characters).","in":"header","name":"x-qfex-nonce","type":"apiKey","x-stoplight":{"hideExamples":true},"scopes":[],"schemeName":"Nonce"},"PublicKey":{"description":"QFEX API Authentication requires these headers:\n\n- **x-qfex-public-key**: Your public API key\n- **x-qfex-hmac-signature**: HMAC signature of the request (hex encoded)\n- **x-qfex-nonce**: Unique nonce for the request (hex encoded, max 100 characters)\n- **x-qfex-timestamp**: Unix timestamp of the request\n\nThese four are required. Optionally send **x-qfex-requested-account-id** (UUID) to act as a subaccount; see Signature Generation below.\n\n**Signature Generation:**\n\n1. Generate a cryptographically secure random nonce (hex encoded, max 100 characters) and capture the current Unix timestamp.\n2. Build the string `${nonce}:${unix_ts}` and compute an HMAC-SHA256 using your secret key.\n3. Hex-encode the HMAC result to get the signature.\n4. Send the required auth headers below. The nonce must be unique within a 15 minute window.\n\n**Important:** The signature itself must be hex-encoded before being sent in the `x-qfex-hmac-signature` header.\n\n**Optional header:** `x-qfex-requested-account-id` (UUID) selects an account where the authenticated user is a member; omit it to use the primary account.","in":"header","name":"x-qfex-public-key","type":"apiKey","x-stoplight":{"hideExamples":true},"scopes":[],"schemeName":"PublicKey"},"Timestamp":{"description":"Unix timestamp (seconds since epoch).","in":"header","name":"x-qfex-timestamp","type":"apiKey","x-stoplight":{"hideExamples":true},"scopes":[],"schemeName":"Timestamp"}}},"servers":{"2191e3c6-5b9d-4022-8ad8-a2a3a3a92874":{"description":"Production server","url":"https://api.qfex.com"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"description":"HMAC-SHA256 signature (hex-encoded).","in":"header","name":"x-qfex-hmac-signature","type":"apiKey","x-stoplight":{"hideExamples":true},"scopes":[],"schemeName":"HMACSignature"},"schema":{"title":"x-qfex-hmac-signature","type":"string","description":"HMAC-SHA256 signature (hex-encoded).","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"HMACSignature","name":"x-qfex-hmac-signature"},{"scheme":{"description":"Unique request nonce (hex encoded, max 100 characters).","in":"header","name":"x-qfex-nonce","type":"apiKey","x-stoplight":{"hideExamples":true},"scopes":[],"schemeName":"Nonce"},"schema":{"title":"x-qfex-nonce","type":"string","description":"Unique request nonce (hex encoded, max 100 characters).","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"Nonce","name":"x-qfex-nonce"},{"scheme":{"description":"QFEX API Authentication requires these headers:\n\n- **x-qfex-public-key**: Your public API key\n- **x-qfex-hmac-signature**: HMAC signature of the request (hex encoded)\n- **x-qfex-nonce**: Unique nonce for the request (hex encoded, max 100 characters)\n- **x-qfex-timestamp**: Unix timestamp of the request\n\nThese four are required. Optionally send **x-qfex-requested-account-id** (UUID) to act as a subaccount; see Signature Generation below.\n\n**Signature Generation:**\n\n1. Generate a cryptographically secure random nonce (hex encoded, max 100 characters) and capture the current Unix timestamp.\n2. Build the string `${nonce}:${unix_ts}` and compute an HMAC-SHA256 using your secret key.\n3. Hex-encode the HMAC result to get the signature.\n4. Send the required auth headers below. The nonce must be unique within a 15 minute window.\n\n**Important:** The signature itself must be hex-encoded before being sent in the `x-qfex-hmac-signature` header.\n\n**Optional header:** `x-qfex-requested-account-id` (UUID) selects an account where the authenticated user is a member; omit it to use the primary account.","in":"header","name":"x-qfex-public-key","type":"apiKey","x-stoplight":{"hideExamples":true},"scopes":[],"schemeName":"PublicKey"},"schema":{"title":"x-qfex-public-key","type":"string","description":"QFEX API Authentication requires these headers:\n\n- **x-qfex-public-key**: Your public API key\n- **x-qfex-hmac-signature**: HMAC signature of the request (hex encoded)\n- **x-qfex-nonce**: Unique nonce for the request (hex encoded, max 100 characters)\n- **x-qfex-timestamp**: Unix timestamp of the request\n\nThese four are required. Optionally send **x-qfex-requested-account-id** (UUID) to act as a subaccount; see Signature Generation below.\n\n**Signature Generation:**\n\n1. Generate a cryptographically secure random nonce (hex encoded, max 100 characters) and capture the current Unix timestamp.\n2. Build the string `${nonce}:${unix_ts}` and compute an HMAC-SHA256 using your secret key.\n3. Hex-encode the HMAC result to get the signature.\n4. Send the required auth headers below. The nonce must be unique within a 15 minute window.\n\n**Important:** The signature itself must be hex-encoded before being sent in the `x-qfex-hmac-signature` header.\n\n**Optional header:** `x-qfex-requested-account-id` (UUID) selects an account where the authenticated user is a member; omit it to use the primary account.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"PublicKey","name":"x-qfex-public-key"},{"scheme":{"description":"Unix timestamp (seconds since epoch).","in":"header","name":"x-qfex-timestamp","type":"apiKey","x-stoplight":{"hideExamples":true},"scopes":[],"schemeName":"Timestamp"},"schema":{"title":"x-qfex-timestamp","type":"string","description":"Unix timestamp (seconds since epoch).","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"Timestamp","name":"x-qfex-timestamp"}],"title":"HMACSignature \u0026 Nonce \u0026 PublicKey \u0026 Timestamp"}]},"originalFileLocation":"https://api.qfex.com/openapi.yaml"},"subdomain":"qfex","siteName":"QFEX API Documentation","title":"User Referral Rewards - QFEX API Documentation","navMaps":{"firstHrefInVersion":{"Latest":{"href":"/api-reference/rest/user/user-referral-rewards","matchLevel":0},"2026-10-29":{"href":"/api-reference/rest/2026-10-29/builder/generate-a-wallet-users-main-account-trading-key","matchLevel":2}},"firstHrefInLanguage":{"en":{"href":"/api-reference/rest/user/user-referral-rewards","matchLevel":0},"cn":{"href":"/api-reference/rest/user/user-referral-rewards","matchLevel":0}}},"lastModified":"2026-11-11T11:22:43.353Z","originalFileLocation":"api-reference/rest/user/user-referral-rewards.mdx","locale":"en"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Return daily referral rewards for the authenticated user.\">\u003cmeta data-mint-head name=\"application-name\" content=\"QFEX API Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/qfex/NR4Uw7CiIxkYf2rd/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/qfex/NR4Uw7CiIxkYf2rd/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/qfex/NR4Uw7CiIxkYf2rd/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/qfex/NR4Uw7CiIxkYf2rd/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/qfex/NR4Uw7CiIxkYf2rd/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/qfex/NR4Uw7CiIxkYf2rd/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/qfex/NR4Uw7CiIxkYf2rd/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/qfex/NR4Uw7CiIxkYf2rd/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/qfex/NR4Uw7CiIxkYf2rd/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"User Referral Rewards - QFEX API Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Return daily referral rewards for the authenticated user.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"QFEX API Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.qfex.com/api-reference/rest/user/user-referral-rewards\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://qfex.mintlify.site/_mintlify/api/og/v2?division=user\u0026amp;title=User+Referral+Rewards\u0026amp;description=Return+daily+referral+rewards+for+the+authenticated+user.\u0026amp;theme=263f735443fef1e79a7e3e55\u0026amp;signature=e861433633d3abc07e6364d7b4b5b94a614d6f2bb173fe7819dd0baa57b9a291\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"User Referral Rewards - QFEX API Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Return daily referral rewards for the authenticated user.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://qfex.mintlify.site/_mintlify/api/og/v2?division=user\u0026amp;title=User+Referral+Rewards\u0026amp;description=Return+daily+referral+rewards+for+the+authenticated+user.\u0026amp;theme=263f735443fef1e79a7e3e55\u0026amp;signature=e861433633d3abc07e6364d7b4b5b94a614d6f2bb173fe7819dd0baa57b9a291\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/qfex/NR4Uw7CiIxkYf2rd/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"QFEX API Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#38A5A0\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.qfex.com/api-reference/rest/user/user-referral-rewards\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/rest/user/user-referral-rewards.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.qfex.com/#organization\",\"name\":\"QFEX API Documentation\",\"url\":\"https://docs.qfex.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/qfex/_KzvrZZNknwtc25D/logo/light.svg?fit=max\u0026auto=format\u0026n=_KzvrZZNknwtc25D\u0026q=85\u0026s=d91fb93b918683d2d0a4c0517ca8c4af\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.qfex.com#website\",\"name\":\"QFEX API Documentation\",\"url\":\"https://docs.qfex.com\",\"publisher\":{\"@id\":\"https://docs.qfex.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.qfex.com/api-reference/rest/user/user-referral-rewards#webpage\",\"url\":\"https://docs.qfex.com/api-reference/rest/user/user-referral-rewards\",\"name\":\"User Referral Rewards\",\"description\":\"Return daily referral rewards for the authenticated user.\",\"dateModified\":\"2026-11-11T11:22:43.353Z\",\"isPartOf\":{\"@id\":\"https://docs.qfex.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.qfex.com/api-reference/rest/user/user-referral-rewards#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.qfex.com/api-reference/rest/user/user-referral-rewards#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"REST API\",\"item\":\"https://docs.qfex.com/api-reference/rest/builder/generate-a-wallet-users-main-account-trading-key\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"user\",\"item\":\"https://docs.qfex.com/api-reference/rest/user/executions\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"User Referral Rewards\",\"item\":\"https://docs.qfex.com/api-reference/rest/user/user-referral-rewards\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.qfex.com/api-reference/rest/user/user-referral-rewards#apireference\",\"headline\":\"User Referral Rewards\",\"name\":\"User Referral Rewards\",\"description\":\"Return daily referral rewards for the authenticated user.\",\"url\":\"https://docs.qfex.com/api-reference/rest/user/user-referral-rewards\",\"mainEntityOfPage\":{\"@id\":\"https://docs.qfex.com/api-reference/rest/user/user-referral-rewards#webpage\"},\"dateModified\":\"2026-11-11T11:22:43.353Z\",\"publisher\":{\"@id\":\"https://docs.qfex.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.qfex.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"QFEX API Documentation\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"QFEX API Documentation\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/rest/user/user-referral-rewards.md","siteName":"QFEX API Documentation","nav":{"global":{"anchors":[{"anchor":"Status / 运行状态","icon":"signal-bars","href":"https://status.qfex.com"}]},"languages":[{"language":"en","default":true,"versions":[{"version":"Latest","default":true,"tabs":[{"tab":"QFEX","pages":[{"title":"QFEX","href":"/qfex/about"}]},{"tab":"API Reference","groups":[{"group":"API Documentation","pages":[{"title":"Introduction","href":"/api-reference/introduction"},{"title":"API versioning","href":"/api-reference/versioning"},{"title":"Account execution history","href":"/api-reference/executions"},{"title":"API Keys","href":"/api-reference/api-keys"},{"title":"Wallet authentication","href":"/api-reference/wallet-authentication"},{"title":"Programmatic deposits and withdrawals","href":"/api-reference/programmatic-funding"},{"title":"CLI","href":"/api-reference/cli"},{"title":"Enums","href":"/api-reference/enums"},{"title":"Errors","href":"/websocket/errors"},{"title":"API Rate Limits","href":"/websocket/rate"},{"title":"Changelog","href":"/websocket/changelog"}]},{"group":"Builder Codes","pages":[{"title":"Builder Integration Guide","href":"/api-reference/builder-integration"},{"title":"Builder wallet registration","href":"/api-reference/builder-wallet-registration"},{"title":"Builder Codes API","href":"/api-reference/builder-codes"}]},{"group":"REST API","pages":[{"group":"builder","pages":[{"title":"Generate a wallet user's main-account trading key","deprecated":null,"version":null,"openapi":"https://api.qfex.com/openapi.yaml post /builder/web3/api-key","href":"/api-reference/rest/builder/generate-a-wallet-users-main-account-trading-key"},{"title":"Get the wallet message for a builder trading key","deprecated":null,"version":null,"openapi":"https://api.qfex.com/openapi.yaml get /builder/web3/message","href":"/api-reference/rest/builder/get-the-wallet-message-for-a-builder-trading-key"}]},{"group":"market-data","pages":[{"title":"Earnings and Economic Calendar","deprecated":null,"version":null,"openapi":"https://api.qfex.com/openapi.yaml get /calendar","href":"/api-reference/rest/market-data/earnings-and-economic-calendar"},{"title":"Candles","deprecated":null,"version":null,"openapi":"https://api.qfex.com/openapi.yaml get /candles/{symbol}","href":"/api-reference/rest/market-data/candles"},{"title":"DefiLlama Metrics","deprecated":null,"version":null,"openapi":"https://api.qfex.com/openapi.yaml get /defillama/metrics","href":"/api-reference/rest/market-data/defillama-metrics"},{"title":"Funding Historic","deprecated":null,"version":null,"openapi":"https://api.qfex.com/openapi.yaml get /funding/{symbol}","href":"/api-reference/rest/market-data/funding-historic"},{"title":"Reference Market Holidays","deprecated":null,"version":null,"openapi":"https://api.qfex.com/openapi.yaml get /market-holidays","href":"/api-reference/rest/market-data/reference-market-holidays"},{"title":"Contracts","deprecated":null,"version":null,"openapi":"https://api.qfex.com/openapi.yaml get /md/contracts","href":"/api-reference/rest/market-data/contracts"},{"title":"Order Book","deprecated":null,"version":null,"openapi":"https://api.qfex.com/openapi.yaml get /md/orderbook/{ticker_id}","href":"/api-reference/rest/market-data/order-book"},{"title":"Open Interest Historic","deprecated":null,"version":null,"openapi":"https://api.qfex.com/openapi.yaml get /open-interest/{symbol}","href":"/api-reference/rest/market-data/open-interest-historic"},{"title":"Refdata","deprecated":null,"version":null,"openapi":"https://api.qfex.com/openapi.yaml get /refdata","href":"/api-reference/rest/market-data/refdata"},{"title":"Settlement Calendar","deprecated":null,"version":null,"openapi":"https://api.qfex.com/openapi.yaml get /settlement-calendar","href":"/api-reference/rest/market-data/settlement-calendar"},{"title":"Settlement Prices","deprecated":null,"version":null,"openapi":"https://api.qfex.com/openapi.yaml get /settlement-prices","href":"/api-reference/rest/market-data/settlement-prices"},{"title":"Symbol Long Short Historic","deprecated":null,"version":null,"openapi":"https://api.qfex.com/openapi.yaml get /symbol-long-short/{symbol}","href":"/api-reference/rest/market-data/symbol-long-short-historic"},{"title":"Taker Volume Historic","deprecated":null,"version":null,"openapi":"https://api.qfex.com/openapi.yaml get /taker-volume/{symbol}","href":"/api-reference/rest/market-data/taker-volume-historic"},{"title":"Underlier Historic","deprecated":null,"version":null,"openapi":"https://api.qfex.com/openapi.yaml get /underlier/{symbol}","href":"/api-reference/rest/market-data/underlier-historic"}]},{"group":"user","pages":[{"title":"Executions","deprecated":null,"version":null,"openapi":"https://api.qfex.com/openapi.yaml get /executions","href":"/api-reference/rest/user/executions"},{"title":"Stream Historic Orders CSV","deprecated":null,"version":null,"openapi":"https://api.qfex.com/openapi.yaml get /historic-orders-csv","href":"/api-reference/rest/user/stream-historic-orders-csv"},{"title":"Stream Historic TWAPs CSV","deprecated":null,"version":null,"openapi":"https://api.qfex.com/openapi.yaml get /historic-twaps-csv","href":"/api-reference/rest/user/stream-historic-twaps-csv"},{"title":"Redeem Invitation Code","deprecated":null,"version":null,"openapi":"https://api.qfex.com/openapi.yaml post /redeem-invitation-code","href":"/api-reference/rest/user/redeem-invitation-code"},{"title":"Stream Trades CSV","deprecated":null,"version":null,"openapi":"https://api.qfex.com/openapi.yaml get /trades-csv","href":"/api-reference/rest/user/stream-trades-csv"},{"title":"Account Equity","deprecated":null,"version":null,"openapi":"https://api.qfex.com/openapi.yaml get /user/account-equity","href":"/api-reference/rest/user/account-equity"},{"title":"Builder Code Details","deprecated":null,"version":null,"openapi":"https://api.qfex.com/openapi.yaml get /user/builder-code","href":"/api-reference/rest/user/builder-code-details"},{"title":"Create Builder Code","deprecated":null,"version":null,"openapi":"https://api.qfex.com/openapi.yaml post /user/builder-code","href":"/api-reference/rest/user/create-builder-code"},{"title":"User Fees","deprecated":null,"version":null,"openapi":"https://api.qfex.com/openapi.yaml get /user/fees","href":"/api-reference/rest/user/user-fees"},{"title":"User Flat Funding","deprecated":null,"version":null,"openapi":"https://api.qfex.com/openapi.yaml get /user/flat-funding","href":"/api-reference/rest/user/user-flat-funding"},{"title":"Historic Orders","deprecated":null,"version":null,"openapi":"https://api.qfex.com/openapi.yaml get /user/historic-orders","href":"/api-reference/rest/user/historic-orders"},{"title":"Historic User PnL","deprecated":null,"version":null,"openapi":"https://api.qfex.com/openapi.yaml get /user/historic-pnl","href":"/api-reference/rest/user/historic-user-pnl"},{"title":"Historic TWAPs","deprecated":null,"version":null,"openapi":"https://api.qfex.com/openapi.yaml get /user/historic-twaps","href":"/api-reference/rest/user/historic-twaps"},{"title":"Reconcile Invitation Codes (Legacy Path)","deprecated":null,"version":null,"openapi":"https://api.qfex.com/openapi.yaml post /user/invitation-codes/job","href":"/api-reference/rest/user/reconcile-invitation-codes-legacy-path"},{"title":"Set User Leverage","deprecated":null,"version":null,"openapi":"https://api.qfex.com/openapi.yaml post /user/leverage","href":"/api-reference/rest/user/set-user-leverage"},{"title":"User Positions","description":"Return current positions for the authenticated user.","deprecated":null,"version":null,"openapi":"https://api.qfex.com/openapi.yaml get /user/positions","href":"/api-reference/rest/user/user-positions"},{"title":"User Referral Rewards","deprecated":null,"version":null,"openapi":"https://api.qfex.com/openapi.yaml get /user/referral-rewards","href":"/api-reference/rest/user/user-referral-rewards"},{"title":"User Referral Notional Volume","description":"Return rolling 14-day and lifetime notional volume for the authenticated user and their direct referrals.","deprecated":null,"version":null,"openapi":"https://api.qfex.com/openapi.yaml get /user/referrals/notional-volume","href":"/api-reference/rest/user/user-referral-notional-volume"},{"title":"List Subaccounts","deprecated":null,"version":null,"openapi":"https://api.qfex.com/openapi.yaml get /user/subaccounts","href":"/api-reference/rest/user/list-subaccounts"},{"title":"Create Subaccount","deprecated":null,"version":null,"openapi":"https://api.qfex.com/openapi.yaml post /user/subaccounts","href":"/api-reference/rest/user/create-subaccount"},{"title":"List Account Balances","deprecated":null,"version":null,"openapi":"https://api.qfex.com/openapi.yaml get /user/subaccounts/balance","href":"/api-reference/rest/user/list-account-balances"},{"title":"List Account Equities","deprecated":null,"version":null,"openapi":"https://api.qfex.com/openapi.yaml get /user/subaccounts/equity","href":"/api-reference/rest/user/list-account-equities"},{"title":"User Trades","deprecated":null,"version":null,"openapi":"https://api.qfex.com/openapi.yaml get /user/trade","href":"/api-reference/rest/user/user-trades"},{"title":"Transfer Balance","deprecated":null,"version":null,"openapi":"https://api.qfex.com/openapi.yaml post /user/transfer","href":"/api-reference/rest/user/transfer-balance"},{"title":"User Volume","deprecated":null,"version":null,"openapi":"https://api.qfex.com/openapi.yaml get /user/volume","href":"/api-reference/rest/user/user-volume"}]},{"group":"pnl","pages":[{"title":"Hourly PnL (approx. first position per hour)","deprecated":null,"version":null,"openapi":"https://api.qfex.com/openapi.yaml get /pnl","href":"/api-reference/rest/pnl/hourly-pnl-approx-first-position-per-hour"}]},{"group":"public","pages":[{"title":"Public Leaderboard","deprecated":null,"version":null,"openapi":"https://api.qfex.com/openapi.yaml get /public/leaderboard","href":"/api-reference/rest/public/public-leaderboard"}]}]},{"group":"Funding API","pages":[{"group":"funding","pages":[{"title":"Get a crypto deposit address","deprecated":null,"version":null,"openapi":"/api-reference/funding-openapi.yaml get /address","href":"/api-reference/funding/funding/get-a-crypto-deposit-address"},{"title":"List registered crypto withdrawal addresses","deprecated":null,"version":null,"openapi":"/api-reference/funding-openapi.yaml get /withdrawal-addresses","href":"/api-reference/funding/funding/list-registered-crypto-withdrawal-addresses"},{"title":"Request a crypto withdrawal to a registered address","deprecated":null,"version":null,"openapi":"/api-reference/funding-openapi.yaml post /withdraw","href":"/api-reference/funding/funding/request-a-crypto-withdrawal-to-a-registered-address"}]}]},{"group":"WebSocket","pages":[{"title":"Websocket Overview","href":"/websocket/main"},{"title":"Trade Playground","asyncapi":"websocket/trade.yaml qfex","href":"/websocket/trade"},{"title":"MDS Playground","asyncapi":"websocket/mds.yaml qfex","href":"/websocket/mds"},{"group":"Market Data","pages":[{"title":"Reference Data","href":"/websocket/channels/mds/refdata"},{"title":"Pulsed Order Book","href":"/websocket/channels/mds/orderbook"},{"title":"Public Trades","href":"/websocket/channels/mds/trades"},{"title":"Pulsed BBO","href":"/websocket/channels/mds/bbo"},{"title":"Underlier Price","href":"/websocket/channels/mds/underlier"},{"title":"Funding Rate","href":"/websocket/channels/mds/funding_rate"},{"title":"Mark Price","href":"/websocket/channels/mds/mark_price"},{"title":"Open Interest","href":"/websocket/channels/mds/open_interest"},{"title":"Minmax Price","href":"/websocket/channels/mds/minmax_price"},{"title":"Market Stats","href":"/websocket/channels/mds/market_stats"}]},{"group":"Trade","pages":[{"title":"Authenticate","href":"/websocket/channels/trade/authenticate"},{"title":"Subscribe — Order Responses","href":"/websocket/channels/trade/order"},{"title":"Subscribe — Fills","href":"/websocket/channels/trade/fills"},{"title":"Order Entry — Add Order","href":"/websocket/channels/trade/add_order"},{"title":"Order Entry — Cancel Order","href":"/websocket/channels/trade/cancel_order"},{"title":"Order Entry — Modify Order","href":"/websocket/channels/trade/modify_order"},{"title":"Cancel All Orders","href":"/websocket/channels/trade/cancel_all_orders"},{"title":"Order Entry — Close Position","href":"/websocket/channels/trade/close_position"},{"title":"Order Entry — Add TWAP","href":"/websocket/channels/trade/add_twap"},{"title":"Get User Orders","href":"/websocket/channels/trade/get_user_orders"},{"title":"Get Order","href":"/websocket/channels/trade/get_order"},{"title":"Get User Trades","href":"/websocket/channels/trade/get_user_trades"},{"title":"Subscribe — Balances","href":"/websocket/channels/trade/balance"},{"title":"Subscribe — Positions","href":"/websocket/channels/trade/positions"},{"title":"Get Leverage Levels","href":"/websocket/channels/trade/get_leverage"},{"title":"Get Available Leverage Levels","href":"/websocket/channels/trade/get_available_leverage"},{"title":"Set Leverage","href":"/websocket/channels/trade/set_leverage"},{"title":"Cancel On Disconnect","href":"/websocket/channels/trade/cancel_on_disconnect"},{"title":"Order Entry — Add Stop Order","href":"/websocket/channels/trade/stop_add_order"},{"title":"Order Entry — Cancel Stop Order","href":"/websocket/channels/trade/stop_cancel_order"},{"title":"Order Entry — Modify Stop Order","href":"/websocket/channels/trade/stop_modify_order"}]}]}]},{"tab":"Legal","pages":[{"title":"Legal","href":"/legal/client-agreement"}]}]},{"version":"2026-10-29","pages":[{"title":"2026-10-29","href":"/api-reference/rest/2026-10-29/builder/generate-a-wallet-users-main-account-trading-key"}]}]},{"language":"cn","versions":[{"version":"Latest","default":true,"tabs":[{"tab":"QFEX","pages":[{"title":"QFEX","href":"/cn/qfex/about"}]},{"tab":"API 参考","groups":[{"group":"API 文档","pages":[{"title":"API 简介","href":"/cn/api-reference/introduction"},{"title":"API 版本管理","href":"/cn/api-reference/versioning"},{"title":"账户执行记录","href":"/cn/api-reference/executions"},{"title":"API 密钥","href":"/cn/api-reference/api-keys"},{"title":"钱包身份认证","href":"/cn/api-reference/wallet-authentication"},{"title":"程序化出入金","href":"/cn/api-reference/programmatic-funding"},{"title":"CLI 命令行工具","href":"/cn/api-reference/cli"},{"title":"枚举值","href":"/cn/api-reference/enums"},{"title":"错误处理","href":"/cn/websocket/errors"},{"title":"API 速率限制","href":"/cn/websocket/rate"},{"title":"Changelog","href":"/websocket/changelog"}]},{"group":"Builder Codes","pages":[{"title":"开发者集成指南","href":"/cn/api-reference/builder-integration"},{"title":"Builder 钱包注册","href":"/cn/api-reference/builder-wallet-registration"},{"title":"Builder Codes API","href":"/cn/api-reference/builder-codes"}]},{"group":"REST API","pages":[{"group":"builder","pages":[{"title":"Generate a wallet user's main-account trading key","deprecated":null,"version":null,"openapi":"https://api.qfex.com/openapi.yaml post /builder/web3/api-key","href":"/api-reference/rest/builder/generate-a-wallet-users-main-account-trading-key"},{"title":"Get the wallet message for a builder trading key","deprecated":null,"version":null,"openapi":"https://api.qfex.com/openapi.yaml get /builder/web3/message","href":"/api-reference/rest/builder/get-the-wallet-message-for-a-builder-trading-key"}]},{"group":"market-data","pages":[{"title":"Earnings and Economic Calendar","deprecated":null,"version":null,"openapi":"https://api.qfex.com/openapi.yaml get /calendar","href":"/api-reference/rest/market-data/earnings-and-economic-calendar"},{"title":"Candles","deprecated":null,"version":null,"openapi":"https://api.qfex.com/openapi.yaml get /candles/{symbol}","href":"/api-reference/rest/market-data/candles"},{"title":"DefiLlama Metrics","deprecated":null,"version":null,"openapi":"https://api.qfex.com/openapi.yaml get /defillama/metrics","href":"/api-reference/rest/market-data/defillama-metrics"},{"title":"Funding Historic","deprecated":null,"version":null,"openapi":"https://api.qfex.com/openapi.yaml get /funding/{symbol}","href":"/api-reference/rest/market-data/funding-historic"},{"title":"Reference Market Holidays","deprecated":null,"version":null,"openapi":"https://api.qfex.com/openapi.yaml get /market-holidays","href":"/api-reference/rest/market-data/reference-market-holidays"},{"title":"Contracts","deprecated":null,"version":null,"openapi":"https://api.qfex.com/openapi.yaml get /md/contracts","href":"/api-reference/rest/market-data/contracts"},{"title":"Order Book","deprecated":null,"version":null,"openapi":"https://api.qfex.com/openapi.yaml get /md/orderbook/{ticker_id}","href":"/api-reference/rest/market-data/order-book"},{"title":"Open Interest Historic","deprecated":null,"version":null,"openapi":"https://api.qfex.com/openapi.yaml get /open-interest/{symbol}","href":"/api-reference/rest/market-data/open-interest-historic"},{"title":"Refdata","deprecated":null,"version":null,"openapi":"https://api.qfex.com/openapi.yaml get /refdata","href":"/api-reference/rest/market-data/refdata"},{"title":"Settlement Calendar","deprecated":null,"version":null,"openapi":"https://api.qfex.com/openapi.yaml get /settlement-calendar","href":"/api-reference/rest/market-data/settlement-calendar"},{"title":"Settlement Prices","deprecated":null,"version":null,"openapi":"https://api.qfex.com/openapi.yaml get /settlement-prices","href":"/api-reference/rest/market-data/settlement-prices"},{"title":"Symbol Long Short Historic","deprecated":null,"version":null,"openapi":"https://api.qfex.com/openapi.yaml get /symbol-long-short/{symbol}","href":"/api-reference/rest/market-data/symbol-long-short-historic"},{"title":"Taker Volume Historic","deprecated":null,"version":null,"openapi":"https://api.qfex.com/openapi.yaml get /taker-volume/{symbol}","href":"/api-reference/rest/market-data/taker-volume-historic"},{"title":"Underlier Historic","deprecated":null,"version":null,"openapi":"https://api.qfex.com/openapi.yaml get /underlier/{symbol}","href":"/api-reference/rest/market-data/underlier-historic"}]},{"group":"user","pages":[{"title":"Executions","deprecated":null,"version":null,"openapi":"https://api.qfex.com/openapi.yaml get /executions","href":"/api-reference/rest/user/executions"},{"title":"Stream Historic Orders CSV","deprecated":null,"version":null,"openapi":"https://api.qfex.com/openapi.yaml get /historic-orders-csv","href":"/api-reference/rest/user/stream-historic-orders-csv"},{"title":"Stream Historic TWAPs CSV","deprecated":null,"version":null,"openapi":"https://api.qfex.com/openapi.yaml get /historic-twaps-csv","href":"/api-reference/rest/user/stream-historic-twaps-csv"},{"title":"Redeem Invitation Code","deprecated":null,"version":null,"openapi":"https://api.qfex.com/openapi.yaml post /redeem-invitation-code","href":"/api-reference/rest/user/redeem-invitation-code"},{"title":"Stream Trades CSV","deprecated":null,"version":null,"openapi":"https://api.qfex.com/openapi.yaml get /trades-csv","href":"/api-reference/rest/user/stream-trades-csv"},{"title":"Account Equity","deprecated":null,"version":null,"openapi":"https://api.qfex.com/openapi.yaml get /user/account-equity","href":"/api-reference/rest/user/account-equity"},{"title":"Builder Code Details","deprecated":null,"version":null,"openapi":"https://api.qfex.com/openapi.yaml get /user/builder-code","href":"/api-reference/rest/user/builder-code-details"},{"title":"Create Builder Code","deprecated":null,"version":null,"openapi":"https://api.qfex.com/openapi.yaml post /user/builder-code","href":"/api-reference/rest/user/create-builder-code"},{"title":"User Fees","deprecated":null,"version":null,"openapi":"https://api.qfex.com/openapi.yaml get /user/fees","href":"/api-reference/rest/user/user-fees"},{"title":"User Flat Funding","deprecated":null,"version":null,"openapi":"https://api.qfex.com/openapi.yaml get /user/flat-funding","href":"/api-reference/rest/user/user-flat-funding"},{"title":"Historic Orders","deprecated":null,"version":null,"openapi":"https://api.qfex.com/openapi.yaml get /user/historic-orders","href":"/api-reference/rest/user/historic-orders"},{"title":"Historic User PnL","deprecated":null,"version":null,"openapi":"https://api.qfex.com/openapi.yaml get /user/historic-pnl","href":"/api-reference/rest/user/historic-user-pnl"},{"title":"Historic TWAPs","deprecated":null,"version":null,"openapi":"https://api.qfex.com/openapi.yaml get /user/historic-twaps","href":"/api-reference/rest/user/historic-twaps"},{"title":"Reconcile Invitation Codes (Legacy Path)","deprecated":null,"version":null,"openapi":"https://api.qfex.com/openapi.yaml post /user/invitation-codes/job","href":"/api-reference/rest/user/reconcile-invitation-codes-legacy-path"},{"title":"Set User Leverage","deprecated":null,"version":null,"openapi":"https://api.qfex.com/openapi.yaml post /user/leverage","href":"/api-reference/rest/user/set-user-leverage"},{"title":"User Positions","description":"Return current positions for the authenticated user.","deprecated":null,"version":null,"openapi":"https://api.qfex.com/openapi.yaml get /user/positions","href":"/api-reference/rest/user/user-positions"},{"title":"User Referral Rewards","deprecated":null,"version":null,"openapi":"https://api.qfex.com/openapi.yaml get /user/referral-rewards","href":"/api-reference/rest/user/user-referral-rewards"},{"title":"User Referral Notional Volume","description":"Return rolling 14-day and lifetime notional volume for the authenticated user and their direct referrals.","deprecated":null,"version":null,"openapi":"https://api.qfex.com/openapi.yaml get /user/referrals/notional-volume","href":"/api-reference/rest/user/user-referral-notional-volume"},{"title":"List Subaccounts","deprecated":null,"version":null,"openapi":"https://api.qfex.com/openapi.yaml get /user/subaccounts","href":"/api-reference/rest/user/list-subaccounts"},{"title":"Create Subaccount","deprecated":null,"version":null,"openapi":"https://api.qfex.com/openapi.yaml post /user/subaccounts","href":"/api-reference/rest/user/create-subaccount"},{"title":"List Account Balances","deprecated":null,"version":null,"openapi":"https://api.qfex.com/openapi.yaml get /user/subaccounts/balance","href":"/api-reference/rest/user/list-account-balances"},{"title":"List Account Equities","deprecated":null,"version":null,"openapi":"https://api.qfex.com/openapi.yaml get /user/subaccounts/equity","href":"/api-reference/rest/user/list-account-equities"},{"title":"User Trades","deprecated":null,"version":null,"openapi":"https://api.qfex.com/openapi.yaml get /user/trade","href":"/api-reference/rest/user/user-trades"},{"title":"Transfer Balance","deprecated":null,"version":null,"openapi":"https://api.qfex.com/openapi.yaml post /user/transfer","href":"/api-reference/rest/user/transfer-balance"},{"title":"User Volume","deprecated":null,"version":null,"openapi":"https://api.qfex.com/openapi.yaml get /user/volume","href":"/api-reference/rest/user/user-volume"}]},{"group":"pnl","pages":[{"title":"Hourly PnL (approx. first position per hour)","deprecated":null,"version":null,"openapi":"https://api.qfex.com/openapi.yaml get /pnl","href":"/api-reference/rest/pnl/hourly-pnl-approx-first-position-per-hour"}]},{"group":"public","pages":[{"title":"Public Leaderboard","deprecated":null,"version":null,"openapi":"https://api.qfex.com/openapi.yaml get /public/leaderboard","href":"/api-reference/rest/public/public-leaderboard"}]}]},{"group":"出入金 API","pages":[{"group":"出入金","pages":[{"title":"获取加密资产充值地址","deprecated":null,"version":null,"sidebarTitle":"Get a crypto deposit address","openapi":"/cn/api-reference/funding-openapi.yaml get /address","href":"/cn/api-reference/funding/funding/get-a-crypto-deposit-address"},{"title":"列出已登记的加密资产提现地址","deprecated":null,"version":null,"sidebarTitle":"List registered crypto withdrawal addresses","openapi":"/cn/api-reference/funding-openapi.yaml get /withdrawal-addresses","href":"/cn/api-reference/funding/funding/list-registered-crypto-withdrawal-addresses"},{"title":"申请向已登记地址提取加密资产","deprecated":null,"version":null,"sidebarTitle":"Request a crypto withdrawal to a registered address","openapi":"/cn/api-reference/funding-openapi.yaml post /withdraw","href":"/cn/api-reference/funding/funding/request-a-crypto-withdrawal-to-a-registered-address"}]}]},{"group":"WebSocket","pages":[{"title":"WebSocket 概览","href":"/cn/websocket/main"},{"title":"交易 Playground","asyncapi":"websocket/trade.yaml qfex","href":"/cn/websocket/trade"},{"title":"行情数据 Playground","asyncapi":"websocket/mds.yaml qfex","href":"/cn/websocket/mds"},{"group":"行情数据","pages":[{"title":"参考数据","href":"/cn/websocket/channels/mds/refdata"},{"title":"定时推送订单簿","href":"/cn/websocket/channels/mds/orderbook"},{"title":"公开成交","href":"/cn/websocket/channels/mds/trades"},{"title":"定时推送最优买卖价","href":"/cn/websocket/channels/mds/bbo"},{"title":"标的资产价格","href":"/cn/websocket/channels/mds/underlier"},{"title":"资金费率","href":"/cn/websocket/channels/mds/funding_rate"},{"title":"标记价格","href":"/cn/websocket/channels/mds/mark_price"},{"title":"未平仓量","href":"/cn/websocket/channels/mds/open_interest"},{"title":"价格上下限","href":"/cn/websocket/channels/mds/minmax_price"},{"title":"市场统计","href":"/cn/websocket/channels/mds/market_stats"}]},{"group":"交易","pages":[{"title":"身份认证","href":"/cn/websocket/channels/trade/authenticate"},{"title":"订阅订单响应","href":"/cn/websocket/channels/trade/order"},{"title":"订阅成交回报","href":"/cn/websocket/channels/trade/fills"},{"title":"订单提交——新增订单","href":"/cn/websocket/channels/trade/add_order"},{"title":"订单提交——取消订单","href":"/cn/websocket/channels/trade/cancel_order"},{"title":"订单提交——修改订单","href":"/cn/websocket/channels/trade/modify_order"},{"title":"取消全部订单","href":"/cn/websocket/channels/trade/cancel_all_orders"},{"title":"订单提交——平仓","href":"/cn/websocket/channels/trade/close_position"},{"title":"订单提交——TWAP 分笔下单","href":"/cn/websocket/channels/trade/add_twap"},{"title":"获取用户订单","href":"/cn/websocket/channels/trade/get_user_orders"},{"title":"获取单笔订单","href":"/cn/websocket/channels/trade/get_order"},{"title":"获取用户成交","href":"/cn/websocket/channels/trade/get_user_trades"},{"title":"订阅余额","href":"/cn/websocket/channels/trade/balance"},{"title":"订阅持仓","href":"/cn/websocket/channels/trade/positions"},{"title":"获取当前杠杆等级","href":"/cn/websocket/channels/trade/get_leverage"},{"title":"获取可用杠杆等级","href":"/cn/websocket/channels/trade/get_available_leverage"},{"title":"设置杠杆","href":"/cn/websocket/channels/trade/set_leverage"},{"title":"断线撤单","href":"/cn/websocket/channels/trade/cancel_on_disconnect"},{"title":"订单提交——新增触发单","href":"/cn/websocket/channels/trade/stop_add_order"},{"title":"订单提交——取消触发单","href":"/cn/websocket/channels/trade/stop_cancel_order"},{"title":"订单提交——修改触发单","href":"/cn/websocket/channels/trade/stop_modify_order"}]}]}]},{"tab":"法律文件","pages":[{"title":"法律文件","href":"/cn/legal/client-agreement"}]}]},{"version":"2026-10-29","pages":[{"title":"2026-10-29","href":"/api-reference/rest/2026-10-29/builder/generate-a-wallet-users-main-account-trading-key"}]}]}]},"basePath":"","title":"User Referral Rewards - QFEX API Documentation","buildId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","deploymentId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CybtLBIt.js","utils-BMLj2fvV.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-B6In562Y.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dr8Mfhp9.js","snippetPresets-2rmQvMVl.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-WMqJYdZj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CJ-MlPHu.js","shallow-dY3TMRCk.js","getApiPlaygroundDisplay-v-1B2bKm.js","CodeSnippet-BDhiTB7U.js","CodeSnippets-D9hnzQcS.js","Page-C4GwDT3_.js","getPastedJson-Th2V45jI.js","icon-BQXch1W9.js","MethodPill-BCqUneP3.js","DuplicateIcon-Q_-bhurZ.js","createIcon-DUjLHRqp.js","DynamicMarkdown-B-f2cqXQ.js","SectionHeading-Da5NsV4v.js","axios-vUo_bRtp.js","Markdown-D13FWkIM.js","clsx-D3Isdib3.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-C-XZBk9h.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink--qIqmmVG.js"]}