Token ticker for wallets (for example, SBC), or USD for a Plaid-linked bank.
Example:
"SBC"
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Brale","description":"API documentation for issuing, moving, and managing stablecoins on any blockchain with Brale.","colors":{"primary":"#000000","light":"#6938EF","dark":"#18181B"},"logo":{"light":"https://mintcdn.com/brale/8ZhoPWIKA3trPz7_/images/brale/brale-logo-light.svg?fit=max\u0026auto=format\u0026n=8ZhoPWIKA3trPz7_\u0026q=85\u0026s=9d75182cc1a672349f431ab9462b2b14","dark":"https://mintcdn.com/brale/8ZhoPWIKA3trPz7_/images/brale/brale-logo-dark.svg?fit=max\u0026auto=format\u0026n=8ZhoPWIKA3trPz7_\u0026q=85\u0026s=b440c6595e79456e4bec0a5be2bb6b8e"},"favicon":"https://mintcdn.com/brale/8ZhoPWIKA3trPz7_/favicon.svg?fit=max\u0026auto=format\u0026n=8ZhoPWIKA3trPz7_\u0026q=85\u0026s=5ea8e718e80214027ad6dd92fd6a4116","navbar":{"links":[],"primary":{"type":"button","label":"Dashboard","href":"https://app.brale.xyz"}},"footer":{"socials":{"github":"https://github.com/Brale-xyz"}},"seo":{"metatags":{"canonical":"https://docs.brale.xyz","og:site_name":"Brale"},"indexing":"navigable"},"integrations":{"ga4":{"measurementId":"G-ZM1CBNJ9KC"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"API Keys","icon":"key","href":"https://app.brale.xyz"},{"anchor":"API Logs","icon":"database","href":"https://app.brale.xyz/api?tab=activity"},{"anchor":"Changelog","icon":"clock-rotate-left","href":"/changelog"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"brale","hasAudioNarration":false,"actualSubdomain":"brale","customDomains":["docs.brale.xyz"],"gitSource":{"type":"github","owner":"brale-xyz","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae244080326181be736c7d2","collectionId":"5695940d-5513-4587-ae59-e5dd0abcb54e","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae244080326181be736c7d2"},"feedback":{"thumbs":true,"edits":false,"issues":false},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae244080326181be736c7d2","clientVersion":"0.0.4006","searchFilterCounts":[{"language":"default","tag":"API reference","count":42},{"language":"default","tag":"Guides","count":24},{"language":"default","tag":"API Docs","count":19},{"language":"default","tag":"Workflows","count":18},{"language":"default","tag":"Information","count":15},{"language":"default","tag":"Webhooks","count":13},{"language":"default","tag":"Key concepts","count":10},{"language":"default","tag":"Tokenization","count":9},{"language":"default","tag":"Accounts","count":6},{"language":"default","tag":"Addresses","count":6}]},"assistantConfig":{"enableAskAiButton":true,"enableStarterQuestions":false,"enableAskAiSearchBar":true,"deflection":{"enabled":true,"email":"[email protected]","showHelpButton":true}},"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":"editor-v7-file-tree","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":"editor-nav-generations","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":"editor-agent-model-picker","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/brale/get-address-balance","slug":"/api-reference/brale/get-address-balance","pageMetadata":{"title":"Get an address balance","description":"Returns the balance of a custodial wallet address or a Plaid-linked bank address. Provide `transfer_type` and `value_type` as query parameters.","openapi":"GET /accounts/{account_id}/addresses/{address_id}/balance","href":"/api-reference/brale/get-address-balance"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Returns the balance of a custodial wallet address or a Plaid-linked bank address. Provide \", _jsx(_components.code, {\n children: \"transfer_type\"\n }), \" and \", _jsx(_components.code, {\n children: \"value_type\"\n }), \" as query parameters.\"]\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,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,li:`li`,p:`p`,pre:`pre`,span:`span`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,Heading,Note,Table}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Use the playground below to try this endpoint directly, or review the OpenAPI details in the right panel.`}),`\n`,_jsx(Heading,{level:`2`,id:`query-parameters-by-address-type`,children:`Query parameters by address type`}),`\n`,_jsxs(_components.p,{children:[`Both `,_jsx(_components.code,{children:`transfer_type`}),` and `,_jsx(_components.code,{children:`value_type`}),` are required.`]}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Address type`}),_jsx(_components.th,{children:_jsx(_components.code,{children:`transfer_type`})}),_jsx(_components.th,{children:_jsx(_components.code,{children:`value_type`})})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[`Custodial wallet (`,_jsx(_components.code,{children:`type=internal`}),`)`]}),_jsxs(_components.td,{children:[`Blockchain network, such as `,_jsx(_components.code,{children:`base`})]}),_jsxs(_components.td,{children:[`Token ticker, such as `,_jsx(_components.code,{children:`SBC`})]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Plaid-linked bank address`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`ach_debit`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`USD`})})]})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`plaid-linked-bank-balances`,children:`Plaid-linked bank balances`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`3`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`3`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --request`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` GET`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --url`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:' \"https://api.brale.xyz/accounts/${'}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`ACCOUNT_ID`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:\"}/addresses/${\"}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`ADDRESS_ID`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`}/balance?transfer_type=ach_debit\u0026value_type=USD\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --header`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:' \"Authorization: Bearer ${'}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`AUTH_TOKEN`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`}\"`})]}),`\n`]})})}),`\n`,_jsx(CodeBlock,{filename:`Response`,numberOfLines:`13`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`13`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"address\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"34yknnMShvDbSW6tQg4HLlN41QO\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"address\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`null`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"account_number\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"****1234\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"balance\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"value\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"1250.42\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"currency\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"USD\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"value_type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"USD\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"transfer_type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"ach_debit\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Brale uses Plaid’s available balance when Plaid supplies it. Otherwise, Brale uses the current balance.`}),`\n`,_jsx(_components.li,{children:`Successful reads may be cached for up to 30 seconds.`}),`\n`,_jsx(_components.li,{children:`The balance is a point-in-time snapshot. It does not guarantee that an ACH debit will settle.`}),`\n`,_jsxs(_components.li,{children:[`Brale never returns the full bank account number. `,_jsx(_components.code,{children:`account_number`}),` is masked.`]}),`\n`,_jsx(_components.li,{children:`Only Plaid-linked USD bank addresses support balance lookup. Bank addresses created through Direct bank entry do not.`}),`\n`]}),`\n`,_jsx(Heading,{level:`2`,id:`errors`,children:`Errors`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Status`}),_jsx(_components.th,{children:_jsx(_components.code,{children:`type`})}),_jsx(_components.th,{children:`Meaning`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`400`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`invalid_address`})}),_jsxs(_components.td,{children:[`A bank balance request did not use `,_jsx(_components.code,{children:`transfer_type=ach_debit`}),`.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`400`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`invalid_value_type`})}),_jsxs(_components.td,{children:[`A bank balance request did not use `,_jsx(_components.code,{children:`value_type=USD`}),`.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`400`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`balance_not_supported_for_address`})}),_jsx(_components.td,{children:`The address is not Plaid-linked, or the currency is not supported.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`400`})}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`plaid_error`}),` (`,_jsx(_components.code,{children:`code: plaid_item_login_required`}),`)`]}),_jsx(_components.td,{children:`The user must relink the bank account through Plaid.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`503`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`service_unavailable`})}),_jsx(_components.td,{children:`Plaid returned an error or balance data is unavailable.`})]})]})]}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`service_unavailable`}),` does not mean the balance is zero or insufficient.`]})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get an address balance","description":"Returns the balance of a custodial wallet address or a Plaid-linked bank address. Provide `transfer_type` and `value_type` as query parameters.","openapi":"GET /accounts/{account_id}/addresses/{address_id}/balance","href":"/api-reference/brale/get-address-balance"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Query parameters by address type","slug":"query-parameters-by-address-type","depth":2,"children":[]},{"title":"Plaid-linked bank balances","slug":"plaid-linked-bank-balances","depth":2,"children":[]},{"title":"Errors","slug":"errors","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Addresses"],"operationId":"get_address_balance","summary":"Get an address balance","description":"Returns the balance of a custodial wallet address or a Plaid-linked bank address. Provide `transfer_type` and `value_type` as query parameters.","parameters":["f995ac54-f23a-4904-bf13-802c81e9c900","1a09c6cf-a409-4be0-90e8-1dcb083d19ac","670b98b9-ee66-430f-bccc-1e94e63c88de","7e455b61-2964-4605-99b2-edfb21c72eea"],"responses":{"200":"127f3aec-d821-45fb-ae8a-aa9399245f9d","400":"ee37bc54-a632-4fa3-8cd9-459368ebcc6c","503":"b22d2120-9751-425e-82e5-c1c793fcc36f"},"method":"get","type":"path","servers":["d90858c1-e971-4f58-9495-890ae9e516f2"],"security":["c1af3ab6-45cc-44b8-9619-f12174d44816"],"path":"/accounts/{account_id}/addresses/{address_id}/balance","baseUrlOptions":["https://api.brale.xyz"],"title":"Get an address balance","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"f995ac54-f23a-4904-bf13-802c81e9c900":{"name":"account_id","in":"path","required":true,"description":"The ID of the account","schema":{"title":"Kusid","type":"string","format":"ksuid","pattern":"^[a-zA-Z0-9]{27}$","example":"2VcUIIsgARwVbEGlIYbhg6fGG57","isRequired":true,"description":"The ID of the account","uniqueKey":"","typeLabel":"string\u003cksuid>"}},"1a09c6cf-a409-4be0-90e8-1dcb083d19ac":{"name":"address_id","in":"path","required":true,"schema":{"title":"Kusid","type":"string","format":"ksuid","pattern":"^[a-zA-Z0-9]{27}$","example":"2VcUIIsgARwVbEGlIYbhg6fGG57","isRequired":true,"description":"The ID of the address","uniqueKey":"","typeLabel":"string\u003cksuid>"},"description":"The ID of the address"},"670b98b9-ee66-430f-bccc-1e94e63c88de":{"name":"transfer_type","in":"query","required":true,"schema":{"type":"string","isRequired":true,"description":"Blockchain network for wallets (for example, `solana`, `base`, `ethereum`), or `ach_debit` for a Plaid-linked bank.","uniqueKey":"","typeLabel":"string"},"example":"base","description":"Blockchain network for wallets (for example, `solana`, `base`, `ethereum`), or `ach_debit` for a Plaid-linked bank."},"7e455b61-2964-4605-99b2-edfb21c72eea":{"name":"value_type","in":"query","required":true,"schema":{"type":"string","isRequired":true,"description":"Token ticker for wallets (for example, `SBC`, `USDC`), or `USD` for a Plaid-linked bank.","uniqueKey":"","typeLabel":"string"},"example":"SBC","description":"Token ticker for wallets (for example, `SBC`, `USDC`), or `USD` for a Plaid-linked bank."}},"responses":{"127f3aec-d821-45fb-ae8a-aa9399245f9d":{"description":"The address details and balance info","content":{"*/*":{"schema":{"title":"AddressBalance","type":"object","additionalProperties":false,"description":"Balance of **one** token on **one** chain for a custodial wallet, or the USD balance of a Plaid-linked bank address.","properties":{"address":{"title":"AddressReference","type":"object","additionalProperties":false,"properties":{"id":{"title":"Kusid","type":"string","format":"ksuid","pattern":"^[a-zA-Z0-9]{27}$","example":"2VcUIIsgARwVbEGlIYbhg6fGG57","isRequired":true,"uniqueKey":"address.id","typeLabel":"string\u003cksuid>"},"address":{"oneOf":[{"type":"string","description":"On-chain address for wallets. `null` for bank addresses.","example":"0xb518d4d6221d9a41d23d71cbce8e106e7aab8f9b","uniqueKey":"address.address.oneOf.0","typeLabel":"string"},{"type":"null","description":"On-chain address for wallets. `null` for bank addresses.","example":"0xb518d4d6221d9a41d23d71cbce8e106e7aab8f9b","uniqueKey":"address.address.oneOf.1","typeLabel":"null"}],"uniqueKey":"address.address","typeLabel":"string | null"},"account_number":{"oneOf":[{"type":"string","description":"Masked bank account number for bank addresses, for example `****1234`. Brale never returns the full account number. `null` or omitted for wallets.","example":"****1234","uniqueKey":"address.account_number.oneOf.0","typeLabel":"string"},{"type":"null","description":"Masked bank account number for bank addresses, for example `****1234`. Brale never returns the full account number. `null` or omitted for wallets.","example":"****1234","uniqueKey":"address.account_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"address.account_number","typeLabel":"string | null"}},"required":["id"],"isRequired":true,"uniqueKey":"address","typeLabel":"AddressReference · object"},"balance":{"title":"Amount","type":"object","description":"Monetary value with explicit currency","additionalProperties":false,"properties":{"value":{"type":"string","example":"11234.88","isRequired":true,"uniqueKey":"balance.value","typeLabel":"string"},"currency":{"type":"string","example":"USD","isRequired":true,"uniqueKey":"balance.currency","typeLabel":"string"}},"required":["value","currency"],"isRequired":true,"uniqueKey":"balance","typeLabel":"Amount · object"},"transfer_type":{"type":"string","description":"Blockchain network for wallets (for example, `solana` or `base`), or `ach_debit` for a Plaid-linked bank.","example":"solana","isRequired":true,"uniqueKey":"transfer_type","typeLabel":"string"},"value_type":{"type":"string","description":"Token ticker for wallets (for example, `SBC`), or `USD` for a Plaid-linked bank.","example":"SBC","isRequired":true,"uniqueKey":"value_type","typeLabel":"string"}},"required":["address","balance","value_type","transfer_type"],"example":{"address":{"id":"2VcUIIsgARwVbEGlIYbhg6fGG57","address":"73uyt9HkEqx9bThYXWaUBP67sWsiJEsyJ5rSCieDx5me"},"balance":{"value":"100.00","currency":"SBC"},"transfer_type":"solana","value_type":"SBC"},"uniqueKey":"","typeLabel":"AddressBalance · object"},"examples":{"wallet":{"title":"wallet","value":{"address":{"id":"2VcUIIsgARwVbEGlIYbhg6fGG57","address":"73uyt9HkEqx9bThYXWaUBP67sWsiJEsyJ5rSCieDx5me"},"balance":{"value":"100.00","currency":"SBC"},"transfer_type":"solana","value_type":"SBC"}},"plaid_bank":{"title":"plaid_bank","value":{"address":{"id":"34yknnMShvDbSW6tQg4HLlN41QO","address":null,"account_number":"****1234"},"balance":{"value":"1250.42","currency":"USD"},"value_type":"USD","transfer_type":"ach_debit"}}},"exampleType":"examples"}},"exampleType":"examples"},"ee37bc54-a632-4fa3-8cd9-459368ebcc6c":{"description":"Bad request. Possible `type` values:\n- `invalid_address` — a bank balance request did not use\n `transfer_type=ach_debit`.\n\n- `invalid_value_type` — a bank balance request did not use\n `value_type=USD`.\n\n- `balance_not_supported_for_address` — the address is not\n Plaid-linked, or the currency is not supported.\n\n- `plaid_error` with `code: plaid_item_login_required` — the\n Plaid connection needs to be re-authenticated. Have the user\n relink the bank account through Plaid.\n","content":{"application/json":{"schema":{"type":"object","title":"ErrorResponse","description":"Standard Brale error envelope.","required":["type"],"properties":{"type":{"type":"string","description":"Machine-readable error type identifier.","example":"unsupported_account_combination","isRequired":true,"uniqueKey":"type","typeLabel":"string"},"message":{"type":"string","description":"Human-readable explanation of the error.","example":"The combination of entity_type, account_type, and verification_mode is not supported.","uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","description":"Provider-specific error code. Present on `plaid_error`.","example":"plaid_item_login_required","uniqueKey":"code","typeLabel":"string"}},"uniqueKey":"","typeLabel":"ErrorResponse · object"},"examples":{"plaid_item_login_required":{"title":"plaid_item_login_required","value":{"type":"plaid_error","code":"plaid_item_login_required"}},"balance_not_supported_for_address":{"title":"balance_not_supported_for_address","value":{"type":"balance_not_supported_for_address"}}},"exampleType":"examples"}},"exampleType":"examples"},"b22d2120-9751-425e-82e5-c1c793fcc36f":{"description":"`service_unavailable` — Plaid returned an error or balance data is unavailable. This does not mean the balance is zero or insufficient.\n","content":{"application/json":{"schema":{"type":"object","title":"ErrorResponse","description":"Standard Brale error envelope.","required":["type"],"properties":{"type":{"type":"string","description":"Machine-readable error type identifier.","example":"unsupported_account_combination","isRequired":true,"uniqueKey":"type","typeLabel":"string"},"message":{"type":"string","description":"Human-readable explanation of the error.","example":"The combination of entity_type, account_type, and verification_mode is not supported.","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"ErrorResponse · object"},"example":{"type":"service_unavailable"},"examples":{"Example":{"title":"Example","value":{"type":"service_unavailable"}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"c1af3ab6-45cc-44b8-9619-f12174d44816":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Use the Bearer token returned from the Auth endpoint via OAuth2 client_credentials flow. Include the token in the \"Authorization: Bearer \u003ctoken>\" header.\n","scopes":[],"schemeName":"BearerAuth"}}},"servers":{"d90858c1-e971-4f58-9495-890ae9e516f2":{"url":"https://api.brale.xyz","description":"Production server"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Use the Bearer token returned from the Auth endpoint via OAuth2 client_credentials flow. Include the token in the \"Authorization: Bearer \u003ctoken>\" header.\n","scopes":[],"schemeName":"BearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Use the Bearer token returned from the Auth endpoint via OAuth2 client_credentials flow. Include the token in the \"Authorization: Bearer \u003ctoken>\" header.\n","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"BearerAuth","name":"Authorization"}],"title":"BearerAuth"}]},"originalFileLocation":"api-reference/brale-openapi.yaml"},"subdomain":"brale","siteName":"Brale","title":"Get an address balance - Brale","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-28T16:22:48.699Z","originalFileLocation":"api-reference/brale/get-address-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=\"Returns the balance of a custodial wallet address or a Plaid-linked bank address. Provide transfer_type and value_type as query parameters.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Brale\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/brale/fNz744YuLs689rFY/_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/brale/fNz744YuLs689rFY/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/brale/fNz744YuLs689rFY/_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/brale/fNz744YuLs689rFY/_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/brale/fNz744YuLs689rFY/_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/brale/fNz744YuLs689rFY/_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/brale/fNz744YuLs689rFY/_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/brale/fNz744YuLs689rFY/_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/brale/fNz744YuLs689rFY/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get an address balance - Brale\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns the balance of a custodial wallet address or a Plaid-linked bank address. Provide transfer_type and value_type as query parameters.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Brale\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.brale.xyz/api-reference/brale/get-address-balance\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://brale.mintlify.app/_mintlify/api/og/v2?division=Addresses\u0026amp;title=Get+an+address+balance\u0026amp;description=Returns+the+balance+of+a+custodial+wallet+address+or+a+Plaid-linked+bank+address.+Provide+%60transfer_type%60+and+%60value_type%60+as+query+parameters.\u0026amp;theme=f9794a4d42010719ff4d7810\u0026amp;signature=079b4cbd2ccaf288d885f4a865de2103d0ae695e9b1e81feb4c067918c35dcf8\">\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 an address balance - Brale\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns the balance of a custodial wallet address or a Plaid-linked bank address. Provide transfer_type and value_type as query parameters.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://brale.mintlify.app/_mintlify/api/og/v2?division=Addresses\u0026amp;title=Get+an+address+balance\u0026amp;description=Returns+the+balance+of+a+custodial+wallet+address+or+a+Plaid-linked+bank+address.+Provide+%60transfer_type%60+and+%60value_type%60+as+query+parameters.\u0026amp;theme=f9794a4d42010719ff4d7810\u0026amp;signature=079b4cbd2ccaf288d885f4a865de2103d0ae695e9b1e81feb4c067918c35dcf8\">\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/brale/fNz744YuLs689rFY/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Brale\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#000000\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.brale.xyz/api-reference/brale/get-address-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/brale/get-address-balance.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.brale.xyz/#organization\",\"name\":\"Brale\",\"url\":\"https://docs.brale.xyz\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/brale/8ZhoPWIKA3trPz7_/images/brale/brale-logo-light.svg?fit=max\u0026auto=format\u0026n=8ZhoPWIKA3trPz7_\u0026q=85\u0026s=9d75182cc1a672349f431ab9462b2b14\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.brale.xyz#website\",\"name\":\"Brale\",\"url\":\"https://docs.brale.xyz\",\"publisher\":{\"@id\":\"https://docs.brale.xyz/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.brale.xyz/api-reference/brale/get-address-balance#webpage\",\"url\":\"https://docs.brale.xyz/api-reference/brale/get-address-balance\",\"name\":\"Get an address balance\",\"description\":\"Returns the balance of a custodial wallet address or a Plaid-linked bank address. Provide transfer_type and value_type as query parameters.\",\"dateModified\":\"2026-09-28T16:22:48.699Z\",\"isPartOf\":{\"@id\":\"https://docs.brale.xyz#website\"},\"breadcrumb\":{\"@id\":\"https://docs.brale.xyz/api-reference/brale/get-address-balance#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.brale.xyz/api-reference/brale/get-address-balance#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Addresses\",\"item\":\"https://docs.brale.xyz/api-reference/brale/list-addresses\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get an address balance\",\"item\":\"https://docs.brale.xyz/api-reference/brale/get-address-balance\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.brale.xyz/api-reference/brale/get-address-balance#apireference\",\"headline\":\"Get an address balance\",\"name\":\"Get an address balance\",\"description\":\"Returns the balance of a custodial wallet address or a Plaid-linked bank address. Provide transfer_type and value_type as query parameters.\",\"url\":\"https://docs.brale.xyz/api-reference/brale/get-address-balance\",\"mainEntityOfPage\":{\"@id\":\"https://docs.brale.xyz/api-reference/brale/get-address-balance#webpage\"},\"dateModified\":\"2026-09-28T16:22:48.699Z\",\"publisher\":{\"@id\":\"https://docs.brale.xyz/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.brale.xyz#website\"}}]}\u003c/script>","siteName":"Brale","nav":{"global":{"anchors":[{"anchor":"API Keys","icon":"key","href":"https://app.brale.xyz"},{"anchor":"API Logs","icon":"database","href":"https://app.brale.xyz/api?tab=activity"},{"anchor":"Changelog","icon":"clock-rotate-left","href":"/changelog"}]},"tabs":[{"tab":"Information","pages":[{"title":"Information","href":"/documentation/introduction"}]},{"tab":"Tools","pages":[{"title":"Tools","href":"/documentation/commons-stablecoin-format"}]},{"tab":"API Docs","pages":[{"title":"API Docs","href":"/overview/introduction"}]},{"tab":"Guides","pages":[{"title":"Guides","href":"/guides/how-to/get-your-account-id"}]},{"tab":"API reference","groups":[{"group":"API overview","pages":[{"title":"Brale Issuance and Orchestration API","href":"/api-reference/brale-introduction"}]},{"group":"Accounts","pages":[{"title":"Retrieve all accounts","openapi":"GET /accounts","href":"/api-reference/brale/list-accounts"},{"title":"Create a customer account","openapi":"POST /accounts","href":"/api-reference/brale/create-account"},{"title":"Retrieve a customer account","openapi":"GET /accounts/{account_id}","href":"/api-reference/brale/get-account"},{"title":"Stage a Verification Document","openapi":"POST /documents","href":"/api-reference/brale/stage-verification-document"},{"title":"List Verification Documents","openapi":"GET /accounts/{account_id}/verification/documents","href":"/api-reference/brale/list-verification-documents"},{"title":"Link Verification Documents","openapi":"PATCH /accounts/{account_id}","href":"/api-reference/brale/link-verification-documents"}]},{"group":"Addresses","pages":[{"title":"Fetch all addresses","openapi":"GET /accounts/{account_id}/addresses","href":"/api-reference/brale/list-addresses"},{"title":"Retrieve an address","openapi":"GET /accounts/{account_id}/addresses/{address_id}","href":"/api-reference/brale/get-address"},{"title":"Create a new external address","openapi":"POST /accounts/{account_id}/addresses/external","href":"/api-reference/brale/create-address"},{"title":"Create a new internal address","openapi":"POST /accounts/{account_id}/addresses/internal","href":"/api-reference/brale/create-internal-address"},{"title":"Update an Address","description":"Update the name, status, or transfer types for an existing address.","openapi":"PATCH /accounts/{account_id}/addresses/{address_id}","href":"/api-reference/brale/update-address"},{"title":"Get an address balance","openapi":"GET /accounts/{account_id}/addresses/{address_id}/balance","href":"/api-reference/brale/get-address-balance"}]},{"group":"Automations","pages":[{"title":"Fetch all automations for an account","description":"Retrieves all automations associated with the specified customer account.","openapi":"GET /accounts/{account_id}/automations","href":"/api-reference/brale/list-automations"},{"title":"Create an Automation","openapi":"POST /accounts/{account_id}/automations","href":"/api-reference/brale/create-automations"},{"title":"Retrieve a single automation","openapi":"GET /accounts/{account_id}/automations/{id}","href":"/api-reference/brale/get-automations"},{"title":"Archive an Automation","openapi":"PATCH /accounts/{account_id}/automations/{automation_id}","href":"/api-reference/brale/archive-automation"},{"title":"Simulate an Automation deposit","openapi":"api-reference/brale-openapi.yaml POST /accounts/{account_id}/automations/{automation_id}/simulations/deposits","href":"/api-reference/brale/simulate-automation-deposit"}]},{"group":"Transfers","pages":[{"title":"List transfers","sidebarTitle":"List transfers","openapi":"GET /accounts/{account_id}/transfers","href":"/api-reference/brale/list-transfers"},{"title":"Create a new transfer","openapi":"POST /accounts/{account_id}/transfers","href":"/api-reference/brale/create-transfer"},{"title":"Retrieve a single transfer","openapi":"GET /accounts/{account_id}/transfers/{id}","href":"/api-reference/brale/get-transfer"}]},{"group":"Financial institutions","pages":[{"title":"Fetch all financial institutions","openapi":"GET /accounts/{account_id}/financial-institutions","href":"/api-reference/brale/list-financial-institutions"},{"title":"Create a new external financial institution","openapi":"POST /accounts/{account_id}/financial-institutions/external","href":"/api-reference/brale/create-financial-institution"},{"title":"Fetch a specific financial institution","openapi":"GET /accounts/{account_id}/financial-institutions/{id}","href":"/api-reference/brale/get-financial-institution"},{"title":"Create Plaid link token","openapi":"POST /accounts/{account_id}/plaid/link_token","href":"/api-reference/brale/create-plaid-link-token"},{"title":"Register financial institution account via Plaid and return address ID","openapi":"POST /accounts/{account_id}/plaid/register-account","href":"/api-reference/brale/register-financial-institution-account-via-plaid-and-return-address-id"}]},{"group":"Webhooks","pages":[{"title":"List Webhook Event Types","openapi":"GET /accounts/{account_id}/webhooks/event_types","href":"/api-reference/brale/list-webhook-event-types"},{"title":"Create Webhook Subscription","openapi":"POST /accounts/{account_id}/webhooks","href":"/api-reference/brale/create-webhook-subscription"},{"title":"List Webhook Subscriptions","openapi":"GET /accounts/{account_id}/webhooks","href":"/api-reference/brale/list-webhook-subscriptions"},{"title":"Get Webhook Subscription","openapi":"GET /accounts/{account_id}/webhooks/{subscription_id}","href":"/api-reference/brale/get-webhook-subscription"},{"title":"Update Webhook Subscription","openapi":"PATCH /accounts/{account_id}/webhooks/subscriptions/{subscription_id}","href":"/api-reference/brale/update-webhook-subscription"},{"title":"Archive Webhook Subscription","openapi":"DELETE /accounts/{account_id}/webhooks/subscriptions/{subscription_id}","href":"/api-reference/brale/archive-webhook-subscription"},{"title":"List Webhook Delivery Attempts","openapi":"GET /accounts/{account_id}/webhooks/deliveries","href":"/api-reference/brale/list-webhook-delivery-attempts"}]},{"group":"Tokenization","pages":[{"title":"Create Token Mint","openapi":"POST /accounts/{account_id}/tokens/mints","href":"/api-reference/brale/create-token-mint"},{"title":"List Token Mints","openapi":"GET /accounts/{account_id}/tokens/mints","href":"/api-reference/brale/list-token-mints"},{"title":"Get Token Mint","openapi":"GET /accounts/{account_id}/tokens/mints/{mint_id}","href":"/api-reference/brale/get-token-mint"},{"title":"Create Token Burn","openapi":"POST /accounts/{account_id}/tokens/burns","href":"/api-reference/brale/create-token-burn"},{"title":"List Token Burns","openapi":"GET /accounts/{account_id}/tokens/burns","href":"/api-reference/brale/list-token-burns"},{"title":"Get Token Burn","openapi":"GET /accounts/{account_id}/tokens/burns/{burn_id}","href":"/api-reference/brale/get-token-burn"},{"title":"Create Token Transfer","openapi":"POST /accounts/{account_id}/tokens/transfers","href":"/api-reference/brale/create-token-transfer"},{"title":"List Token Transfers","openapi":"GET /accounts/{account_id}/tokens/transfers","href":"/api-reference/brale/list-token-transfers"},{"title":"Get Token Transfer","openapi":"GET /accounts/{account_id}/tokens/transfers/{transfer_id}","href":"/api-reference/brale/get-token-transfer"}]}]},{"tab":"Brale Status","href":"https://status.brale.xyz"}]},"title":"Get an address balance - Brale","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"]}