Welcome to the Flashmapy Public API Documentation site! Here you’ll be able to find all the information you’ll need to get up and running with Flashmapy.
At Flashmapy, we are passionately committed to being a global, developer-first platform for scraping APIs. We believe clear and comprehensive documentation is vital for minimizing barriers to API usage.
Kick-starting your journey with the Flashmapy 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":"Flashmapy","colors":{"primary":"#EC4899","light":"#FFFFFF","dark":"#0D001D"},"favicon":"/favicon.png","logo":{"light":"https://mintcdn.com/flashmapy/sL0hZ83rkO3jBojo/logo/light.svg?fit=max\u0026auto=format\u0026n=sL0hZ83rkO3jBojo\u0026q=85\u0026s=9783cdc8c42136497d3585c46c50e59a","dark":"https://mintcdn.com/flashmapy/sL0hZ83rkO3jBojo/logo/dark.svg?fit=max\u0026auto=format\u0026n=sL0hZ83rkO3jBojo\u0026q=85\u0026s=3145b38287dc15980ac8e65059fdee5d"},"background":{"decoration":null,"color":{"light":null,"dark":"#090014"}},"navbar":{"links":[{"label":"Support","href":"mailto:josselin@flashmapy.com"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.flashmapy.com"}},"footer":{"socials":{"twitter":"https://twitter.com/flashmapy","linkedin":"https://www.linkedin.com/company/flashmapy"}},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"flashmapy","hasAudioNarration":false,"actualSubdomain":"flashmapy","customDomains":["docs.flashmapy.com"],"gitSource":{"type":"github","owner":"flashmapy","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"feedback":{"thumbs":true},"entitlements":{},"buildId":"6ae91d6b490ed5cbb563c5d2:success","clientVersion":"0.0.4094","searchFilterCounts":[{"language":"default","tag":"API Reference","count":5},{"language":"default","tag":"Endpoints","count":4},{"language":"default","tag":"Documentation","count":4},{"language":"default","tag":"Get Started","count":4},{"language":"default","tag":"Blacklist","count":3},{"language":"default","tag":"Jobs","count":1},{"language":"default","tag":"Advanced","count":1}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","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":"rbac-expansion","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":"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":"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},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"introduction","slug":"/introduction","pageMetadata":{"title":"Introduction","description":"Welcome to the Flashmapy Public API Documentation site! Here you'll be able to find all the information you'll need to get up and running with Flashmapy.","href":"/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 Flashmapy Public API Documentation site! Here you’ll be able to find all the information you’ll need to get up and running with Flashmapy.\"\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 Flashmapy, we are passionately committed to being a global, developer-first platform for scraping APIs. We believe clear and comprehensive documentation is vital for minimizing barriers to API usage.`}),`\n`,_jsx(Heading,{level:`2`,id:`getting-started-with-flashmapy-api`,children:`Getting Started with Flashmapy API`}),`\n`,_jsx(_components.p,{children:`Kick-starting your journey with the Flashmapy 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:`/authentication`,children:`Flashmapy 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 Flashmapy Public API Documentation site! Here you'll be able to find all the information you'll need to get up and running with Flashmapy.","href":"/introduction"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Getting Started with Flashmapy API","slug":"getting-started-with-flashmapy-api","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"flashmapy","siteName":"Flashmapy","title":"Introduction - Flashmapy","navMaps":{"firstHrefInVersion":{"v1":{"href":"/introduction","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-01-06T23:48:03.289Z","originalFileLocation":"introduction.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=\"Welcome to the Flashmapy 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 Flashmapy.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Flashmapy\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/flashmapy/Shh35o_dGr0O_nH_/_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/flashmapy/Shh35o_dGr0O_nH_/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/flashmapy/Shh35o_dGr0O_nH_/_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/flashmapy/Shh35o_dGr0O_nH_/_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/flashmapy/Shh35o_dGr0O_nH_/_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/flashmapy/Shh35o_dGr0O_nH_/_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/flashmapy/Shh35o_dGr0O_nH_/_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/flashmapy/Shh35o_dGr0O_nH_/_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/flashmapy/Shh35o_dGr0O_nH_/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Introduction - Flashmapy\">\u003cmeta data-mint-head property=\"og:description\" content=\"Welcome to the Flashmapy 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 Flashmapy.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Flashmapy\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.flashmapy.com/introduction\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://flashmapy.mintlify.site/_mintlify/api/og/v2?division=Get+Started\u0026amp;title=Introduction\u0026amp;description=Welcome+to+the+Flashmapy+Public+API+Documentation+site%21+Here+you%27ll+be+able+to+find+all+the+information+you%27ll+need+to+get+up+and+running+with+Flashmapy.\u0026amp;theme=4aebd4c2086f27c85a231092\u0026amp;signature=86585d1e0adb3db37ad2d8ec4d44454b583ada1892078d626b1d81ddd1fcb10f\">\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=\"Introduction - Flashmapy\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Welcome to the Flashmapy 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 Flashmapy.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://flashmapy.mintlify.site/_mintlify/api/og/v2?division=Get+Started\u0026amp;title=Introduction\u0026amp;description=Welcome+to+the+Flashmapy+Public+API+Documentation+site%21+Here+you%27ll+be+able+to+find+all+the+information+you%27ll+need+to+get+up+and+running+with+Flashmapy.\u0026amp;theme=4aebd4c2086f27c85a231092\u0026amp;signature=86585d1e0adb3db37ad2d8ec4d44454b583ada1892078d626b1d81ddd1fcb10f\">\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/flashmapy/Shh35o_dGr0O_nH_/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Flashmapy\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#EC4899\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.flashmapy.com/introduction\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/introduction.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.flashmapy.com/#organization\",\"name\":\"Flashmapy\",\"url\":\"https://docs.flashmapy.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/flashmapy/sL0hZ83rkO3jBojo/logo/light.svg?fit=max\u0026auto=format\u0026n=sL0hZ83rkO3jBojo\u0026q=85\u0026s=9783cdc8c42136497d3585c46c50e59a\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.flashmapy.com#website\",\"name\":\"Flashmapy\",\"url\":\"https://docs.flashmapy.com\",\"publisher\":{\"@id\":\"https://docs.flashmapy.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.flashmapy.com/introduction#webpage\",\"url\":\"https://docs.flashmapy.com/introduction\",\"name\":\"Introduction\",\"description\":\"Welcome to the Flashmapy Public API Documentation site! Here you'll be able to find all the information you'll need to get up and running with Flashmapy.\",\"dateModified\":\"2026-01-06T23:48:03.289Z\",\"isPartOf\":{\"@id\":\"https://docs.flashmapy.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.flashmapy.com/introduction#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.flashmapy.com/introduction#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Flashmapy\",\"item\":\"https://docs.flashmapy.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Introduction\",\"item\":\"https://docs.flashmapy.com/introduction\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.flashmapy.com/introduction#article\",\"headline\":\"Introduction\",\"name\":\"Introduction\",\"description\":\"Welcome to the Flashmapy Public API Documentation site! Here you'll be able to find all the information you'll need to get up and running with Flashmapy.\",\"url\":\"https://docs.flashmapy.com/introduction\",\"mainEntityOfPage\":{\"@id\":\"https://docs.flashmapy.com/introduction#webpage\"},\"dateModified\":\"2026-01-06T23:48:03.289Z\",\"publisher\":{\"@id\":\"https://docs.flashmapy.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.flashmapy.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Flashmapy\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Flashmapy","nav":{"global":null,"versions":[{"version":"v1","tabs":[{"tab":"Documentation","groups":[{"group":"Get Started","pages":[{"title":"Introduction","href":"/introduction"},{"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 Flashmapy API.","href":"/authentication"},{"title":"Attributes","href":"/attributes"},{"title":"Status Code","href":"/status-code"}]}]},{"tab":"API Reference","pages":[{"title":"API Reference","href":"/api-reference/jobs/create"}]}]}]},"basePath":"","title":"Introduction - Flashmapy","buildId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","deploymentId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","dynamics":[],"chunks":[]}