Read the caller’s accrued BuilderCodes reward-bucket balances.
The bucket is derived from the authenticated wallet under the reserved
BuilderCodes application. Current enrollment is not required, so a former
payout wallet can still inspect and claim what it accrued. Returns an empty
list when no payout bucket or non-zero balance exists.
GET
/
api
/
v1
/
buildercodes
/
rewards
/
balance
Get your accrued BuilderCodes balance
curl --request GET \ --url https://apimonaco.xyz/api/v1/buildercodes/rewards/balance \ --header 'X-Monaco-Signature: <api-key>'
Ed25519 session-key request signing. Every authenticated request carries three headers: X-Monaco-PublicKey (64-char lowercase-hex session public key), X-Monaco-Timestamp (Unix milliseconds, within 30s of server time), and X-Monaco-Signature (hex ed25519 signature). The signature is over METHOD\npath?query\ntimestamp_ms\nSHA256_hex(body), where the body hash is the SHA-256 of the empty byte string when there is no body. Obtain the session keypair from POST /api/v1/auth/challenge followed by POST /api/v1/auth/verify.
One entry per reward token with a non-zero available balance.
Show child attributes
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Monaco Protocol SDK v1.1.0","description":"High-performance spot and perpetuals trading infrastructure built on Sei. Complete documentation for builders integrating Monaco Protocol into their applications.","colors":{"primary":"#233329","light":"#3A5544","dark":"#1A2620"},"logo":{"light":"https://mintcdn.com/monaco/Puhxf4Whf6wQMalZ/logo.png?fit=max\u0026auto=format\u0026n=Puhxf4Whf6wQMalZ\u0026q=85\u0026s=6b0d46b12348c8cb28126629f97faae0","dark":"https://mintcdn.com/monaco/Puhxf4Whf6wQMalZ/logo-white.png?fit=max\u0026auto=format\u0026n=Puhxf4Whf6wQMalZ\u0026q=85\u0026s=2e00e628ed93f72b88edb25eb8d8725e"},"favicon":"https://mintcdn.com/monaco/Puhxf4Whf6wQMalZ/logoMark.png?fit=max\u0026auto=format\u0026n=Puhxf4Whf6wQMalZ\u0026q=85\u0026s=7cfd00a92f26b8cb3855b908c31629b8","api":{"playground":{"proxy":false},"examples":{"prefill":true}},"contextual":{"options":["copy","chatgpt","claude"],"display":"header"},"styling":{"latex":true},"navigation":{"global":{"anchors":[{"anchor":"Website","icon":"globe","href":"https://0xmonaco.com"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"monaco","hasAudioNarration":false,"actualSubdomain":"monaco","customDomains":["docs.0xmonaco.com"],"gitSource":{"type":"github","owner":"monaco-research","repo":"monaco-core","deployBranch":"develop","contentDirectory":"docs/src","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae2a0eb510bd1d8299667a0","collectionId":"b9638fec-cd49-4f11-8262-eebf021c05e9","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae2a0eb510bd1d8299667a0"},"feedback":{"issues":false,"edits":false,"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae2a20108c681346c1daf60","clientVersion":"0.0.4006","searchFilterCounts":[{"language":"default","tag":"APIs","count":173},{"language":"default","tag":"REST API","count":151},{"language":"default","tag":"Resources","count":109},{"language":"default","tag":"Releases","count":105},{"language":"default","tag":"Libraries","count":40},{"language":"default","tag":"gRPC API","count":20},{"language":"default","tag":"Protobuf Reference","count":20},{"language":"default","tag":"Build","count":19},{"language":"default","tag":"Margin Accounts","count":19},{"language":"default","tag":"React SDK","count":18}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","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":"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":"pause-universal-search-reconcile","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":"per-site-search-delta","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":"editor-private-page-search","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":"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":"byok-sep-25","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":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","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":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/buildercoderewardsservice/get-your-accrued-buildercodes-balance","slug":"/api-reference/buildercoderewardsservice/get-your-accrued-buildercodes-balance","pageMetadata":{"title":"Get your accrued BuilderCodes balance","description":"Read the caller's accrued BuilderCodes reward-bucket balances.\n\n The bucket is derived from the authenticated wallet under the reserved\n BuilderCodes application. Current enrollment is not required, so a former\n payout wallet can still inspect and claim what it accrued. Returns an empty\n list when no payout bucket or non-zero balance exists.","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/buildercodes/rewards/balance","href":"/api-reference/buildercoderewardsservice/get-your-accrued-buildercodes-balance","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Read the caller’s accrued BuilderCodes reward-bucket balances.\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"The bucket is derived from the authenticated wallet under the reserved\\nBuilderCodes application. Current enrollment is not required, so a former\\npayout wallet can still inspect and claim what it accrued. Returns an empty\\nlist when no payout bucket or non-zero balance exists.\"\n })]\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":"Get your accrued BuilderCodes balance","description":"Read the caller's accrued BuilderCodes reward-bucket balances.\n\n The bucket is derived from the authenticated wallet under the reserved\n BuilderCodes application. Current enrollment is not required, so a former\n payout wallet can still inspect and claim what it accrued. Returns an empty\n list when no payout bucket or non-zero balance exists.","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/buildercodes/rewards/balance","href":"/api-reference/buildercoderewardsservice/get-your-accrued-buildercodes-balance","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["BuildercodeRewardsService","BuilderCodes"],"summary":"Get your accrued BuilderCodes balance","description":"Read the caller's accrued BuilderCodes reward-bucket balances.\n\n The bucket is derived from the authenticated wallet under the reserved\n BuilderCodes application. Current enrollment is not required, so a former\n payout wallet can still inspect and claim what it accrued. Returns an empty\n list when no payout bucket or non-zero balance exists.","operationId":"get_buildercode_rewards_balance","responses":{"200":"7a4178d2-3457-49a8-90c6-57b31c64d3e6","401":"453c24ed-4167-43ee-8657-06c017da999a","403":"20d150e6-929d-4b04-91ff-afb49a5f5fcb","500":"fbaa2fec-06c8-4558-9934-96c48a64cc3e"},"security":["9b681f8f-2e2f-4b2d-beba-8acbc10fbc6a","7ed20948-9b53-405f-b0ec-2b39b87e9421"],"method":"get","type":"path","servers":["9e7b17d3-cad7-4c10-a32e-7ebd3a3aed01"],"path":"/api/v1/buildercodes/rewards/balance","baseUrlOptions":["https://apimonaco.xyz"],"title":"Get your accrued BuilderCodes balance","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[],"disableProxy":true},"dependencies":{"parameters":{},"responses":{"7a4178d2-3457-49a8-90c6-57b31c64d3e6":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"balances":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"token":{"oneOf":[{"example":"0x0000000000000000000000000000000000000002","type":"string","description":"Reward token contract address.","uniqueKey":"balances.oneOf.0.items.[INDEX].token.oneOf.0","typeLabel":"string"},{"example":"0x0000000000000000000000000000000000000002","type":"null","description":"Reward token contract address.","uniqueKey":"balances.oneOf.0.items.[INDEX].token.oneOf.1","typeLabel":"null"}],"uniqueKey":"balances.oneOf.0.items.[INDEX].token","typeLabel":"string | null"},"available":{"oneOf":[{"example":"1200000","type":"string","description":"Available BuilderCodes reward balance in RAW atomic units.","uniqueKey":"balances.oneOf.0.items.[INDEX].available.oneOf.0","typeLabel":"string"},{"example":"1200000","type":"null","description":"Available BuilderCodes reward balance in RAW atomic units.","uniqueKey":"balances.oneOf.0.items.[INDEX].available.oneOf.1","typeLabel":"null"}],"uniqueKey":"balances.oneOf.0.items.[INDEX].available","typeLabel":"string | null"}},"uniqueKey":"balances.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"One entry per reward token with a non-zero available balance.","uniqueKey":"balances.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"token":{"oneOf":[{"example":"0x0000000000000000000000000000000000000002","type":"string","description":"Reward token contract address."},{"example":"0x0000000000000000000000000000000000000002","type":"null","description":"Reward token contract address."}]},"available":{"oneOf":[{"example":"1200000","type":"string","description":"Available BuilderCodes reward balance in RAW atomic units."},{"example":"1200000","type":"null","description":"Available BuilderCodes reward balance in RAW atomic units."}]}}},"description":"One entry per reward token with a non-zero available balance.","uniqueKey":"balances.oneOf.1","typeLabel":"null"}],"uniqueKey":"balances","typeLabel":"object[] | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"balances":[{"token":"0x0000000000000000000000000000000000000002","available":"1200000"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"453c24ed-4167-43ee-8657-06c017da999a":{"description":"Authentication required","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"20d150e6-929d-4b04-91ff-afb49a5f5fcb":{"description":"Refused: the caller is delegated (gRPC: PERMISSION_DENIED)","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"fbaa2fec-06c8-4558-9934-96c48a64cc3e":{"description":"Internal server error","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"9b681f8f-2e2f-4b2d-beba-8acbc10fbc6a":{"monacoSignature":{"type":"apiKey","description":"Ed25519 session-key request signing. Every authenticated request carries three headers: `X-Monaco-PublicKey` (64-char lowercase-hex session public key), `X-Monaco-Timestamp` (Unix milliseconds, within 30s of server time), and `X-Monaco-Signature` (hex ed25519 signature). The signature is over `METHOD\\npath?query\\ntimestamp_ms\\nSHA256_hex(body)`, where the body hash is the SHA-256 of the empty byte string when there is no body. Obtain the session keypair from `POST /api/v1/auth/challenge` followed by `POST /api/v1/auth/verify`.","name":"X-Monaco-Signature","in":"header","scopes":[],"schemeName":"monacoSignature"}},"7ed20948-9b53-405f-b0ec-2b39b87e9421":{"monacoHttpSignature":{"type":"apiKey","description":"RFC 9421 Ed25519 session-key request signatures. Send Signature-Input, Signature, and Content-Digest together; never combine them with X-Monaco-* credentials. The monaco signature covers @method, @path, @query, and content-digest in that order, with created (Unix seconds within 30s of server time), keyid (registered lowercase-hex session public key), and alg=ed25519 parameters. Content-Digest uses RFC 9530 sha-256 over the exact body bytes, including the empty body. Query coverage retains ordering and percent encoding. Timestamp freshness does not reject repeated identical requests; use endpoint idempotency where supported. Existing legacy signing remains supported during server-first migration; SDK RFC 9421 signing is opt-in. See https://docs.0xmonaco.com/reference/http-message-signatures for the complete profile and trust model.","name":"Signature","in":"header","scopes":[],"schemeName":"monacoHttpSignature"}}},"servers":{"9e7b17d3-cad7-4c10-a32e-7ebd3a3aed01":{"url":"https://apimonaco.xyz","description":"Production (Sei mainnet)"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","description":"Ed25519 session-key request signing. Every authenticated request carries three headers: `X-Monaco-PublicKey` (64-char lowercase-hex session public key), `X-Monaco-Timestamp` (Unix milliseconds, within 30s of server time), and `X-Monaco-Signature` (hex ed25519 signature). The signature is over `METHOD\\npath?query\\ntimestamp_ms\\nSHA256_hex(body)`, where the body hash is the SHA-256 of the empty byte string when there is no body. Obtain the session keypair from `POST /api/v1/auth/challenge` followed by `POST /api/v1/auth/verify`.","name":"X-Monaco-Signature","in":"header","scopes":[],"schemeName":"monacoSignature"},"schema":{"title":"X-Monaco-Signature","type":"string","description":"Ed25519 session-key request signing. Every authenticated request carries three headers: `X-Monaco-PublicKey` (64-char lowercase-hex session public key), `X-Monaco-Timestamp` (Unix milliseconds, within 30s of server time), and `X-Monaco-Signature` (hex ed25519 signature). The signature is over `METHOD\\npath?query\\ntimestamp_ms\\nSHA256_hex(body)`, where the body hash is the SHA-256 of the empty byte string when there is no body. Obtain the session keypair from `POST /api/v1/auth/challenge` followed by `POST /api/v1/auth/verify`.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"monacoSignature","name":"X-Monaco-Signature"}],"title":"monacoSignature"},{"schemes":[{"scheme":{"type":"apiKey","description":"RFC 9421 Ed25519 session-key request signatures. Send Signature-Input, Signature, and Content-Digest together; never combine them with X-Monaco-* credentials. The monaco signature covers @method, @path, @query, and content-digest in that order, with created (Unix seconds within 30s of server time), keyid (registered lowercase-hex session public key), and alg=ed25519 parameters. Content-Digest uses RFC 9530 sha-256 over the exact body bytes, including the empty body. Query coverage retains ordering and percent encoding. Timestamp freshness does not reject repeated identical requests; use endpoint idempotency where supported. Existing legacy signing remains supported during server-first migration; SDK RFC 9421 signing is opt-in. See https://docs.0xmonaco.com/reference/http-message-signatures for the complete profile and trust model.","name":"Signature","in":"header","scopes":[],"schemeName":"monacoHttpSignature"},"schema":{"title":"Signature","type":"string","description":"RFC 9421 Ed25519 session-key request signatures. Send Signature-Input, Signature, and Content-Digest together; never combine them with X-Monaco-* credentials. The monaco signature covers @method, @path, @query, and content-digest in that order, with created (Unix seconds within 30s of server time), keyid (registered lowercase-hex session public key), and alg=ed25519 parameters. Content-Digest uses RFC 9530 sha-256 over the exact body bytes, including the empty body. Query coverage retains ordering and percent encoding. Timestamp freshness does not reject repeated identical requests; use endpoint idempotency where supported. Existing legacy signing remains supported during server-first migration; SDK RFC 9421 signing is opt-in. See https://docs.0xmonaco.com/reference/http-message-signatures for the complete profile and trust model.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"monacoHttpSignature","name":"Signature"}],"title":"monacoHttpSignature"}]},"originalFileLocation":"proto-openapi/api/openapi.yaml"},"subdomain":"monaco","siteName":"Monaco Protocol SDK v1.1.0","title":"Get your accrued BuilderCodes balance - Monaco Protocol SDK v1.1.0","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-29T01:27:17.286Z","originalFileLocation":"api-reference/buildercoderewardsservice/get-your-accrued-buildercodes-balance.mdx"},"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=\"Read the caller\u0026#x27;s accrued BuilderCodes reward-bucket balances. The bucket is derived from the authenticated wallet under the reserved BuilderCodes application. Current enrollment is not required, so a former payout wallet can still inspect and claim what it accrued. Returns an empty list when no payout bucket or non-zero balance exists.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Monaco Protocol SDK v1.1.0\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/monaco/4wZNikyT1wBLArhB/_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/monaco/4wZNikyT1wBLArhB/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/monaco/4wZNikyT1wBLArhB/_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/monaco/4wZNikyT1wBLArhB/_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/monaco/4wZNikyT1wBLArhB/_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/monaco/4wZNikyT1wBLArhB/_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/monaco/4wZNikyT1wBLArhB/_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/monaco/4wZNikyT1wBLArhB/_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/monaco/4wZNikyT1wBLArhB/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get your accrued BuilderCodes balance - Monaco Protocol SDK v1.1.0\">\u003cmeta data-mint-head property=\"og:description\" content=\"Read the caller\u0026#x27;s accrued BuilderCodes reward-bucket balances. The bucket is derived from the authenticated wallet under the reserved BuilderCodes application. Current enrollment is not required, so a former payout wallet can still inspect and claim what it accrued. Returns an empty list when no payout bucket or non-zero balance exists.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Monaco Protocol SDK v1.1.0\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.0xmonaco.com/api-reference/buildercoderewardsservice/get-your-accrued-buildercodes-balance\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://monaco.mintlify.app/_mintlify/api/og/v2?division=BuilderCodes\u0026amp;title=Get+your+accrued+BuilderCodes+balance\u0026amp;description=Read+the+caller%27s+accrued+BuilderCodes+reward-bucket+balances.%0A%0A+The+bucket+is+derived+from+the+authenticated+wallet+under+the+reserved%0A+BuilderCodes+applicatio\u0026amp;theme=c7a151fbe45787a81853621c\u0026amp;signature=dbe99760d126e735636ef26249bf30e6cd2f27f5cf756653a1e9902a50cd8818\">\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=\"Get your accrued BuilderCodes balance - Monaco Protocol SDK v1.1.0\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Read the caller\u0026#x27;s accrued BuilderCodes reward-bucket balances. The bucket is derived from the authenticated wallet under the reserved BuilderCodes application. Current enrollment is not required, so a former payout wallet can still inspect and claim what it accrued. Returns an empty list when no payout bucket or non-zero balance exists.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://monaco.mintlify.app/_mintlify/api/og/v2?division=BuilderCodes\u0026amp;title=Get+your+accrued+BuilderCodes+balance\u0026amp;description=Read+the+caller%27s+accrued+BuilderCodes+reward-bucket+balances.%0A%0A+The+bucket+is+derived+from+the+authenticated+wallet+under+the+reserved%0A+BuilderCodes+applicatio\u0026amp;theme=c7a151fbe45787a81853621c\u0026amp;signature=dbe99760d126e735636ef26249bf30e6cd2f27f5cf756653a1e9902a50cd8818\">\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/monaco/4wZNikyT1wBLArhB/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Monaco Protocol SDK v1.1.0\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#233329\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.0xmonaco.com/api-reference/buildercoderewardsservice/get-your-accrued-buildercodes-balance\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/buildercoderewardsservice/get-your-accrued-buildercodes-balance.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.0xmonaco.com/#organization\",\"name\":\"Monaco Protocol SDK v1.1.0\",\"url\":\"https://docs.0xmonaco.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/monaco/Puhxf4Whf6wQMalZ/logo.png?fit=max\u0026auto=format\u0026n=Puhxf4Whf6wQMalZ\u0026q=85\u0026s=6b0d46b12348c8cb28126629f97faae0\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.0xmonaco.com#website\",\"name\":\"Monaco Protocol SDK v1.1.0\",\"url\":\"https://docs.0xmonaco.com\",\"publisher\":{\"@id\":\"https://docs.0xmonaco.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.0xmonaco.com/api-reference/buildercoderewardsservice/get-your-accrued-buildercodes-balance#webpage\",\"url\":\"https://docs.0xmonaco.com/api-reference/buildercoderewardsservice/get-your-accrued-buildercodes-balance\",\"name\":\"Get your accrued BuilderCodes balance\",\"description\":\"Read the caller's accrued BuilderCodes reward-bucket balances. The bucket is derived from the authenticated wallet under the reserved BuilderCodes application. Current enrollment is not required, so a former payout wallet can still inspect and claim what it accrued. Returns an empty list when no payout bucket or non-zero balance exists.\",\"dateModified\":\"2026-10-29T01:27:17.286Z\",\"isPartOf\":{\"@id\":\"https://docs.0xmonaco.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.0xmonaco.com/api-reference/buildercoderewardsservice/get-your-accrued-buildercodes-balance#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.0xmonaco.com/api-reference/buildercoderewardsservice/get-your-accrued-buildercodes-balance#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"APIs\",\"item\":\"https://docs.0xmonaco.com/api-reference/healthservice/health-check\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"REST API\",\"item\":\"https://docs.0xmonaco.com/api-reference\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"BuilderCodes\",\"item\":\"https://docs.0xmonaco.com/api-reference/buildercoderewardsservice/get-your-buildercodes-program-configuration\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Get your accrued BuilderCodes balance\",\"item\":\"https://docs.0xmonaco.com/api-reference/buildercoderewardsservice/get-your-accrued-buildercodes-balance\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.0xmonaco.com/api-reference/buildercoderewardsservice/get-your-accrued-buildercodes-balance#apireference\",\"headline\":\"Get your accrued BuilderCodes balance\",\"name\":\"Get your accrued BuilderCodes balance\",\"description\":\"Read the caller's accrued BuilderCodes reward-bucket balances. The bucket is derived from the authenticated wallet under the reserved BuilderCodes application. Current enrollment is not required, so a former payout wallet can still inspect and claim what it accrued. Returns an empty list when no payout bucket or non-zero balance exists.\",\"url\":\"https://docs.0xmonaco.com/api-reference/buildercoderewardsservice/get-your-accrued-buildercodes-balance\",\"mainEntityOfPage\":{\"@id\":\"https://docs.0xmonaco.com/api-reference/buildercoderewardsservice/get-your-accrued-buildercodes-balance#webpage\"},\"dateModified\":\"2026-10-29T01:27:17.286Z\",\"publisher\":{\"@id\":\"https://docs.0xmonaco.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.0xmonaco.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Monaco Protocol SDK v1.1.0\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Monaco Protocol SDK v1.1.0","nav":{"global":{"anchors":[{"anchor":"Website","icon":"globe","href":"https://0xmonaco.com"}]},"pages":[{"title":"Introduction","href":"/introduction"},{"title":"Markets","href":"/markets"},{"title":"AI \u0026 Agents","href":"/build-with-ai"},{"group":"Learn","pages":[{"title":"Accounts","href":"/accounts"},{"title":"Sub-Accounts","href":"/sub-accounts"},{"title":"Orderbook","href":"/trading-mechanics/spot"},{"title":"Margin","href":"/trading-mechanics/perps"},{"title":"Funding Rates","href":"/trading-mechanics/funding-rates"},{"title":"Liquidations","href":"/trading-mechanics/liquidations"},{"title":"Auto-Deleveraging","href":"/trading-mechanics/auto-deleveraging"},{"title":"TWAP Orders","href":"/trading-mechanics/twap-orders"},{"title":"Self-Trade Prevention","href":"/trading-mechanics/self-trade-prevention"},{"title":"Fees","href":"/fees"},{"title":"Earn","href":"/earn"}]},{"group":"Build","pages":[{"title":"Quickstart","href":"/quickstart"},{"title":"Testnet","href":"/testnet"},{"title":"Wallets \u0026 Auth","href":"/developers/accounts/wallets"},{"title":"Account Balances","href":"/developers/account-balances"},{"title":"Vault Deposits \u0026 Withdrawals","href":"/developers/vault"},{"title":"Perps Collateral","href":"/developers/perps-collateral"},{"title":"Markets","href":"/developers/markets"},{"title":"Orderbooks \u0026 Trades","href":"/developers/orderbooks-trades"},{"title":"Order Management","href":"/developers/trade"},{"title":"Rate Limits","href":"/developers/rate-limits"},{"title":"Positions","href":"/developers/positions"},{"title":"Market-Maker Runbook","href":"/developers/market-maker-runbook"},{"title":"PrivateLink","href":"/developers/privatelink"},{"title":"Delegated Agents","href":"/developers/delegated-agents"},{"title":"Invite Codes","href":"/developers/invite-codes"},{"title":"TraderCodes","href":"/developers/tradercodes"},{"title":"BuilderCodes","href":"/developers/buildercodes"},{"title":"BuilderCodes with a Safe","href":"/developers/buildercodes-safe"},{"title":"Copy Trading","href":"/developers/copy-trading"}]},{"group":"Libraries","pages":[{"title":"MCP Server","href":"/sdk/mcp-server"},{"group":"TypeScript SDK","root":{"title":"TypeScript SDK","href":"/sdk/typescript/intro"},"expanded":false,"pages":[{"title":"Applications","href":"/sdk/typescript/applications"},{"title":"Authentication","href":"/sdk/typescript/auth"},{"title":"Error Handling","href":"/sdk/typescript/error-handling"},{"title":"Market Data","href":"/sdk/typescript/market"},{"title":"Market Pulse","href":"/sdk/typescript/pulse"},{"title":"Region Status","href":"/sdk/typescript/compliance"},{"title":"Profile","href":"/sdk/typescript/profile"},{"title":"Portfolio Analytics","href":"/sdk/typescript/portfolio"},{"title":"Trading","href":"/sdk/typescript/trades"},{"title":"Margin Accounts","href":"/sdk/typescript/margin-accounts"},{"title":"Positions","href":"/sdk/typescript/positions"},{"title":"Delegated Agents","href":"/sdk/typescript/delegated-agents"},{"title":"Vault","href":"/sdk/typescript/vault"},{"title":"TraderCodes","href":"/sdk/typescript/tradercodes"},{"title":"BuilderCodes","href":"/sdk/typescript/buildercodes"},{"title":"Copy Trading","href":"/sdk/typescript/copy-trading"},{"title":"Managed Markets","href":"/sdk/typescript/managed-markets"},{"title":"WebSockets","href":"/sdk/typescript/websockets"}]},{"group":"React SDK","root":{"title":"React SDK","href":"/sdk/react/intro"},"expanded":false,"pages":[{"title":"useAuth","href":"/sdk/react/hooks/use-auth"},{"title":"useCopyTrading","href":"/sdk/react/hooks/use-copy-trading"},{"title":"useFees","href":"/sdk/react/hooks/use-fees"},{"title":"useInstruments","href":"/sdk/react/hooks/use-instruments"},{"title":"useMarket","href":"/sdk/react/hooks/use-market"},{"title":"useMonacoSDK","href":"/sdk/react/hooks/use-monaco"},{"title":"useOHLCV","href":"/sdk/react/hooks/use-ohlcv"},{"title":"useOrderbook","href":"/sdk/react/hooks/use-orderbook"},{"title":"TraderCodes hooks","href":"/sdk/react/hooks/use-tradercodes"},{"title":"useProfile","href":"/sdk/react/hooks/use-profile"},{"title":"usePositions","href":"/sdk/react/hooks/use-positions"},{"title":"useTokenLifecycle","href":"/sdk/react/hooks/use-token-lifecycle"},{"title":"useTrade","href":"/sdk/react/hooks/use-trade"},{"title":"useTradeFeed","href":"/sdk/react/hooks/use-trade-feed"},{"title":"useUserBalances","href":"/sdk/react/hooks/use-user-balances"},{"title":"useUserMovements","href":"/sdk/react/hooks/use-user-movements"},{"title":"useUserOrders","href":"/sdk/react/hooks/use-user-orders"},{"title":"useVault","href":"/sdk/react/hooks/use-vault"}]},{"group":"Rust SDK","root":{"title":"Rust SDK","href":"/sdk/rust-and-bsr"},"expanded":false,"pages":[{"title":"Rust REST SDK","href":"/sdk/rust-rest"},{"title":"Rust gRPC SDK","href":"/sdk/rust-grpc"}]},{"title":"Python, Go, C++ \u0026 More","href":"/sdk/python-quickstart"}]},{"group":"APIs","pages":[{"group":"REST API","root":{"title":"REST API","href":"/api-reference"},"expanded":false,"pages":[{"group":"Health","pages":[{"title":"Health check","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /health","href":"/api-reference/healthservice/health-check"}]},{"group":"Auth","pages":[{"title":"Create authentication challenge","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/auth/challenge","href":"/api-reference/authservice/create-authentication-challenge"},{"title":"Verify signature and authenticate","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/auth/verify","href":"/api-reference/authservice/verify-signature-and-authenticate"},{"title":"Mint one Mainnet invite code","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/invite-codes/requests","href":"/api-reference/authservice/mint-one-mainnet-invite-code"},{"title":"List my Mainnet invite codes","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/invite-codes","href":"/api-reference/authservice/list-my-mainnet-invite-codes"},{"title":"Refresh session expiry","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/auth/refresh","href":"/api-reference/authservice/refresh-session-expiry"},{"title":"Revoke current session","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/auth/revoke","href":"/api-reference/authservice/revoke-current-session"}]},{"group":"Accounts","pages":[{"title":"Get user profile","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/accounts/me","href":"/api-reference/accountsservice/get-user-profile"},{"title":"Get user balances","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/accounts/balances","href":"/api-reference/accountsservice/get-user-balances"},{"title":"Get user balance by asset","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/accounts/balances/{assetId}","href":"/api-reference/accountsservice/get-user-balance-by-asset"},{"title":"Get user movements","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/accounts/movements","href":"/api-reference/accountsservice/get-user-movements"},{"title":"Get user trade history","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/accounts/trades","href":"/api-reference/accountsservice/get-user-trade-history"},{"title":"Get portfolio stats","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/accounts/me/portfolio","href":"/api-reference/accountsservice/get-portfolio-stats"},{"title":"Get portfolio chart time series","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/accounts/me/portfolio/chart","href":"/api-reference/accountsservice/get-portfolio-chart-time-series"},{"title":"Get portfolio summary","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/accounts/me/portfolio/summary","href":"/api-reference/accountsservice/get-portfolio-summary"},{"title":"Get portfolio performance","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/accounts/me/portfolio/performance","href":"/api-reference/accountsservice/get-portfolio-performance"},{"title":"Get portfolio realized PnL","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/accounts/me/portfolio/realized-pnl","href":"/api-reference/accountsservice/get-portfolio-realized-pnl"},{"title":"Get portfolio assets","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/accounts/me/portfolio/assets","href":"/api-reference/accountsservice/get-portfolio-assets"},{"title":"Get portfolio margin","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/accounts/me/portfolio/margin","href":"/api-reference/accountsservice/get-portfolio-margin"},{"title":"List funding payments","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/accounts/funding-payments","href":"/api-reference/accountsservice/list-funding-payments"},{"title":"List sub-accounts with balances","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/accounts/sub-accounts","href":"/api-reference/accountsservice/list-sub-accounts-with-balances"},{"title":"Get your self-trade-prevention default","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/accounts/self-trade-prevention","href":"/api-reference/accountsservice/get-your-self-trade-prevention-default"},{"title":"Set your self-trade-prevention default","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml put /api/v1/accounts/self-trade-prevention","href":"/api-reference/accountsservice/set-your-self-trade-prevention-default"}]},{"group":"Account Limits","pages":[{"title":"Create sub-account limit","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/accounts/sub-accounts/limits","href":"/api-reference/accountsservice/create-sub-account-limit"},{"title":"Get sub-account limits","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/accounts/sub-accounts/{subAccountId}/limits","href":"/api-reference/accountsservice/get-sub-account-limits"},{"title":"Update sub-account limit","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml put /api/v1/accounts/sub-accounts/{subAccountId}/limits/{assetId}","href":"/api-reference/accountsservice/update-sub-account-limit"},{"title":"Delete sub-account limit","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml delete /api/v1/accounts/sub-accounts/{subAccountId}/limits/{assetId}","href":"/api-reference/accountsservice/delete-sub-account-limit"}]},{"group":"Applications","pages":[{"title":"Get application configuration","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/applications/config","href":"/api-reference/applicationsservice/get-application-configuration"},{"title":"Get application stats","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/applications/stats","href":"/api-reference/applicationsservice/get-application-stats"},{"title":"List application users","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/applications/users","href":"/api-reference/applicationsservice/list-application-users"},{"title":"List application balances","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/applications/balances","href":"/api-reference/applicationsservice/list-application-balances"},{"title":"List application orders","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/applications/orders","href":"/api-reference/applicationsservice/list-application-orders"},{"title":"List application movements","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/applications/movements","href":"/api-reference/applicationsservice/list-application-movements"}]},{"group":"Market","pages":[{"title":"Trading Pairs","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/market/pairs","href":"/api-reference/marketservice/trading-pairs"},{"title":"Trading Pair By ID","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/market/pairs/{tradingPairId}","href":"/api-reference/marketservice/trading-pair-by-id"},{"title":"Market Metadata","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/market/pairs/{tradingPairId}/metadata","href":"/api-reference/marketservice/market-metadata"},{"title":"Get apiv1marketpairs perpconfig","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/market/pairs/{tradingPairId}/perp/config","href":"/api-reference/marketservice/get-apiv1marketpairs-perpconfig"},{"title":"Get apiv1marketpairs perpsummary","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/market/pairs/{tradingPairId}/perp/summary","href":"/api-reference/marketservice/get-apiv1marketpairs-perpsummary"},{"title":"Get apiv1marketpairs mark price","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/market/pairs/{tradingPairId}/mark-price","href":"/api-reference/marketservice/get-apiv1marketpairs-mark-price"},{"title":"Get apiv1marketpairs index price","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/market/pairs/{tradingPairId}/index-price","href":"/api-reference/marketservice/get-apiv1marketpairs-index-price"},{"title":"Get apiv1marketpairs funding","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/market/pairs/{tradingPairId}/funding","href":"/api-reference/marketservice/get-apiv1marketpairs-funding"},{"title":"Get apiv1marketpairs fundinghistory","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/market/pairs/{tradingPairId}/funding/history","href":"/api-reference/marketservice/get-apiv1marketpairs-fundinghistory"},{"title":"Get apiv1marketfundinghistory","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/market/funding/history","href":"/api-reference/marketservice/get-apiv1marketfundinghistory"},{"title":"Open Interest","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/market/pairs/{tradingPairId}/open-interest","href":"/api-reference/marketservice/open-interest"},{"title":"Trader Metrics","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/market/pairs/{tradingPairId}/trader-metrics","href":"/api-reference/marketservice/trader-metrics"},{"title":"Trade Flow","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/market/pairs/{tradingPairId}/trade-flow","href":"/api-reference/marketservice/trade-flow"},{"title":"Liquidation Events","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/market/pairs/{tradingPairId}/liquidation-events","href":"/api-reference/marketservice/liquidation-events"},{"title":"Liquidation Metrics","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/market/pairs/{tradingPairId}/liquidation-metrics","href":"/api-reference/marketservice/liquidation-metrics"},{"title":"Candlestick Data","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/market/pairs/charts/candlestick/{tradingPairId}/{interval}","href":"/api-reference/marketservice/candlestick-data"},{"title":"Market Stats","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/market/stats","href":"/api-reference/marketservice/market-stats"},{"title":"Market Screener","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/market/screener","href":"/api-reference/marketservice/market-screener"}]},{"group":"Orderbook","pages":[{"title":"Orderbook Snapshot","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/orderbook/{tradingPairId}","href":"/api-reference/orderbookservice/orderbook-snapshot"}]},{"group":"Trades","pages":[{"title":"Recent Trades","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/trades/{tradingPairId}","href":"/api-reference/tradesservice/recent-trades"},{"title":"Get Trade by ID","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/trades/by-id/{tradeId}","href":"/api-reference/tradesservice/get-trade-by-id"}]},{"group":"Fees","pages":[{"title":"Simulate fees for a potential order","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/fees/simulate","href":"/api-reference/feesservice/simulate-fees-for-a-potential-order"},{"title":"Get my fee tier and pair schedule","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/fees/tier","href":"/api-reference/feesservice/get-my-fee-tier-and-pair-schedule"},{"title":"Get a trading pair's fee tier schedule","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/fees/schedule","href":"/api-reference/feesservice/get-a-trading-pairs-fee-tier-schedule"}]},{"group":"Withdrawals","pages":[{"title":"Initiate withdrawal","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/withdrawals","href":"/api-reference/withdrawalsservice/initiate-withdrawal"},{"title":"List pending withdrawals","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/withdrawals","href":"/api-reference/withdrawalsservice/list-pending-withdrawals"},{"title":"Get withdrawal","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/withdrawals/{withdrawalIndex}","href":"/api-reference/withdrawalsservice/get-withdrawal"}]},{"group":"Pulse","pages":[{"title":"Get the market pulse news feed","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/pulse","href":"/api-reference/pulseservice/get-the-market-pulse-news-feed"}]},{"group":"Compliance","pages":[{"title":"Get the caller's region status","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/compliance/region","href":"/api-reference/complianceservice/get-the-callers-region-status"}]},{"group":"Sweeper","pages":[{"title":"Register a deposit address for monitoring","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/sweeper/register","href":"/api-reference/sweeperservice/register-a-deposit-address-for-monitoring"},{"title":"List the chains and assets the sweeper watches","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/sweeper/chains","href":"/api-reference/sweeperservice/list-the-chains-and-assets-the-sweeper-watches"},{"title":"List the caller's sweeper deposits, newest first","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/sweeper/deposits","href":"/api-reference/sweeperservice/list-the-callers-sweeper-deposits-newest-first"},{"title":"Get the status of the caller's sweeper deposits in one transaction","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/sweeper/deposits/{txHash}","href":"/api-reference/sweeperservice/get-the-status-of-the-callers-sweeper-deposits-in-one-transaction"}]},{"group":"Managed Markets","pages":[{"title":"List caller managed market assignments","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/managed-markets/assignments","href":"/api-reference/managedmarketsservice/list-caller-managed-market-assignments"},{"title":"Claim or renew a fenced maker lease","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/managed-markets/{launchId}/lease","href":"/api-reference/managedmarketsservice/claim-or-renew-a-fenced-maker-lease"},{"title":"Refresh the server-bounded managed quote set","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/managed-markets/{launchId}/quotes","href":"/api-reference/managedmarketsservice/refresh-the-server-bounded-managed-quote-set"}]},{"group":"Orders","pages":[{"title":"Get user orders","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/orders","href":"/api-reference/ordersservice/get-user-orders"},{"title":"Create new order","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/orders","href":"/api-reference/ordersservice/create-new-order"},{"title":"Get order by ID","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/orders/{orderId}","href":"/api-reference/ordersservice/get-order-by-id"},{"title":"Replace existing order","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml put /api/v1/orders/{orderId}","href":"/api-reference/ordersservice/replace-existing-order"},{"title":"Cancel existing order","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/orders/cancel","href":"/api-reference/ordersservice/cancel-existing-order"},{"title":"Batch cancel specific orders","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/orders/batch-cancel","href":"/api-reference/ordersservice/batch-cancel-specific-orders"},{"title":"Batch create orders","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/orders/batch-create","href":"/api-reference/ordersservice/batch-create-orders"},{"title":"Batch replace orders","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/orders/batch-replace","href":"/api-reference/ordersservice/batch-replace-orders"},{"title":"Cancel all orders","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/orders/batch-cancel-all","href":"/api-reference/ordersservice/cancel-all-orders"},{"title":"Cancel all orders for a trading pair","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/orders/batch-cancel-all/{tradingPairId}","href":"/api-reference/ordersservice/cancel-all-orders-for-a-trading-pair"},{"title":"Get apiv1ordersconditional","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/orders/conditional/{conditionalOrderId}","href":"/api-reference/ordersservice/get-apiv1ordersconditional"},{"title":"Get apiv1ordersconditional","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/orders/conditional/{conditionalOrderId}","href":"/api-reference/ordersservice/get-apiv1ordersconditional"},{"title":"Delete apiv1ordersconditional","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml delete /api/v1/orders/conditional/{conditionalOrderId}","href":"/api-reference/ordersservice/delete-apiv1ordersconditional"},{"title":"Create TWAP order","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/orders/twap","href":"/api-reference/ordersservice/create-twap-order"},{"title":"List TWAP orders","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/orders/twap","href":"/api-reference/ordersservice/list-twap-orders"},{"title":"Get TWAP order by ID","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/orders/twap/{twapOrderId}","href":"/api-reference/ordersservice/get-twap-order-by-id"},{"title":"Get TWAP order TCA report","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/orders/twap/{twapOrderId}/tca","href":"/api-reference/ordersservice/get-twap-order-tca-report"},{"title":"List TWAP order slices","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/orders/twap/{twapOrderId}/slices","href":"/api-reference/ordersservice/list-twap-order-slices"},{"title":"Cancel TWAP order","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/orders/twap/{twapOrderId}/cancel","href":"/api-reference/ordersservice/cancel-twap-order"}]},{"group":"Margin Accounts","pages":[{"title":"Get apiv1marginaccounts","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/margin/accounts/{marginAccountId}","href":"/api-reference/marginaccountsservice/get-apiv1marginaccounts"},{"title":"Get apiv1marginaccounts","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/margin/accounts/{marginAccountId}","href":"/api-reference/marginaccountsservice/get-apiv1marginaccounts"},{"title":"Post apiv1marginaccounts collateraltransfer in","deprecated":true,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/margin/accounts/{marginAccountId}/collateral/transfer-in","href":"/api-reference/marginaccountsservice/post-apiv1marginaccounts-collateraltransfer-in"},{"title":"Post apiv1marginaccounts collateraltransfer out","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/margin/accounts/{marginAccountId}/collateral/transfer-out","href":"/api-reference/marginaccountsservice/post-apiv1marginaccounts-collateraltransfer-out"},{"title":"Get apiv1marginaccounts movements","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/margin/accounts/{marginAccountId}/movements","href":"/api-reference/marginaccountsservice/get-apiv1marginaccounts-movements"},{"title":"Get apiv1marginaccounts pnl","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/margin/accounts/{marginAccountId}/pnl","href":"/api-reference/marginaccountsservice/get-apiv1marginaccounts-pnl"},{"title":"Post apiv1marginaccounts simulate order risk","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/margin/accounts/{marginAccountId}/simulate-order-risk","href":"/api-reference/marginaccountsservice/post-apiv1marginaccounts-simulate-order-risk"},{"title":"Get apiv1margincollateralavailable","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/margin/collateral/available","href":"/api-reference/marginaccountsservice/get-apiv1margincollateralavailable"},{"title":"Post apiv1margincollateraltransfer","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/margin/collateral/transfer","href":"/api-reference/marginaccountsservice/post-apiv1margincollateraltransfer"},{"title":"Get apiv1marginparent margin account","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/margin/parent-margin-account","href":"/api-reference/marginaccountsservice/get-apiv1marginparent-margin-account"},{"title":"Post apiv1marginparent margin accountcollateraltransfer in","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/margin/parent-margin-account/collateral/transfer-in","href":"/api-reference/marginaccountsservice/post-apiv1marginparent-margin-accountcollateraltransfer-in"},{"title":"Post apiv1marginparent margin accountcollateraltransfer out","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/margin/parent-margin-account/collateral/transfer-out","href":"/api-reference/marginaccountsservice/post-apiv1marginparent-margin-accountcollateraltransfer-out"},{"title":"Get apiv1marginparent margin accountmovements","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/margin/parent-margin-account/movements","href":"/api-reference/marginaccountsservice/get-apiv1marginparent-margin-accountmovements"},{"title":"Post apiv1marginparent margin accountsimulate order risk","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/margin/parent-margin-account/simulate-order-risk","href":"/api-reference/marginaccountsservice/post-apiv1marginparent-margin-accountsimulate-order-risk"},{"title":"Post apiv1marginrisk bucketscollateraltransfer in","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/margin/risk-buckets/collateral/transfer-in","href":"/api-reference/marginaccountsservice/post-apiv1marginrisk-bucketscollateraltransfer-in"},{"title":"Post apiv1marginrisk bucketssimulate order risk","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/margin/risk-buckets/simulate-order-risk","href":"/api-reference/marginaccountsservice/post-apiv1marginrisk-bucketssimulate-order-risk"},{"title":"Post apiv1marginsub accounts","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/margin/sub-accounts","href":"/api-reference/marginaccountsservice/post-apiv1marginsub-accounts"},{"title":"Post apiv1marginsub accounts close","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/margin/sub-accounts/{marginAccountId}/close","href":"/api-reference/marginaccountsservice/post-apiv1marginsub-accounts-close"},{"title":"Post apiv1marginsub accounts collateraltransfer in","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/margin/sub-accounts/{marginAccountId}/collateral/transfer-in","href":"/api-reference/marginaccountsservice/post-apiv1marginsub-accounts-collateraltransfer-in"},{"title":"Post apiv1marginsub accounts collateraltransfer out","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/margin/sub-accounts/{marginAccountId}/collateral/transfer-out","href":"/api-reference/marginaccountsservice/post-apiv1marginsub-accounts-collateraltransfer-out"}]},{"group":"Positions","pages":[{"title":"Get apiv1positions","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/positions/{positionId}","href":"/api-reference/positionsservice/get-apiv1positions"},{"title":"Get apiv1positionshistory","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/positions/history","href":"/api-reference/positionsservice/get-apiv1positionshistory"},{"title":"Post apiv1positionsbatch close all","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/positions/batch-close-all","href":"/api-reference/positionsservice/post-apiv1positionsbatch-close-all"},{"title":"Get apiv1positions","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/positions/{positionId}","href":"/api-reference/positionsservice/get-apiv1positions"},{"title":"Post apiv1positions close","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/positions/{positionId}/close","href":"/api-reference/positionsservice/post-apiv1positions-close"},{"title":"Get position PnL history","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/positions/{positionId}/pnl/history","href":"/api-reference/positionsservice/get-position-pnl-history"},{"title":"Get apiv1positions risk","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/positions/{positionId}/risk","href":"/api-reference/positionsservice/get-apiv1positions-risk"},{"title":"Post apiv1positions tp sl","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/positions/{positionId}/tp-sl","href":"/api-reference/positionsservice/post-apiv1positions-tp-sl"}]},{"group":"Delegated Agents","pages":[{"title":"Upsert delegated agent","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/delegated-agents","href":"/api-reference/delegatedagentsservice/upsert-delegated-agent"},{"title":"List delegated agents","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/delegated-agents","href":"/api-reference/delegatedagentsservice/list-delegated-agents"},{"title":"List delegating owners","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/delegated-agents/owners","href":"/api-reference/delegatedagentsservice/list-delegating-owners"},{"title":"Revoke delegated agent","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml delete /api/v1/delegated-agents/{delegatedAgentId}","href":"/api-reference/delegatedagentsservice/revoke-delegated-agent"},{"title":"Create delegated session","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/delegated-agents/sessions","href":"/api-reference/delegatedagentsservice/create-delegated-session"}]},{"group":"TraderCodes","pages":[{"title":"Get your TraderCode","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/tradercodes/codes/me","href":"/api-reference/tradercodeservice/get-your-tradercode"},{"title":"Check custom TraderCode availability","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/tradercodes/codes/available","href":"/api-reference/tradercodeservice/check-custom-tradercode-availability"},{"title":"Look up a TraderCode","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/tradercodes/codes/{code}","href":"/api-reference/tradercodeservice/look-up-a-tradercode"},{"title":"Claim or edit your custom TraderCode","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml put /api/v1/tradercodes/codes/me/custom","href":"/api-reference/tradercodeservice/claim-or-edit-your-custom-tradercode"},{"title":"Clear your custom TraderCode","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml delete /api/v1/tradercodes/codes/me/custom","href":"/api-reference/tradercodeservice/clear-your-custom-tradercode"},{"title":"Get your referral position","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/tradercodes/referrals/me","href":"/api-reference/tradercodeservice/get-your-referral-position"},{"title":"Get your referral downline and earnings","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/tradercodes/referrals/me/downline","href":"/api-reference/tradercodeservice/get-your-referral-downline-and-earnings"},{"title":"Get one level of your referral tree","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/tradercodes/referrals/me/tree","href":"/api-reference/tradercodeservice/get-one-level-of-your-referral-tree"},{"title":"Get your rewards balance","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/tradercodes/rewards/balance","href":"/api-reference/tradercodeservice/get-your-rewards-balance"},{"title":"Transfer rewards into a trading balance","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/tradercodes/rewards/transfer","href":"/api-reference/tradercodeservice/transfer-rewards-into-a-trading-balance"}]},{"group":"Copy Trading","pages":[{"title":"List lead traders","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/copy-trading/leaders","href":"/api-reference/copytradingservice/list-lead-traders"},{"title":"Get a lead trader","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/copy-trading/leaders/{leader}","href":"/api-reference/copytradingservice/get-a-lead-trader"},{"title":"List a lead trader's closed trades","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/copy-trading/leaders/{leader}/closed-trades","href":"/api-reference/copytradingservice/list-a-lead-traders-closed-trades"},{"title":"List a followed lead trader's open positions","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/copy-trading/leaders/{leader}/positions","href":"/api-reference/copytradingservice/list-a-followed-lead-traders-open-positions"},{"title":"Register as a lead trader or edit your profile","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml put /api/v1/copy-trading/leaders/me","href":"/api-reference/copytradingservice/register-as-a-lead-trader-or-edit-your-profile"},{"title":"Get your lead trader profile","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/copy-trading/leaders/me","href":"/api-reference/copytradingservice/get-your-lead-trader-profile"},{"title":"List your followers","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/copy-trading/leaders/me/followers","href":"/api-reference/copytradingservice/list-your-followers"},{"title":"Follow a lead trader or edit a follow","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/copy-trading/follows","href":"/api-reference/copytradingservice/follow-a-lead-trader-or-edit-a-follow"},{"title":"List your follows","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/copy-trading/follows","href":"/api-reference/copytradingservice/list-your-follows"},{"title":"Get one of your follows","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/copy-trading/follows/{followId}","href":"/api-reference/copytradingservice/get-one-of-your-follows"},{"title":"Preview copying a lead trader's open positions","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/copy-trading/follows/preview","href":"/api-reference/copytradingservice/preview-copying-a-lead-traders-open-positions"},{"title":"Stop a follow","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/copy-trading/follows/{followId}/stop","href":"/api-reference/copytradingservice/stop-a-follow"},{"title":"List the open positions of a followed lead trader","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/copy-trading/follows/{followId}/leader-positions","href":"/api-reference/copytradingservice/list-the-open-positions-of-a-followed-lead-trader"},{"title":"Close a follow's copy positions","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/copy-trading/follows/{followId}/close-positions","href":"/api-reference/copytradingservice/close-a-follows-copy-positions"},{"title":"Close all your copy positions","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/copy-trading/follows/close-positions","href":"/api-reference/copytradingservice/close-all-your-copy-positions"},{"title":"Add margin to a copy position","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/copy-trading/follows/{followId}/position-margin","href":"/api-reference/copytradingservice/add-margin-to-a-copy-position"}]},{"group":"BuilderCodes","pages":[{"title":"Get your BuilderCodes program configuration","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/buildercodes/config","href":"/api-reference/buildercoderewardsservice/get-your-buildercodes-program-configuration"},{"title":"Set your builder fees","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml put /api/v1/buildercodes/builder-fee","href":"/api-reference/buildercoderewardsservice/set-your-builder-fees"},{"title":"List your builder-fee changes","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/buildercodes/builder-fee/changes","href":"/api-reference/buildercoderewardsservice/list-your-builder-fee-changes"},{"title":"List your per-trade BuilderCodes earnings","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/buildercodes/payouts","href":"/api-reference/buildercoderewardsservice/list-your-per-trade-buildercodes-earnings"},{"title":"Summarize your BuilderCodes earnings","description":"Summarize this application's BuilderCodes earnings by token.\n\n Amounts stay separated by token because they are RAW atomic units. The\n application is taken from the authenticated session.","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/buildercodes/payouts/summary","href":"/api-reference/buildercoderewardsservice/summarize-your-buildercodes-earnings"},{"title":"Get your accrued BuilderCodes balance","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/buildercodes/rewards/balance","href":"/api-reference/buildercoderewardsservice/get-your-accrued-buildercodes-balance"},{"title":"Claim accrued BuilderCodes payout balance","description":"Claim accrued BuilderCodes payout balance.\n\n Move accrued BuilderCodes payout balance from your reserved payout bucket\n into a trading balance under the authenticated application, making it\n withdrawable through the ordinary withdrawal flow. Ledger-only (one shared\n vault + one backend ledger) — no on-chain transaction and no gas.\n\n The bucket is resolved from the AUTHENTICATED caller's own wallet address,\n never from the request body, so a caller can only ever claim their own\n accrued balance. A wallet that has never been an enrolled frontend's payout\n address simply has an empty bucket. Shortly after Monaco moves a\n frontend's payout address to a new wallet, the unclaimed balance accrued\n to the old wallet moves to the new wallet. A wallet several frontends paid\n into before each payout wallet was limited to one frontend is not moved.\n Current enrollment is deliberately not required, so a wallet that used to\n be a payout address can still claim whatever remains in its bucket.\n\n The payout wallet may be an EOA or a smart-contract wallet. An EOA answers\n Monaco's signature challenge directly. A contract wallet — a multisig such\n as a Safe — holds no private key and cannot, so it authenticates by EIP-1271\n contract signature instead: Monaco asks the wallet contract whether it\n accepts the challenge. That path is deliberately narrow. It is offered only\n to a wallet that holds a BuilderCodes payout bucket, only while the\n `contract_wallet_auth_enabled` flag is on, and only where the deployment has\n a chain RPC endpoint configured. While any of those is not met, login is\n EOA-only and a contract payout wallet can neither call this endpoint nor\n withdraw afterwards, so its accrued share stays unclaimable.\n\n Delegated-agent sessions are refused: a delegated grant conveys only\n order-management authority, and this claim converts reserved balance into a\n tradeable one. No program switch gates the claim: a balance already\n credited stays claimable whether or not the revenue share is on.\n\n Transport contracts differ, and this comment is emitted into the generated\n gRPC SDK where HTTP statuses do not exist. An insufficient payout balance\n is **HTTP 409** on REST and **FAILED_PRECONDITION** on gRPC; a refused\n caller (delegated session) is **HTTP 403** on\n REST and **PERMISSION_DENIED** on gRPC.\n\n A claim can also fail as **HTTP 503** / **UNAVAILABLE** when the matching\n engine is unreachable, restarting, or slow to answer. Treat that as an\n UNKNOWN outcome, NOT a rejection. The request is admitted to the sequencer\n before its reply is sent, so a claim that timed out in transit may still\n commit, and there is no idempotency key — a blind retry can claim a SECOND\n time. Do NOT retry automatically, and do not settle it with a balance\n read: an admitted claim can still be sitting in the sequencer queue when\n the balance is read, so an unchanged balance does not prove the claim will\n not commit. Treat the claim as PENDING rather than failed, re-check once\n the engine is healthy again, and reconcile before issuing another claim.\n\n Not every 503 is ambiguous, and the safe ones are tagged. TWO outcomes are\n refused BEFORE the claim can be admitted to the sequencer, so they left no\n durable-log or state footprint and definitely committed nothing. One is a\n deliberate maintenance block, where REST carries\n `\"error\": \"OPERATIONS_BLOCKED\"` and gRPC tags the status with\n `x-maintenance-blocked: true`. The other is a sequencer admission rejection\n when the engine is saturated, where REST carries `\"code\": \"OVERLOADED\"` and\n gRPC carries the same code in the status' error details. Both are safe to\n retry with backoff, and an overload positively wants one. Only an UNTAGGED\n availability failure — matching-engine transport, timeout and fail-closed\n paths — carries the unknown outcome.\n\n A claim spends the per-user movement budget withdrawals and collateral\n transfers share. Over budget it is refused with **HTTP 429** /\n **RESOURCE_EXHAUSTED** before it reaches the sequencer, so it committed\n nothing and is safe to retry after the interval in `details.retryAfter`.","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/buildercodes/rewards/claim","href":"/api-reference/buildercoderewardsservice/claim-accrued-buildercodes-payout-balance"}]}]},{"title":"WebSocket API","href":"/reference/websockets"},{"title":"HTTP message signatures","href":"/reference/http-message-signatures"},{"group":"gRPC API","root":{"title":"gRPC API","href":"/reference/grpc"},"expanded":false,"pages":[{"group":"Protobuf Reference","root":{"title":"Protobuf Reference","href":"/grpc/protos"},"expanded":false,"pages":[{"group":"Core","pages":[{"title":"AuthService","href":"/grpc/protos/auth"},{"title":"AccountsService","href":"/grpc/protos/accounts"},{"title":"ApplicationsService","href":"/grpc/protos/applications"},{"title":"HealthService","href":"/grpc/protos/health"},{"title":"ComplianceService","href":"/grpc/protos/compliance"}]},{"group":"Trading","pages":[{"title":"MarketService","href":"/grpc/protos/market"},{"title":"PulseService","href":"/grpc/protos/pulse"},{"title":"OrdersService","href":"/grpc/protos/orders"},{"title":"OrderbookService","href":"/grpc/protos/orderbook"},{"title":"TradesService","href":"/grpc/protos/trades"},{"title":"FeesService","href":"/grpc/protos/fees"}]},{"group":"Perps","pages":[{"title":"MarginAccountsService","href":"/grpc/protos/margin-accounts"},{"title":"PositionsService","href":"/grpc/protos/positions"}]},{"group":"Vault and Delegation","pages":[{"title":"WithdrawalsService","href":"/grpc/protos/withdrawals"},{"title":"SweeperService","href":"/grpc/protos/sweeper"},{"title":"DelegatedAgentsService","href":"/grpc/protos/delegated-agents"}]},{"group":"TraderCodes","pages":[{"title":"TraderCodeService","href":"/grpc/protos/tradercodes"}]},{"group":"Copy Trading","pages":[{"title":"CopyTradingService","href":"/grpc/protos/copy-trading"}]},{"group":"BuilderCodes","pages":[{"title":"BuildercodeRewardsService","href":"/grpc/protos/buildercodes"}]},{"group":"Managed Markets","pages":[{"title":"ManagedMarketsService","href":"/grpc/protos/managed-markets"}]}]}]}]},{"group":"Resources","pages":[{"title":null,"href":"/changelog"},{"group":"Examples","expanded":false,"pages":[{"title":"Build a Trading App","href":"/examples/build-trading-app"},{"title":"Complete Integration Example","href":"/examples/complete-flow"},{"title":"Perp Trading Example","href":"/examples/perp-flow"}]},{"group":"Releases","expanded":false,"pages":[{"title":null,"href":"/releases/v1.1.0"},{"title":null,"href":"/releases/v1.0.99"},{"title":null,"href":"/releases/v1.0.98"},{"title":null,"href":"/releases/v1.0.97"},{"title":null,"href":"/releases/v1.0.96"},{"title":null,"href":"/releases/v1.0.94"},{"title":null,"href":"/releases/v1.0.93"},{"title":null,"href":"/releases/v1.0.92"},{"title":null,"href":"/releases/v1.0.91"},{"title":null,"href":"/releases/v1.0.88"},{"title":null,"href":"/releases/v1.0.87"},{"title":null,"href":"/releases/v1.0.86"},{"title":null,"href":"/releases/v1.0.85"},{"title":null,"href":"/releases/v1.0.83"},{"title":null,"href":"/releases/v1.0.82"},{"title":null,"href":"/releases/v1.0.81"},{"title":null,"href":"/releases/v1.0.80"},{"title":null,"href":"/releases/v1.0.77"},{"title":null,"href":"/releases/v1.0.76"},{"title":null,"href":"/releases/v1.0.75"},{"title":null,"href":"/releases/v1.0.74"},{"title":null,"href":"/releases/v1.0.73"},{"title":null,"href":"/releases/v1.0.72"},{"title":null,"href":"/releases/v1.0.70"},{"title":null,"href":"/releases/v1.0.69"},{"title":null,"href":"/releases/v1.0.67"},{"title":null,"href":"/releases/v1.0.66"},{"title":null,"href":"/releases/v1.0.65"},{"title":null,"href":"/releases/v1.0.64"},{"title":null,"href":"/releases/v1.0.62"},{"title":null,"href":"/releases/v1.0.61"},{"title":null,"href":"/releases/v1.0.60"},{"title":null,"href":"/releases/v1.0.59"},{"title":null,"href":"/releases/v1.0.58"},{"title":null,"href":"/releases/v1.0.57"},{"title":null,"href":"/releases/v1.0.56"},{"title":null,"href":"/releases/v1.0.55"},{"title":null,"href":"/releases/v1.0.54"},{"title":null,"href":"/releases/v1.0.53"},{"title":null,"href":"/releases/v1.0.51"},{"title":null,"href":"/releases/v1.0.50"},{"title":null,"href":"/releases/v1.0.48"},{"title":null,"href":"/releases/v1.0.47"},{"title":null,"href":"/releases/v1.0.46"},{"title":null,"href":"/releases/v1.0.45"},{"title":null,"href":"/releases/v1.0.44"},{"title":null,"href":"/releases/v1.0.43"},{"title":null,"href":"/releases/v1.0.42"},{"title":null,"href":"/releases/v1.0.41"},{"title":null,"href":"/releases/v1.0.40"},{"title":null,"href":"/releases/v1.0.39"},{"title":null,"href":"/releases/v1.0.38"},{"title":null,"href":"/releases/v1.0.37"},{"title":null,"href":"/releases/v1.0.36"},{"title":null,"href":"/releases/v1.0.34"},{"title":null,"href":"/releases/v1.0.33"},{"title":null,"href":"/releases/v1.0.32"},{"title":null,"href":"/releases/v1.0.29"},{"title":null,"href":"/releases/v1.0.26"},{"title":null,"href":"/releases/v1.0.24"},{"title":null,"href":"/releases/v1.0.21"},{"title":null,"href":"/releases/v1.0.16"},{"title":null,"href":"/releases/v1.0.7"},{"title":null,"href":"/releases/v1.0.3"},{"title":null,"href":"/releases/v1.0.2"},{"title":null,"href":"/releases/v0.8.22"},{"title":null,"href":"/releases/v0.8.21"},{"title":null,"href":"/releases/v0.8.20"},{"title":null,"href":"/releases/v0.8.19"},{"title":null,"href":"/releases/v0.8.18"},{"title":null,"href":"/releases/v0.8.16"},{"title":null,"href":"/releases/v0.8.15"},{"title":null,"href":"/releases/v0.8.14"},{"title":null,"href":"/releases/v0.8.11"},{"title":null,"href":"/releases/v0.8.10"},{"title":null,"href":"/releases/v0.8.8"},{"title":null,"href":"/releases/v0.8.7"},{"title":null,"href":"/releases/v0.8.5"},{"title":null,"href":"/releases/v0.8.4"},{"title":null,"href":"/releases/v0.7.9"},{"title":null,"href":"/releases/v0.7.8"},{"title":null,"href":"/releases/v0.7.2"},{"title":null,"href":"/releases/v0.7.0"},{"title":null,"href":"/releases/v0.6.3"},{"title":null,"href":"/releases/v0.6.2"},{"title":null,"href":"/releases/v0.6.1"},{"title":null,"href":"/releases/v0.6.0"},{"title":null,"href":"/releases/v0.5.9"},{"title":null,"href":"/releases/v0.5.8"},{"title":null,"href":"/releases/v0.5.7"},{"title":null,"href":"/releases/v0.5.6"},{"title":null,"href":"/releases/v0.5.5"},{"title":null,"href":"/releases/v0.5.4"},{"title":null,"href":"/releases/v0.5.3"},{"title":null,"href":"/releases/v0.5.2"},{"title":null,"href":"/releases/v0.5.1"},{"title":null,"href":"/releases/v0.5.0"},{"title":null,"href":"/releases/v0.4.1"},{"title":null,"href":"/releases/v0.4.0"},{"title":null,"href":"/releases/v0.3.1"},{"title":null,"href":"/releases/v0.3.0"},{"title":null,"href":"/releases/v0.2.0"},{"title":null,"href":"/releases/v0.1.6"},{"title":null,"href":"/releases/v0.1.5"},{"title":null,"href":"/releases/v0.1.1"}]}]}]},"title":"Get your accrued BuilderCodes balance - Monaco Protocol SDK v1.1.0","buildId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","deploymentId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DmVyH30O.js","utils-BHQqGGOd.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-CD-E4BIt.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Bp5Lq9Ds.js","snippetPresets-C4xAVCFP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CgXVLxUC.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BF8I5oUf.js","shallow-Byd0lWnC.js","getApiPlaygroundDisplay-BGOZG1OK.js","CodeSnippet-CpvQL0CY.js","CodeSnippets-B8wkBKXa.js","Page-CBCH2P7b.js","getPastedJson-Ry3scI3Y.js","icon-D7a9HcdD.js","MethodPill-CJ8pmHhz.js","DuplicateIcon-rh1HJF0t.js","createIcon-DvGznqYs.js","DynamicMarkdown-Cc6AuSHS.js","SectionHeading-B4A0S-ep.js","axios-vUo_bRtp.js","Markdown-Cc16CX65.js","clsx-Cs6nMGht.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-zbf22OZA.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-C_fs-y5n.js"]}