This endpoint returns your current account balance and credit information. Use it to check available credits before launching expensive scraping operations or to monitor your spending.It’s recommended to check your balance before starting large-scale data collection tasks to ensure you have sufficient credits.
Outstanding unpaid invoice info. Empty object ({}) when there is no unpaid bill — despite the name, this is not a boolean. When a bill is outstanding it carries status (boolean) and created_on (Unix timestamp). Example: {"status": true, "created_on": 1777545119}
Timestamp when credits will next reset. Example: "2025-02-01T00:00:00Z"
Check your balance before launching expensive operations to avoid running out of credits mid-task. Large scraping jobs can consume significant credits.
Balance information is updated in real-time. Each successful API response reflects your current credit balance.
If your balance reaches zero, ongoing operations will be paused until you add more credits. Plan ahead to avoid service interruptions.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"lobstr.io","colors":{"primary":"#ff0000","light":"#ff3333","dark":"#cc0000"},"logo":{"light":"https://mintcdn.com/lobstrio-1abc571c/DC4W-U36rZa-JMtR/logo/light.svg?fit=max\u0026auto=format\u0026n=DC4W-U36rZa-JMtR\u0026q=85\u0026s=57f8a1cecd8d7769fa2a89b10a92e3d3","dark":"https://mintcdn.com/lobstrio-1abc571c/DC4W-U36rZa-JMtR/logo/dark.svg?fit=max\u0026auto=format\u0026n=DC4W-U36rZa-JMtR\u0026q=85\u0026s=45241588af9c1e3237e448279a993681"},"favicon":"https://mintcdn.com/lobstrio-1abc571c/to9RtopRArtv238L/favicon.svg?fit=max\u0026auto=format\u0026n=to9RtopRArtv238L\u0026q=85\u0026s=a8baa387944aae029967a070d3815fd3","api":{"mdx":{"auth":{"method":"bearer"},"server":"https://api.lobstr.io"}},"navbar":{"links":[{"href":"https://www.lobstr.io","label":"lobstr.io"}],"primary":{"type":"button","label":"Get Started","href":"https://app.lobstr.io"}},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"lobstrio-1abc571c","hasAudioNarration":false,"actualSubdomain":"lobstrio-1abc571c","customDomains":["docs.lobstr.io"],"gitSource":{"type":"github","owner":"lobstrio","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae09e9aa121a5eeefc698be","collectionId":"0cd4da48-9bb2-4c24-8b28-89387a666179","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae09e9aa121a5eeefc698be"},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ae09e9aa121a5eeefc698be","clientVersion":"0.0.4006","searchFilterCounts":[{"language":"default","tag":"Examples","count":329},{"language":"default","tag":"API Reference","count":60},{"language":"default","tag":"Changelog","count":34},{"language":"default","tag":"2026","count":33},{"language":"default","tag":"Run","count":10},{"language":"default","tag":"Squid","count":10},{"language":"default","tag":"Account","count":9},{"language":"default","tag":"Developer Tools","count":8},{"language":"default","tag":"Google Maps Leads Scraper","count":7},{"language":"default","tag":"Task","count":6}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"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":"docs/get-balance","slug":"/docs/get-balance","pageMetadata":{"title":"Get Balance","description":"Check your account balance and available credits before launching operations","api":"GET https://api.lobstr.io/v1/user/balance","href":"/docs/get-balance"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Check your account balance and available credits before launching operations\"\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`,p:`p`,pre:`pre`,span:`span`,..._provideComponents(),...props.components},{CodeBlock,CodeGroup,Heading,Note,ParamField,ResponseField,Tip,Warning}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!CodeGroup)_missingMdxReference(`CodeGroup`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!ParamField)_missingMdxReference(`ParamField`,true);if(!ResponseField)_missingMdxReference(`ResponseField`,true);if(!Tip)_missingMdxReference(`Tip`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`This endpoint returns your current account balance and credit information. Use it to check available credits before launching expensive scraping operations or to monitor your spending.`}),`\n`,_jsx(_components.p,{children:`It’s recommended to check your balance before starting large-scale data collection tasks to ensure you have sufficient credits.`}),`\n`,_jsx(Heading,{level:`2`,id:`headers`,children:`Headers`}),`\n`,_jsx(ParamField,{header:`Authorization`,type:`string`,required:true,id:`param-authorization`,children:_jsxs(_components.p,{children:[`Your API authentication token. Value: `,_jsx(_components.code,{children:`Token YOUR_API_KEY`})]})}),`\n`,_jsx(ParamField,{header:`Content-Type`,type:`string`,default:`application/json`,id:`param-content-type`,children:_jsxs(_components.p,{children:[`Content type of the request. Value: `,_jsx(_components.code,{children:`application/json`})]})}),`\n`,_jsx(Heading,{level:`2`,id:`response-field-explanations`,children:`Response Field Explanations`}),`\n`,_jsx(ResponseField,{name:`id`,type:`string`,id:`param-id`,children:_jsxs(_components.p,{children:[`The plan’s price identifier. Example: `,_jsx(_components.code,{children:`\"price_abc123\"`})]})}),`\n`,_jsx(ResponseField,{name:`object`,type:`string`,id:`param-object`,children:_jsxs(_components.p,{children:[`Always `,_jsx(_components.code,{children:`\"plan\"`}),`.`]})}),`\n`,_jsx(ResponseField,{name:`name`,type:`string`,id:`param-name`,children:_jsxs(_components.p,{children:[`Name of the active subscription plan. Example: `,_jsx(_components.code,{children:`\"Professional\"`})]})}),`\n`,_jsx(ResponseField,{name:`available`,type:`integer`,id:`param-available`,children:_jsxs(_components.p,{children:[`Total credits on the plan (including bonus). For daily-interval plans, this is the daily allowance. Example: `,_jsx(_components.code,{children:`10000`})]})}),`\n`,_jsx(ResponseField,{name:`consumed`,type:`integer`,id:`param-consumed`,children:_jsxs(_components.p,{children:[`Credits consumed in the current billing period. Example: `,_jsx(_components.code,{children:`1550`})]})}),`\n`,_jsx(ResponseField,{name:`bonus_credit`,type:`integer`,id:`param-bonus-credit`,children:_jsxs(_components.p,{children:[`Bonus credits applied to the account. Example: `,_jsx(_components.code,{children:`0`})]})}),`\n`,_jsx(ResponseField,{name:`rollover_credit`,type:`integer`,id:`param-rollover-credit`,children:_jsxs(_components.p,{children:[`Unused credits rolled over from a previous period. Example: `,_jsx(_components.code,{children:`200`})]})}),`\n`,_jsx(ResponseField,{name:`rollover_credit_expires_at`,type:`string | null`,id:`param-rollover-credit-expires-at`,children:_jsxs(_components.p,{children:[`Timestamp when rollover credits expire, or `,_jsx(_components.code,{children:`null`}),` if none. Example: `,_jsx(_components.code,{children:`null`})]})}),`\n`,_jsx(ResponseField,{name:`community_reward_credit`,type:`integer`,id:`param-community-reward-credit`,children:_jsxs(_components.p,{children:[`Bonus credits earned through Community Story Rewards. Example: `,_jsx(_components.code,{children:`500`})]})}),`\n`,_jsx(ResponseField,{name:`community_reward_credit_expires_at`,type:`string | null`,id:`param-community-reward-credit-expires-at`,children:_jsxs(_components.p,{children:[`Timestamp when community reward credits expire, or `,_jsx(_components.code,{children:`null`}),` if none. Example: `,_jsx(_components.code,{children:`null`})]})}),`\n`,_jsx(ResponseField,{name:`interval`,type:`string`,id:`param-interval`,children:_jsxs(_components.p,{children:[`Credit reset interval (`,_jsx(_components.code,{children:`\"monthly\"`}),` or `,_jsx(_components.code,{children:`\"daily\"`}),`). Example: `,_jsx(_components.code,{children:`\"monthly\"`})]})}),`\n`,_jsx(ResponseField,{name:`used_slots`,type:`integer`,id:`param-used-slots`,children:_jsxs(_components.p,{children:[`Number of concurrency slots currently in use. Example: `,_jsx(_components.code,{children:`3`})]})}),`\n`,_jsx(ResponseField,{name:`total_available_slots`,type:`integer`,id:`param-total-available-slots`,children:_jsxs(_components.p,{children:[`Total concurrency slots available on the plan. Example: `,_jsx(_components.code,{children:`20`})]})}),`\n`,_jsx(ResponseField,{name:`export_cap_lifted_until`,type:`string | null`,id:`param-export-cap-lifted-until`,children:_jsxs(_components.p,{children:[`Timestamp until which the account’s export cap is lifted, or `,_jsx(_components.code,{children:`null`}),` when no lift is active. Example: `,_jsx(_components.code,{children:`null`})]})}),`\n`,_jsx(ResponseField,{name:`has_unpaid_bill`,type:`object`,id:`param-has-unpaid-bill`,children:_jsxs(_components.p,{children:[`Outstanding unpaid invoice info. Empty object (`,_jsx(_components.code,{children:`{}`}),`) when there is no unpaid bill — despite the name, this is not a boolean. When a bill is outstanding it carries `,_jsx(_components.code,{children:`status`}),` (boolean) and `,_jsx(_components.code,{children:`created_on`}),` (Unix timestamp). Example: `,_jsx(_components.code,{children:`{\"status\": true, \"created_on\": 1777545119}`})]})}),`\n`,_jsx(ResponseField,{name:`reset_time`,type:`string`,id:`param-reset-time`,children:_jsxs(_components.p,{children:[`Timestamp when credits will next reset. Example: `,_jsx(_components.code,{children:`\"2025-02-01T00:00:00Z\"`})]})}),`\n`,_jsx(Tip,{children:_jsx(_components.p,{children:`Check your balance before launching expensive operations to avoid running out of credits mid-task. Large scraping jobs can consume significant credits.`})}),`\n`,_jsx(Note,{children:_jsx(_components.p,{children:`Balance information is updated in real-time. Each successful API response reflects your current credit balance.`})}),`\n`,_jsx(Warning,{children:_jsx(_components.p,{children:`If your balance reaches zero, ongoing operations will be paused until you add more credits. Plan ahead to avoid service interruptions.`})}),`\n`,_jsx(Heading,{level:`2`,id:`code-examples`,children:`Code Examples`}),`\n`,_jsxs(CodeGroup,{children:[_jsx(CodeBlock,{filename:`cURL`,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:` -X`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` GET`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"https://api.lobstr.io/v1/user/balance\"`}),_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:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization: Token YOUR_API_KEY\"`}),_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:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Content-Type: application/json\"`})]}),`\n`]})})}),_jsx(CodeBlock,{filename:`Python`,numberOfLines:`18`,language:`python`,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:`python`,children:_jsxs(_components.code,{language:`python`,numberOfLines:`18`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` requests`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`headers `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Token YOUR_API_KEY\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Content-Type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"application/json\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`response `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` requests.get(`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"https://api.lobstr.io/v1/user/balance\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` headers`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`headers`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`)`})}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`balance_data `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` response.json()`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#DCDCAA`},children:`print`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`f`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Plan: `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`{`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`balance_data[`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'name'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`]`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`}`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`)`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#DCDCAA`},children:`print`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`f`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Total credits: `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`{`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`balance_data[`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'available'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`]`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`}`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`)`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#DCDCAA`},children:`print`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`f`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Consumed: `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`{`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`balance_data[`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'consumed'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`]`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`}`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`)`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#DCDCAA`},children:`print`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`f`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Remaining: `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`{`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`balance_data[`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'available'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`] `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`-`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` balance_data[`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'consumed'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`]`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`}`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`)`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#DCDCAA`},children:`print`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`f`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Slots used: `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`{`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`balance_data[`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'used_slots'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`]`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`}`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` / `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`{`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`balance_data[`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'total_available_slots'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`]`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`}`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`)`})]}),`\n`]})})})]}),`\n`,_jsx(Heading,{level:`2`,id:`response`,children:`Response`}),`\n`,_jsx(CodeBlock,{filename:`200`,numberOfLines:`18`,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:`18`,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:` \"id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"price_abc123\"`}),_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:` \"object\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"plan\"`}),_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:` \"name\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Professional\"`}),_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:` \"available\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`10000`}),_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:` \"consumed\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`1550`}),_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:` \"bonus_credit\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`0`}),_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:` \"rollover_credit\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`200`}),_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:` \"rollover_credit_expires_at\"`}),_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:` \"community_reward_credit\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`500`}),_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:` \"community_reward_credit_expires_at\"`}),_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:` \"export_cap_lifted_until\"`}),_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:` \"interval\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"monthly\"`}),_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:` \"used_slots\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`3`}),_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:` \"total_available_slots\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`20`}),_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:` \"has_unpaid_bill\"`}),_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:` \"reset_time\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2025-02-01T00:00:00Z\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})})]})}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 Balance","description":"Check your account balance and available credits before launching operations","api":"GET https://api.lobstr.io/v1/user/balance","href":"/docs/get-balance"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Headers","slug":"headers","depth":2,"children":[]},{"title":"Response Field Explanations","slug":"response-field-explanations","depth":2,"children":[]},{"title":"Code Examples","slug":"code-examples","depth":2,"children":[]},{"title":"Response","slug":"response","depth":2,"children":[]}],"codeExamples":{},"endpoint":{"title":"Get Balance","path":"/v1/user/balance","servers":[{"url":"https://api.lobstr.io"}],"method":"get","request":{"security":[{"title":"Bearer Auth","parameters":{"header":{"Authorization":{"type":"http","scheme":"bearer","description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token."}},"query":{},"cookie":{}}}],"parameters":{"query":{},"header":{"Authorization":{"schema":[{"type":"string","description":"Your API authentication token. Value: `Token YOUR_API_KEY`","required":true}]},"Content-Type":{"schema":[{"type":"string","description":"Content type of the request. Value: `application/json`"}]}},"cookie":{},"path":{}},"body":{}},"response":{"200":{"application/json":{"schemaArray":[{"type":"object","properties":{"id":[{"type":"string","description":"The plan’s price identifier. Example: `\"price_abc123\"`"}],"object":[{"type":"string","description":"Always `\"plan\"` ."}],"name":[{"type":"string","description":"Name of the active subscription plan. Example: `\"Professional\"`"}],"available":[{"type":"integer","description":"Total credits on the plan (including bonus). For daily-interval plans, this is the daily allowance. Example: `10000`"}],"consumed":[{"type":"integer","description":"Credits consumed in the current billing period. Example: `1550`"}],"bonus_credit":[{"type":"integer","description":"Bonus credits applied to the account. Example: `0`"}],"rollover_credit":[{"type":"integer","description":"Unused credits rolled over from a previous period. Example: `200`"}],"rollover_credit_expires_at":[{"type":"object","properties":{},"description":"Timestamp when rollover credits expire, or `null` if none. Example: `null`"}],"community_reward_credit":[{"type":"integer","description":"Bonus credits earned through Community Story Rewards. Example: `500`"}],"community_reward_credit_expires_at":[{"type":"object","properties":{},"description":"Timestamp when community reward credits expire, or `null` if none. Example: `null`"}],"interval":[{"type":"string","description":"Credit reset interval ( `\"monthly\"` or `\"daily\"` ). Example: `\"monthly\"`"}],"used_slots":[{"type":"integer","description":"Number of concurrency slots currently in use. Example: `3`"}],"total_available_slots":[{"type":"integer","description":"Total concurrency slots available on the plan. Example: `20`"}],"export_cap_lifted_until":[{"type":"object","properties":{},"description":"Timestamp until which the account’s export cap is lifted, or `null` when no lift is active. Example: `null`"}],"has_unpaid_bill":[{"type":"object","properties":{},"description":"Outstanding unpaid invoice info. Empty object ( `{}` ) when there is no unpaid bill — despite the name, this is not a boolean. When a bill is outstanding it carries `status` (boolean) and `created_on` (Unix timestamp). Example: `{\"status\": true, \"created_on\": 1777545119}`"}],"reset_time":[{"type":"string","description":"Timestamp when credits will next reset. Example: `\"2025-02-01T00:00:00Z\"`"}]}}],"examples":{"example":{"value":{"id":"\u003cstring>","object":"\u003cstring>","name":"\u003cstring>","available":123,"consumed":123,"bonus_credit":123,"rollover_credit":123,"rollover_credit_expires_at":{},"community_reward_credit":123,"community_reward_credit_expires_at":{},"interval":"\u003cstring>","used_slots":123,"total_available_slots":123,"export_cap_lifted_until":{},"has_unpaid_bill":{},"reset_time":"\u003cstring>"}}}}}},"deprecated":false}},"jsLinks":[],"subdomain":"lobstrio-1abc571c","siteName":"lobstr.io","title":"Get Balance - lobstr.io","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-22T13:51:48.378Z","originalFileLocation":"docs/get-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=\"Check your account balance and available credits before launching operations\">\u003cmeta data-mint-head name=\"application-name\" content=\"lobstr.io\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/lobstrio-1abc571c/QoUCw7MJzBACafij/_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/lobstrio-1abc571c/QoUCw7MJzBACafij/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/lobstrio-1abc571c/QoUCw7MJzBACafij/_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/lobstrio-1abc571c/QoUCw7MJzBACafij/_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/lobstrio-1abc571c/QoUCw7MJzBACafij/_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/lobstrio-1abc571c/QoUCw7MJzBACafij/_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/lobstrio-1abc571c/QoUCw7MJzBACafij/_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/lobstrio-1abc571c/QoUCw7MJzBACafij/_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/lobstrio-1abc571c/QoUCw7MJzBACafij/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get Balance - lobstr.io\">\u003cmeta data-mint-head property=\"og:description\" content=\"Check your account balance and available credits before launching operations\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"lobstr.io\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.lobstr.io/docs/get-balance\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://lobstrio-1abc571c.mintlify.app/_mintlify/api/og/v2?division=User\u0026amp;title=Get+Balance\u0026amp;description=Check+your+account+balance+and+available+credits+before+launching+operations\u0026amp;theme=8ea60e66a94c321fc923be1d\u0026amp;signature=06dd33d26199f4245fc21293de98e940ff5529ac7a8301aa4824fe5b80d684e4\">\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 Balance - lobstr.io\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Check your account balance and available credits before launching operations\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://lobstrio-1abc571c.mintlify.app/_mintlify/api/og/v2?division=User\u0026amp;title=Get+Balance\u0026amp;description=Check+your+account+balance+and+available+credits+before+launching+operations\u0026amp;theme=8ea60e66a94c321fc923be1d\u0026amp;signature=06dd33d26199f4245fc21293de98e940ff5529ac7a8301aa4824fe5b80d684e4\">\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/lobstrio-1abc571c/QoUCw7MJzBACafij/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"lobstr.io\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#ff0000\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.lobstr.io/docs/get-balance\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/get-balance.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.lobstr.io/#organization\",\"name\":\"lobstr.io\",\"url\":\"https://docs.lobstr.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/lobstrio-1abc571c/DC4W-U36rZa-JMtR/logo/light.svg?fit=max\u0026auto=format\u0026n=DC4W-U36rZa-JMtR\u0026q=85\u0026s=57f8a1cecd8d7769fa2a89b10a92e3d3\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.lobstr.io#website\",\"name\":\"lobstr.io\",\"url\":\"https://docs.lobstr.io\",\"publisher\":{\"@id\":\"https://docs.lobstr.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.lobstr.io/docs/get-balance#webpage\",\"url\":\"https://docs.lobstr.io/docs/get-balance\",\"name\":\"Get Balance\",\"description\":\"Check your account balance and available credits before launching operations\",\"dateModified\":\"2026-09-22T13:51:48.378Z\",\"isPartOf\":{\"@id\":\"https://docs.lobstr.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.lobstr.io/docs/get-balance#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.lobstr.io/docs/get-balance#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"User\",\"item\":\"https://docs.lobstr.io/docs/user-me\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get Balance\",\"item\":\"https://docs.lobstr.io/docs/get-balance\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.lobstr.io/docs/get-balance#apireference\",\"headline\":\"Get Balance\",\"name\":\"Get Balance\",\"description\":\"Check your account balance and available credits before launching operations\",\"url\":\"https://docs.lobstr.io/docs/get-balance\",\"mainEntityOfPage\":{\"@id\":\"https://docs.lobstr.io/docs/get-balance#webpage\"},\"dateModified\":\"2026-09-22T13:51:48.378Z\",\"publisher\":{\"@id\":\"https://docs.lobstr.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.lobstr.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"lobstr.io\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"lobstr.io","nav":{"global":null,"tabs":[{"tab":"API Reference","groups":[{"group":"Overview","pages":[{"title":"lobstr.io API Documentation","href":""}]},{"group":"Getting Started","pages":[{"title":"Quickstart","href":"/docs/quickstart"},{"title":"Authentication","api":"GET https://api.lobstr.io/v1/me","href":"/docs/authentication"},{"title":"Rate Limiting","href":"/docs/rate-limiting"}]},{"group":"Core Concepts","pages":[{"title":"Concepts","href":"/docs/concepts"},{"title":"Pricing","href":"/docs/pricing"},{"title":"Pagination","href":"/docs/pagination"},{"title":"Errors","href":"/docs/errors"},{"title":"Supported Timezones","href":"/docs/timezones"}]},{"group":"User","pages":[{"title":"Get User Profile","description":"Retrieve authenticated user's profile data including personal details, account status, and subscription information","api":"GET https://api.lobstr.io/v1/me","href":"/docs/user-me"},{"title":"Get Balance","api":"GET https://api.lobstr.io/v1/user/balance","href":"/docs/get-balance"},{"title":"Auto Billing Reset","description":"Configure automatic billing cycle resets when credit usage crosses a threshold","api":"GET https://api.lobstr.io/v1/plans/auto-reset","href":"/docs/auto-billing-reset"},{"title":"Rotate API Key","api":"POST https://api.lobstr.io/v1/me/rotate_token","href":"/docs/rotate-api-key"},{"title":"Community Story Rewards","href":"/docs/community-rewards"}]},{"group":"Crawler","pages":[{"title":"List Crawlers","api":"GET https://api.lobstr.io/v1/crawlers","href":"/docs/list-crawlers"},{"title":"Get Crawler Details","api":"GET https://api.lobstr.io/v1/crawlers/{crawler_hash}","href":"/docs/get-crawler-details"},{"title":"Get Crawler Parameters","api":"GET https://api.lobstr.io/v1/crawlers/{crawler_hash}/params","href":"/docs/get-crawler-parameters"},{"title":"Get Crawler Attributes","api":"GET https://api.lobstr.io/v1/crawlers/{crawler_hash}/attributes","href":"/docs/get-crawler-attributes"}]},{"group":"Squid","pages":[{"title":"Create Squid","api":"POST https://api.lobstr.io/v1/squids","href":"/docs/create-squid"},{"title":"Update Squid","api":"POST https://api.lobstr.io/v1/squids/{squid_hash}","href":"/docs/update-squid"},{"title":"List Squids","api":"GET https://api.lobstr.io/v1/squids","href":"/docs/list-squids"},{"title":"Get Squid Details","api":"GET https://api.lobstr.io/v1/squids/{squid_hash}","href":"/docs/get-squid-details"},{"title":"Empty Squid","api":"POST https://api.lobstr.io/v1/squids/{squid_hash}/empty","href":"/docs/empty-squid"},{"title":"Delete Squid","api":"DELETE https://api.lobstr.io/v1/squids/{squid_hash}","href":"/docs/delete-squid"},{"title":"Configure Squid Chain","api":"POST https://api.lobstr.io/v1/squids/{id}/chain","href":"/docs/configure-squid-chain"},{"title":"Get Squid Chain","api":"GET https://api.lobstr.io/v1/squids/{id}/chain","href":"/docs/get-squid-chain"},{"title":"Update Squid Chain","api":"PATCH https://api.lobstr.io/v1/squids/{id}/chain","href":"/docs/update-squid-chain"},{"title":"Delete Squid Chain","api":"DELETE https://api.lobstr.io/v1/squids/{id}/chain","href":"/docs/delete-squid-chain"}]},{"group":"Delivery","pages":[{"title":"Configure Email Delivery","api":"POST https://api.lobstr.io/v1/delivery?squid={squid_hash}","href":"/docs/configure-email-delivery"},{"title":"Configure SFTP Delivery","api":"POST https://api.lobstr.io/v1/delivery?squid={squid_hash}","href":"/docs/configure-sftp-delivery"},{"title":"Configure Google Sheet Delivery","api":"POST https://api.lobstr.io/v1/delivery?squid={squid_hash}","href":"/docs/configure-google-sheet-delivery"},{"title":"Configure Amazon S3 Delivery","api":"POST https://api.lobstr.io/v1/delivery?squid={squid_hash}","href":"/docs/configure-s3-delivery"},{"title":"Configure Webhook Delivery","api":"POST https://api.lobstr.io/v1/delivery?squid={squid_hash}","href":"/docs/configure-webhook-delivery"},{"title":"Test Delivery Configuration","api":"POST https://api.lobstr.io/v1/delivery/test-webhook","href":"/docs/test-delivery"}]},{"group":"Account","pages":[{"title":"List Accounts","api":"GET https://api.lobstr.io/v1/accounts","href":"/docs/list-accounts"},{"title":"List Account Types","api":"GET https://api.lobstr.io/v1/account_types","href":"/docs/list-account-types"},{"title":"Get Account Details","api":"GET https://api.lobstr.io/v1/accounts/{account_hash}","href":"/docs/get-account-details"},{"title":"Link Account to Squid","api":"POST https://api.lobstr.io/v1/squids/{squid_hash}","href":"/docs/link-account-to-squid"},{"title":"Sync Account","api":"POST https://api.lobstr.io/v1/accounts/cookies","href":"/docs/sync-account"},{"title":"Check Sync Status","api":"GET https://api.lobstr.io/v1/synchronize/{sync_task_id}","href":"/docs/check-sync-status"},{"title":"Update Account Limits","api":"POST https://api.lobstr.io/v1/accounts","href":"/docs/update-account-limits"},{"title":"Refresh Cookies","api":"POST https://api.lobstr.io/v1/accounts/cookies","href":"/docs/refresh-cookies"},{"title":"Delete Account","api":"DELETE https://api.lobstr.io/v1/accounts/{account_hash}","href":"/docs/delete-account"}]},{"group":"Task","pages":[{"title":"Add Tasks","api":"POST https://api.lobstr.io/v1/tasks","href":"/docs/add-tasks"},{"title":"Upload Tasks","api":"POST https://api.lobstr.io/v1/tasks/upload","href":"/docs/upload-tasks"},{"title":"Check Upload Status","api":"GET https://api.lobstr.io/v1/tasks/upload/{upload_task_id}","href":"/docs/check-upload-status"},{"title":"List Tasks","api":"GET https://api.lobstr.io/v1/tasks","href":"/docs/list-tasks"},{"title":"Get Task","api":"GET https://api.lobstr.io/v1/tasks/{task_hash}","href":"/docs/get-task"},{"title":"Delete Task","api":"DELETE https://api.lobstr.io/v1/tasks/{task_hash}","href":"/docs/delete-task"}]},{"group":"Run","pages":[{"title":"Start Run","api":"POST https://api.lobstr.io/v1/runs","href":"/docs/start-run"},{"title":"List Runs","api":"GET https://api.lobstr.io/v1/runs","href":"/docs/list-runs"},{"title":"Get Run","api":"GET https://api.lobstr.io/v1/runs/{run_hash}","href":"/docs/get-run"},{"title":"Get Run Stats","api":"GET https://api.lobstr.io/v1/runs/{run_hash}/stats","href":"/docs/get-run-stats"},{"title":"Get Run Credits","api":"GET https://api.lobstr.io/v1/runs/{run_hash}/credits","href":"/docs/get-run-credits"},{"title":"Get Run Tasks","api":"GET https://api.lobstr.io/v1/runtasks","href":"/docs/get-run-tasks"},{"title":"Retry Run Task","api":"POST https://api.lobstr.io/v1/runs/{run_hash}/tasks/{task_hash}/retry","href":"/docs/retry-run-task"},{"title":"Resurrect Run","api":"POST https://api.lobstr.io/v1/runs/{run_key}/resurrect","href":"/docs/resurrect-run"},{"title":"Abort Run","api":"POST https://api.lobstr.io/v1/runs/{run_hash}/abort","href":"/docs/abort-run"},{"title":"Download Run","api":"GET https://api.lobstr.io/v1/runs/{run_hash}/download","href":"/docs/download-run"}]},{"group":"Result","pages":[{"title":"Get Results","api":"GET https://api.lobstr.io/v1/results","href":"/docs/get-results"}]}]},{"tab":"Examples","pages":[{"title":"Examples","href":"/examples"}]},{"tab":"Developer Tools","pages":[{"title":"Developer Tools","href":"/docs/sdk"}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]}]},"title":"Get Balance - lobstr.io","buildId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","deploymentId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff"],"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"]}