It’s simple to use: you only need to submit your access_key. The API will return the usage statistics for your account.
Requests to this endpoint are not counted against your usage quota, but they are still subject to rate limiting. This ensures fair use and stability of the platform. If you exceed the rate limit, your requests may be temporarily blocked.
The Usage API, like all of ScreenshotMAX’s APIs, is organized around REST. It is designed to use predictable, resource-oriented URL’s and to use HTTP status codes to indicate errors.
Your access key is your unique authentication key to be used to access ScreenshotMAX APIs.
To authenticate your requests, you will need to append your access key to the base URL as a query parameter for GET requests.
For POST requests, you can include your access key in the request body as a JSON object.
You can also use the X-Access-Key header to pass your access key.
You can find your access key in your account dashboard.
Whenever you make a request that fails for some reason, an error is returned also in the JSON format. The errors include an error code and description, which you can find in detail below.
Code
Type
Details
200
OK
The request was successful.
401
Unauthorized
The request was rejected due to an invalid access key.
500
Internal server error
The request failed due to an internal server error.
⌘I
{"docsConfig":{"theme":"willow","$schema":"https://mintlify.com/docs.json","name":"ScreenshotMAX API","description":"ScreenshotMAX API documentation","colors":{"primary":"#3366FF","light":"#AE87FF","dark":"#0D001D"},"logo":{"light":"https://mintcdn.com/screenshotmax/T1xOqe1MKSP6l0-_/logo/logo-light.png?fit=max\u0026auto=format\u0026n=T1xOqe1MKSP6l0-_\u0026q=85\u0026s=4b3619eb6512d1558a324ac0cc879acc","dark":"https://mintcdn.com/screenshotmax/T1xOqe1MKSP6l0-_/logo/logo-dark.png?fit=max\u0026auto=format\u0026n=T1xOqe1MKSP6l0-_\u0026q=85\u0026s=5e1058fb1d06142754e5c92419c338ec","href":"https://screenshotmax.com"},"favicon":"/favicon.svg","navbar":{"links":[{"label":"Home","href":"https://screenshotmax.com"},{"label":"Pricing","href":"https://screenshotmax.com/pricing"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.screenshotmax.com"}},"footer":{"socials":{"website":"https://screenshotmax.com","github":"https://github.com/screenshotmax"}},"seo":{"indexing":"all"},"styling":{"eyebrows":"section"},"integrations":{"gtm":{"tagId":"GTM-WX7ZQHCM"}},"contextual":{"options":["chatgpt"]},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"screenshotmax","hasAudioNarration":false,"actualSubdomain":"screenshotmax","customDomains":["docs.screenshotmax.com"],"gitSource":{"type":"github","owner":"hellobertrand","repo":"getstore-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a21e6af044dd579e9b57e2c","collectionId":"a05d77eb-5a97-43eb-ac45-b6fb6c931932","schemaVersion":"v2"},"entitlements":{},"buildId":"6a21e6af044dd579e9b57e2c:success","clientVersion":"0.0.4043","searchFilterCounts":[{"language":"default","tag":"Guides","count":19},{"language":"default","tag":"API Reference","count":15},{"language":"default","tag":"Getting Started","count":10},{"language":"default","tag":"Scheduled Tasks","count":5},{"language":"default","tag":"SDKs and Code Samples","count":5},{"language":"default","tag":"References","count":4},{"language":"default","tag":"Others","count":2},{"language":"default","tag":"Pdf","count":2},{"language":"default","tag":"Scrape","count":2},{"language":"default","tag":"Animated Screenshot","count":2}]},"assistantConfig":{},"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":"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":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[],"page":{"pagePath":"endpoints/usage","slug":"/endpoints/usage","pageMetadata":{"title":"Usage","api":"GET https://api.screenshotmax.com/v1/usage","description":"Get usage statistics for your account.","href":"/endpoints/usage"},"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: \"Get usage statistics for your account.\"\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={a:`a`,code:`code`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{CodeBlock,Expandable,Heading,Note,ParamField,ResponseField,Table}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Expandable)_missingMdxReference(`Expandable`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!ParamField)_missingMdxReference(`ParamField`,true);if(!ResponseField)_missingMdxReference(`ResponseField`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`It’s simple to use: you only need to submit your `,_jsx(_components.code,{children:`access_key`}),`. The API will return the usage statistics for your account.`]}),`\n`,_jsxs(Note,{children:[`Requests to this endpoint are `,_jsx(_components.strong,{children:`not counted against your usage quota,`}),` but they are `,_jsx(_components.strong,{children:`still subject to rate limiting.`}),` This ensures fair use and stability of the platform. If you exceed the rate limit, your requests may be temporarily blocked.`]}),`\n`,_jsx(Heading,{level:`2`,id:`getting-started`,children:`Getting started`}),`\n`,_jsx(Heading,{level:`3`,id:`rest`,children:`REST`}),`\n`,_jsx(_components.p,{children:`The Usage API, like all of ScreenshotMAX’s APIs, is organized around REST. It is designed to use predictable, resource-oriented URL’s and to use HTTP status codes to indicate errors.`}),`\n`,_jsx(Heading,{level:`3`,id:`https`,children:`HTTPS`}),`\n`,_jsx(_components.p,{children:`The Usage API requires all communications to be secured TLS 1.2 or greater.`}),`\n`,_jsx(Heading,{level:`3`,id:`api-versions`,children:`API Versions`}),`\n`,_jsx(_components.p,{children:`All of ScreenshotMAX’s APIs are versioned. The Usage API is currently on Version 1.`}),`\n`,_jsx(Heading,{level:`3`,id:`your-access-key`,children:`Your Access Key`}),`\n`,_jsxs(_components.p,{children:[`Your access key is your unique authentication key to be used to access ScreenshotMAX APIs.\nTo authenticate your requests, you will need to append your access key to the base URL as a query parameter for GET requests.\nFor POST requests, you can include your access key in the request body as a JSON object.\nYou can also use the `,_jsx(_components.code,{children:`X-Access-Key`}),` header to pass your access key.\nYou can find your access key in your `,_jsx(_components.a,{href:`https://app.screenshotmax.com/access`,children:`account dashboard`}),`.`]}),`\n`,_jsx(Heading,{level:`3`,id:`base-url`,children:`Base URL`}),`\n`,_jsx(CodeBlock,{numberOfLines:`2`,language:`text`,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:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`https://api.screenshotmax.com/v1/usage`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsx(Heading,{level:`3`,id:`validation-endpoint`,children:`Validation endpoint`}),`\n`,_jsx(_components.p,{children:`ScreenshotMAX’s Usage API simply requires your unique access key. The API will return usage statistics for your account.`}),`\n`,_jsx(CodeBlock,{numberOfLines:`3`,language:`text`,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:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`3`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`https://api.screenshotmax.com/v1/usage`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`? access_key=YOUR_ACCESS_KEY`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsx(_components.p,{children:`This was a successful request, so the API returned a 200 OK response with the usage statistics for your account.`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`12`,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:`12`,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:` \"hits\"`}),_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:` \"quota\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`1000`}),_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\"`}),_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:` \"remaining\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`500`})]}),`\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:` \"concurrency\"`}),_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:` \"limit\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`100`}),_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:` \"remaining\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`50`}),_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\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`1633036868`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_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`]})})}),`\n`,_jsx(Heading,{level:`3`,id:`request-parameters`,children:`Request parameters`}),`\n`,_jsx(ParamField,{query:`access_key`,type:`string`,required:true,id:`param-access-key`,children:_jsxs(_components.p,{children:[`Your unique access key. You can find your access key in your `,_jsx(_components.a,{href:`https://app.screenshotmax.com/access`,children:`account dashboard`}),`.`]})}),`\n`,_jsx(Heading,{level:`3`,id:`response-parameters`,children:`Response parameters`}),`\n`,_jsxs(_components.p,{children:[`The API response is returned in a universal and lightweight `,_jsx(_components.a,{href:`https://www.json.org/json-en.html`,children:`JSON format`}),`.`]}),`\n`,_jsxs(ResponseField,{name:`hits`,type:`object`,id:`param-hits`,children:[_jsx(_components.p,{children:`Usage statistics for your account.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`quota`,type:`number`,id:`param-quota`,children:_jsx(_components.p,{children:`Total number of requests allowed per period.`})}),_jsx(ResponseField,{name:`used`,type:`number`,id:`param-used`,children:_jsx(_components.p,{children:`Number of requests used this period.`})}),_jsx(ResponseField,{name:`remaining`,type:`number`,id:`param-remaining`,children:_jsx(_components.p,{children:`Number of requests remaining this period.`})})]})]}),`\n`,_jsxs(ResponseField,{name:`concurrency`,type:`object`,id:`param-concurrency`,children:[_jsx(_components.p,{children:`Usage statistics for your account.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`limit`,type:`number`,id:`param-limit`,children:_jsx(_components.p,{children:`Total number of concurrent requests allowed.`})}),_jsx(ResponseField,{name:`remaining`,type:`number`,id:`param-remaining-1`,children:_jsx(_components.p,{children:`Number of concurrent requests remaining.`})}),_jsx(ResponseField,{name:`reset`,type:`number`,id:`param-reset`,children:_jsx(_components.p,{children:`Unix timestamp in seconds when the concurrency limit resets.`})})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`error-codes`,children:`Error Codes`}),`\n`,_jsx(_components.p,{children:`Whenever you make a request that fails for some reason, an error is returned also in the JSON format. The errors include an error code and description, which you can find in detail below.`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Code`}),_jsx(_components.th,{children:`Type`}),_jsx(_components.th,{children:`Details`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`200`}),_jsx(_components.td,{children:`OK`}),_jsx(_components.td,{children:`The request was successful.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`401`}),_jsx(_components.td,{children:`Unauthorized`}),_jsx(_components.td,{children:`The request was rejected due to an invalid access key.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`500`}),_jsx(_components.td,{children:`Internal server error`}),_jsx(_components.td,{children:`The request failed due to an internal server error.`})]})]})]})]})}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":"Usage","api":"GET https://api.screenshotmax.com/v1/usage","description":"Get usage statistics for your account.","href":"/endpoints/usage"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Getting started","slug":"getting-started","depth":2,"children":[{"title":"REST","slug":"rest","depth":3,"children":[]},{"title":"HTTPS","slug":"https","depth":3,"children":[]},{"title":"API Versions","slug":"api-versions","depth":3,"children":[]},{"title":"Your Access Key","slug":"your-access-key","depth":3,"children":[]},{"title":"Base URL","slug":"base-url","depth":3,"children":[]},{"title":"Validation endpoint","slug":"validation-endpoint","depth":3,"children":[]},{"title":"Request parameters","slug":"request-parameters","depth":3,"children":[]},{"title":"Response parameters","slug":"response-parameters","depth":3,"children":[]},{"title":"Error Codes","slug":"error-codes","depth":3,"children":[]}]}],"codeExamples":{},"endpoint":{"title":"Usage","path":"/v1/usage","servers":[{"url":"https://api.screenshotmax.com"}],"method":"get","request":{"security":[],"parameters":{"query":{"access_key":{"schema":[{"type":"string","description":"Your unique access key. You can find your access key in your account dashboard .","required":true}]}},"header":{},"cookie":{},"path":{}},"body":{}},"response":{"200":{"application/json":{"schemaArray":[{"type":"object","properties":{"hits":[{"type":"object","properties":{"quota":[{"type":"number","description":"Total number of requests allowed per period."}],"used":[{"type":"number","description":"Number of requests used this period."}],"remaining":[{"type":"number","description":"Number of requests remaining this period."}]},"description":"Usage statistics for your account."}],"concurrency":[{"type":"object","properties":{"limit":[{"type":"number","description":"Total number of concurrent requests allowed."}],"remaining":[{"type":"number","description":"Number of concurrent requests remaining."}],"reset":[{"type":"number","description":"Unix timestamp in seconds when the concurrency limit resets."}]},"description":"Usage statistics for your account."}]}}],"examples":{"example":{"value":{"hits":{"quota":123,"used":123,"remaining":123},"concurrency":{"limit":123,"remaining":123,"reset":123}}}}}}},"deprecated":false}},"jsLinks":[],"subdomain":"screenshotmax","siteName":"ScreenshotMAX API","title":"Usage - ScreenshotMAX API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2025-10-27T18:31:04.892Z","originalFileLocation":"endpoints/usage.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=\"Get usage statistics for your account.\">\u003cmeta data-mint-head name=\"application-name\" content=\"ScreenshotMAX API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/screenshotmax/gh8M7foZ52OJnYX-/_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/screenshotmax/gh8M7foZ52OJnYX-/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/screenshotmax/gh8M7foZ52OJnYX-/_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/screenshotmax/gh8M7foZ52OJnYX-/_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/screenshotmax/gh8M7foZ52OJnYX-/_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/screenshotmax/gh8M7foZ52OJnYX-/_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/screenshotmax/gh8M7foZ52OJnYX-/_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/screenshotmax/gh8M7foZ52OJnYX-/_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/screenshotmax/gh8M7foZ52OJnYX-/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Usage - ScreenshotMAX API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Get usage statistics for your account.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"ScreenshotMAX API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.screenshotmax.com/endpoints/usage\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://screenshotmax.mintlify.app/_mintlify/api/og/v2?division=Others\u0026amp;title=Usage\u0026amp;description=Get+usage+statistics+for+your+account.\u0026amp;theme=3bcaa92a7300bf8b66c12bab\u0026amp;signature=7485b577d90011109f803ef60c914cc03e59fc2301189b2a804d309717cc101f\">\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=\"Usage - ScreenshotMAX API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Get usage statistics for your account.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://screenshotmax.mintlify.app/_mintlify/api/og/v2?division=Others\u0026amp;title=Usage\u0026amp;description=Get+usage+statistics+for+your+account.\u0026amp;theme=3bcaa92a7300bf8b66c12bab\u0026amp;signature=7485b577d90011109f803ef60c914cc03e59fc2301189b2a804d309717cc101f\">\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/screenshotmax/gh8M7foZ52OJnYX-/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"ScreenshotMAX API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#3366FF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.screenshotmax.com/endpoints/usage\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/endpoints/usage.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.screenshotmax.com/#organization\",\"name\":\"ScreenshotMAX API\",\"url\":\"https://docs.screenshotmax.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/screenshotmax/T1xOqe1MKSP6l0-_/logo/logo-light.png?fit=max\u0026auto=format\u0026n=T1xOqe1MKSP6l0-_\u0026q=85\u0026s=4b3619eb6512d1558a324ac0cc879acc\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.screenshotmax.com#website\",\"name\":\"ScreenshotMAX API\",\"url\":\"https://docs.screenshotmax.com\",\"publisher\":{\"@id\":\"https://docs.screenshotmax.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.screenshotmax.com/endpoints/usage#webpage\",\"url\":\"https://docs.screenshotmax.com/endpoints/usage\",\"name\":\"Usage\",\"description\":\"Get usage statistics for your account.\",\"dateModified\":\"2025-10-27T18:31:04.892Z\",\"isPartOf\":{\"@id\":\"https://docs.screenshotmax.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.screenshotmax.com/endpoints/usage#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.screenshotmax.com/endpoints/usage#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Others\",\"item\":\"https://docs.screenshotmax.com/endpoints/devices\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Usage\",\"item\":\"https://docs.screenshotmax.com/endpoints/usage\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.screenshotmax.com/endpoints/usage#apireference\",\"headline\":\"Usage\",\"name\":\"Usage\",\"description\":\"Get usage statistics for your account.\",\"url\":\"https://docs.screenshotmax.com/endpoints/usage\",\"mainEntityOfPage\":{\"@id\":\"https://docs.screenshotmax.com/endpoints/usage#webpage\"},\"dateModified\":\"2025-10-27T18:31:04.892Z\",\"publisher\":{\"@id\":\"https://docs.screenshotmax.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.screenshotmax.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"ScreenshotMAX API\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"ScreenshotMAX API","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/guides/start/introduction"}]},{"tab":"API Reference","groups":[{"group":"Screenshot","pages":[{"title":"Screenshot","api":"GET https://api.screenshotmax.com/v1/screenshot","href":"/endpoints/get-screenshot"},{"title":"Screenshot","api":"POST https://api.screenshotmax.com/v1/screenshot","href":"/endpoints/post-screenshot"}]},{"group":"Animated Screenshot","pages":[{"title":"Screencast","api":"GET https://api.screenshotmax.com/v1/screencast","href":"/endpoints/get-screencast"},{"title":"Screencast","api":"POST https://api.screenshotmax.com/v1/screencast","href":"/endpoints/post-screencast"}]},{"group":"Pdf","pages":[{"title":"Pdf","api":"GET https://api.screenshotmax.com/v1/pdf","href":"/endpoints/get-pdf"},{"title":"Pdf","api":"POST https://api.screenshotmax.com/v1/pdf","href":"/endpoints/post-pdf"}]},{"group":"Scrape","pages":[{"title":"Scrape","api":"GET https://api.screenshotmax.com/v1/scrape","href":"/endpoints/get-scrape"},{"title":"Scrape","api":"POST https://api.screenshotmax.com/v1/scrape","href":"/endpoints/post-scrape"}]},{"group":"Scheduled Tasks","pages":[{"title":"List Tasks","api":"GET https://api.screenshotmax.com/v1/tasks","href":"/endpoints/get-tasks"},{"title":"Get Task","api":"GET https://api.screenshotmax.com/v1/tasks/{id}","href":"/endpoints/get-tasks-id"},{"title":"Create Task","api":"POST https://api.screenshotmax.com/v1/tasks","href":"/endpoints/post-tasks"},{"title":"Update Task","api":"PATCH https://api.screenshotmax.com/v1/tasks/{id}","href":"/endpoints/patch-tasks"},{"title":"Delete Task","api":"DELETE https://api.screenshotmax.com/v1/tasks/{id}","href":"/endpoints/delete-tasks"}]},{"group":"Others","pages":[{"title":"Devices","api":"GET https://api.screenshotmax.com/v1/devices","description":"Get a list of available devices for emulation.","href":"/endpoints/devices"},{"title":"Usage","api":"GET https://api.screenshotmax.com/v1/usage","href":"/endpoints/usage"}]}]},{"tab":"LLMs Integrations","href":"https://docs.screenshotmax.com/llms-full.txt"}]},"basePath":"","title":"Usage - ScreenshotMAX API","buildId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","deploymentId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","dynamics":["c2aa737661","2b790eda92","b0f84f53ff"],"chunks":["OpenApiReferenceProvider-B7XKH4J3.js","utils-lOYzL7z-.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DF6jUUIM.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dpsj5f7C.js","snippetPresets-CYeiDe8v.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CUFz1YZ_.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-D8H_iLS4.js","shallow-DdluZBHX.js","getApiPlaygroundDisplay-B9922vev.js","CodeSnippet-CMoRNGYs.js","CodeSnippets-DwyrPHuw.js","Page-DSVu9Ucl.js","getPastedJson-G-zIvlHh.js","icon-B03fnEy0.js","MethodPill-CW7teklc.js","DuplicateIcon-CtO8eekd.js","createIcon-DZTKdM_A.js","DynamicMarkdown-D5M2At0B.js","SectionHeading-C_2NaA2U.js","axios-vUo_bRtp.js"]}