Skip to main content

​
Quickstart

This guide will help you make your first successful API call to the ChatGPT Scraper API.
1

Get your API key

Sign up at cloro.dev to get your API key. You’ll need this to authenticate your requests.
2

Install required packages

Depending on your programming language, install the necessary HTTP client:
pip install requests
3

Make your first request

Use the following code to send your first prompt to ChatGPT:
import json
import requests

# API parameters
payload = {
    'prompt': 'Compare the top 3 programming languages for web development in 2025',
    'country': 'US',
    'include': {
        'markdown': True,
        'rawResponse': True,
        'searchQueries': True
    }
}

# Get a response
response = requests.post(
    'https://api.cloro.dev/v1/monitor/chatgpt',
    headers={'Authorization': 'Bearer YOUR_API_KEY'},
    json=payload
)

# Print response to stdout
print(response.json())

# Save response to a JSON file
with open('response.json', 'w') as file:
    json.dump(response.json(), file, indent=2)
Replace YOUR_API_KEY with your actual API key from cloro.dev.
Set an appropriate timeout (120-180 seconds) when making requests, as ChatGPT responses may take time to generate depending on complexity.
4

Understand the response

The API returns a structured JSON object with ChatGPT’s response and metadata:
{
  "status": "success",
  "result": {
    "model": "gpt-5-mini",
    "text": "When comparing programming languages for web development in 2025, three languages stand out...",
    "markdown": "**When comparing programming languages for web development in 2025**, three languages stand out...",
    "shoppingCards": [...],
    "searchQueries": ["web development languages 2025"],
    "rawResponse": [...]
  }
}
Key fields in the response:
  • status: Request status (e.g., “success”)
  • result.model: The ChatGPT model used to generate the response
  • result.text: The complete ChatGPT response as plain text
  • result.markdown: The response formatted in Markdown (when include.markdown is true)
  • result.shoppingCards: Array of product cards extracted from the response (if available)
  • result.searchQueries: Query fan-out ChatGPT used internally (when include.searchQueries is true)
  • result.rawResponse: Array of ChatGPT’s streamed response events (when include.rawResponse is true)

​
Request parameters

Here are the main parameters you can use:
ParameterDescriptionDefault value
prompt*The prompt or question to send to ChatGPT (1-10,000 characters)–
countryOptional country/region code for localized monitoring (e.g., US, GB, DE)–
include.markdownInclude response in Markdown format when set to truefalse
include.rawResponseInclude raw streaming response events for debugging (+2 credits)false
include.searchQueriesInclude query fan-out ChatGPT used to generate response (+2 credits)false
* Mandatory parameters
Additional features have extra costs:
  • include.rawResponse: +2 credits per request
  • include.searchQueries: +2 credits per request
The base request with Web Search uses 5 credits.

​
Next steps

Now that you’ve made your first successful API call, explore more features:

Build docs developers (and LLMs) love

Get started for freeTalk to us