Welcome to the Retailed Public API Documentation site! Here you’ll be able to find all the information you’ll need to get up and running with Retailed.
At Retailed, we are passionately committed to being a global, developer-first platform for retail APIs. We believe clear and comprehensive documentation is vital for minimizing barriers to API usage.
Kick-starting your journey with the Retailed API encompasses creating an account and generating an API key. Follow the steps below for a seamless setup:
This is the first step towards gaining full access to the various features we offer through our API. Upon successfully creating your account and obtaining your API key, you will be equipped to use all the capabilities of our platform.
Was this page helpful?
{"docsConfig":{"$schema":"https://mintlify.com/docs.json","theme":"mint","name":"Retailed Docs","colors":{"primary":"#111827","light":"#4D9CFF","dark":"#0A0A0A"},"favicon":"https://mintcdn.com/retailed/x3z4a7mGfkAVp5RB/favicon.png?fit=max\u0026auto=format\u0026n=x3z4a7mGfkAVp5RB\u0026q=85\u0026s=953ba81d822d95d615df38b8244b4c7f","logo":{"light":"https://mintcdn.com/retailed/x3z4a7mGfkAVp5RB/logo/light.png?fit=max\u0026auto=format\u0026n=x3z4a7mGfkAVp5RB\u0026q=85\u0026s=04517025f794955f9280a8a7fda7a1c6","dark":"https://mintcdn.com/retailed/x3z4a7mGfkAVp5RB/logo/dark.png?fit=max\u0026auto=format\u0026n=x3z4a7mGfkAVp5RB\u0026q=85\u0026s=b5ac27535a30f2ffe751ab7662a3a715"},"appearance":{"default":"dark","strict":false},"navbar":{"links":[{"label":"Datasources Pricing","href":"https://www.retailed.io/datasources/pricing"}],"primary":{"type":"button","label":"Login to Retailed API","href":"https://app.retailed.io"}},"footer":{"socials":{"twitter":"https://twitter.com/retailedio","instagram":"https://instagram.com/retailed.io","linkedin":"https://www.linkedin.com/company/91536478"}},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Community","href":"https://discord.com/invite/EUCkqCWrb8","icon":"discord"},{"anchor":"Postman","href":"https://documenter.getpostman.com/view/9159115/2s8YzQVib9","icon":"square-terminal"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"retailed","hasAudioNarration":false,"actualSubdomain":"retailed","customDomains":["docs.retailed.io"],"gitSource":{"type":"github","owner":"retailedio","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a20c34d12ef21155ee55155","collectionId":"6b58dfd4-fe4b-4887-8456-2546dcbaf391","schemaVersion":"v2"},"feedback":{"thumbs":true},"entitlements":{},"buildId":"6a20c34d12ef21155ee55155:success","clientVersion":"0.0.3869","searchFilterCounts":[{"language":"default","tag":"Scraper API","count":20},{"language":"default","tag":"Documentation","count":15},{"language":"default","tag":"Datasources","count":6},{"language":"default","tag":"Goat","count":4},{"language":"default","tag":"StockX","count":3},{"language":"default","tag":"Products Database","count":3},{"language":"default","tag":"Bestbuy","count":2},{"language":"default","tag":"Chrono24","count":2},{"language":"default","tag":"Finder","count":2},{"language":"default","tag":"Help","count":2}]},"assistantConfig":{},"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":"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":"editor-branches-v2-autocommit","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-branches-v2","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":"teamspace","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":"vite-origin","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":"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":"revalidation-jwt","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":"client-snapshot-docs-config","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"v1/introduction","slug":"/v1/introduction","pageMetadata":{"title":"Introduction","description":"Welcome to the Retailed Public API Documentation site! Here you'll be able to find all the information you'll need to get up and running with Retailed.","icon":"globe","href":"/v1/introduction"},"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: \"Welcome to the Retailed Public API Documentation site! Here you’ll be able to find all the information you’ll need to get up and running with Retailed.\"\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`,li:`li`,ol:`ol`,p:`p`,..._provideComponents(),...props.components},{Heading}=_components;if(!Heading)_missingMdxReference(`Heading`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`At Retailed, we are passionately committed to being a global, developer-first platform for retail APIs. We believe clear and comprehensive documentation is vital for minimizing barriers to API usage.`}),`\n`,_jsx(Heading,{level:`1`,id:`getting-started-with-retailed-api`,children:`Getting Started with Retailed API`}),`\n`,_jsx(_components.p,{children:`Kick-starting your journey with the Retailed API encompasses creating an account and generating an API key. Follow the steps below for a seamless setup:`}),`\n`,_jsxs(_components.ol,{children:[`\n`,_jsxs(_components.li,{children:[`\n`,_jsxs(_components.p,{children:[`Visit the `,_jsx(_components.a,{href:`v1/authentication`,children:`Retailed Dashboard`}),`.`]}),`\n`]}),`\n`,_jsxs(_components.li,{children:[`\n`,_jsx(_components.p,{children:`Click on the “API” tab.`}),`\n`]}),`\n`]}),`\n`,_jsx(_components.p,{children:`This is the first step towards gaining full access to the various features we offer through our API. Upon successfully creating your account and obtaining your API key, you will be equipped to use all the capabilities of our platform.`})]})}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":"Introduction","description":"Welcome to the Retailed Public API Documentation site! Here you'll be able to find all the information you'll need to get up and running with Retailed.","icon":"globe","href":"/v1/introduction"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Getting Started with Retailed API","slug":"getting-started-with-retailed-api","depth":1,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"retailed","siteName":"Retailed Docs","title":"Introduction - Retailed Docs","navMaps":{"firstHrefInVersion":{"v1":{"href":"/v1/introduction","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-01-25T18:58:22.484Z","originalFileLocation":"v1/introduction.mdx"},"headHtml":"\u003cmeta data-mint-head name=\"description\" content=\"Welcome to the Retailed Public API Documentation site! Here you\u0026#x27;ll be able to find all the information you\u0026#x27;ll need to get up and running with Retailed.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Retailed Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/retailed/CSlcbtN4-V1rg50n/_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/retailed/CSlcbtN4-V1rg50n/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/retailed/CSlcbtN4-V1rg50n/_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/retailed/CSlcbtN4-V1rg50n/_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/retailed/CSlcbtN4-V1rg50n/_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/retailed/CSlcbtN4-V1rg50n/_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/retailed/CSlcbtN4-V1rg50n/_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/retailed/CSlcbtN4-V1rg50n/_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/retailed/CSlcbtN4-V1rg50n/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Introduction - Retailed Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Welcome to the Retailed Public API Documentation site! Here you\u0026#x27;ll be able to find all the information you\u0026#x27;ll need to get up and running with Retailed.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Retailed Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.retailed.io/v1/introduction\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Introduction - Retailed Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Welcome to the Retailed Public API Documentation site! Here you\u0026#x27;ll be able to find all the information you\u0026#x27;ll need to get up and running with Retailed.\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/retailed/CSlcbtN4-V1rg50n/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Retailed Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#111827\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.retailed.io/v1/introduction\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/v1/introduction.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.retailed.io/#organization\",\"name\":\"Retailed Docs\",\"url\":\"https://docs.retailed.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/retailed/x3z4a7mGfkAVp5RB/logo/light.png?fit=max\u0026auto=format\u0026n=x3z4a7mGfkAVp5RB\u0026q=85\u0026s=04517025f794955f9280a8a7fda7a1c6\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.retailed.io#website\",\"name\":\"Retailed Docs\",\"url\":\"https://docs.retailed.io\",\"publisher\":{\"@id\":\"https://docs.retailed.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.retailed.io/v1/introduction#webpage\",\"url\":\"https://docs.retailed.io/v1/introduction\",\"name\":\"Introduction\",\"description\":\"Welcome to the Retailed Public API Documentation site! Here you'll be able to find all the information you'll need to get up and running with Retailed.\",\"dateModified\":\"2026-01-25T18:58:22.484Z\",\"isPartOf\":{\"@id\":\"https://docs.retailed.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.retailed.io/v1/introduction#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.retailed.io/v1/introduction#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Retailed Docs\",\"item\":\"https://docs.retailed.io\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Introduction\",\"item\":\"https://docs.retailed.io/v1/introduction\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.retailed.io/v1/introduction#article\",\"headline\":\"Introduction\",\"name\":\"Introduction\",\"description\":\"Welcome to the Retailed Public API Documentation site! Here you'll be able to find all the information you'll need to get up and running with Retailed.\",\"url\":\"https://docs.retailed.io/v1/introduction\",\"mainEntityOfPage\":{\"@id\":\"https://docs.retailed.io/v1/introduction#webpage\"},\"dateModified\":\"2026-01-25T18:58:22.484Z\",\"publisher\":{\"@id\":\"https://docs.retailed.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.retailed.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Retailed Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Retailed Docs","nav":{"global":{"anchors":[{"anchor":"Community","href":"https://discord.com/invite/EUCkqCWrb8","icon":"discord"},{"anchor":"Postman","href":"https://documenter.getpostman.com/view/9159115/2s8YzQVib9","icon":"square-terminal"}]},"versions":[{"version":"v1","tabs":[{"tab":"Documentation","groups":[{"group":"Documentation","pages":[{"title":"Introduction","description":"Welcome to the Retailed Public API Documentation site! Here you'll be able to find all the information you'll need to get up and running with Retailed.","icon":"globe","href":"/v1/introduction"},{"title":"Services","description":"Retailed Businesses Services","icon":"person","href":"/v1/services"},{"title":"Integrations","description":"Boost your e-commerce sales and profits with our dynamic pricing API - delivering real-time pricing updates across multiple retail platforms.","icon":"pen","href":"/v1/integrations"},{"title":"Authentication","description":"After completing this quick start guide you'll have generated and tested an authentication token that can be used in all subsequent requests to the Retailed API.","icon":"key","href":"/v1/authentication"},{"title":"Status Code","description":"The following list of HTTP codes are returned by Retailed.","icon":"code","href":"/v1/status-code"},{"title":"Pricing","description":"Complete guide to Retailed API pricing, credits, and plans.","icon":"credit-card","href":"/v1/pricing"},{"title":"FAQ","description":"This section of is aimed at collecting and answering common questions that developers may have when working with the API.","icon":"question","href":"/v1/faq"}]},{"group":"Account","pages":[{"title":"Usage","api":"GET https://app.retailed.io/api/v1/usage","description":"Get API usage information","href":"/v1/usage"}]}]},{"tab":"Datasources","pages":[{"title":"Datasources","href":"/v1/datasources/db/products"}]},{"tab":"Scraper API","pages":[{"title":"Scraper API","href":"/v1/api-reference/bestbuy/search"}]},{"tab":"Finder","pages":[{"title":"Finder","href":"/v1/api-reference/finder/chrono24-search"}]}]}]},"title":"Introduction - Retailed Docs","buildId":"dpl_DMQXxPZd444kjahHSuSB7FkJbKrX","deploymentId":"dpl_DMQXxPZd444kjahHSuSB7FkJbKrX","dynamics":[],"chunks":[]}