Skip to main content
POST
ChatGPT scraper API
Use AdsCrawl ChatGPT Scraper to collect an answer and its available source information for brand research, citation analysis or your own GEO workflow. Configure the request in AI Search Insights, then open API integration to copy the request for those settings.

Authentication

Send your AdsCrawl API key in the x-api-key header and a JSON request body. The examples read the key from your application’s ADSCRAWL_API_KEY environment variable. Set that variable before running them and keep your key on the server.
string
required
Your AdsCrawl API key. Obtain a key from API keys.
string
required
Use application/json.

Request body

string
Use chatgpt for the currently available ChatGPT scraper.
string
The prompt to submit. Include the language you want the answer to use in this text.
string
Proxy-region selection. GLOBAL selects a random exit across supported regions. To use a specific supported region, select it in the console and copy its generated API request.
string
Browser-language selection, such as en-US. The console’s Automatic (proxy region) setting omits this field. Browser language does not determine the language of the answer.
number
Overall capture timeout in milliseconds. The example uses 120000 (120 seconds). The console exposes a 10 to 120 second timeout control; keep your HTTP client’s timeout longer than the capture timeout.

Request examples

These examples use a global proxy exit and an English-language browser. The client waits up to 140 seconds for a capture configured for 120 seconds.

Response fields

Answers depend on the prompt and the response available during capture. Sources and ads may be absent. Inspect the returned data before building assumptions about nested source, ad or network fields into your application.

Regions, languages and analysis

Requests use dynamic residential proxies. A selected region alone does not guarantee access or a particular answer. Preserve the prompt, region, language and observed network context when comparing captures. To request a German answer, for example, explicitly ask for German in query even if you set the browser language separately. Use the captured answer and source data in your own brand-mention, citation or visibility analysis. Repeated collection, scheduling and scoring belong to the workflow you build around the API.

AI Scrapers availability

Only ChatGPT is currently selectable for capture in AI Search Insights. Coming-soon entries do not provide a callable platform value.