Quickstart

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

Get your API key

Install required packages

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

pip install requests

npm install axios

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)

const axios = require('axios');

const payload = {
  prompt: 'Compare the top 3 programming languages for web development in 2025',
  country: 'US',
  include: {
    markdown: true,
    rawResponse: true,
    searchQueries: true
  }
};

axios.post('https://api.cloro.dev/v1/monitor/chatgpt', payload, {
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  }
})
.then(response => {
  console.log(response.data);
})
.catch(error => {
  console.error('Error:', error);
});

curl -X POST https://api.cloro.dev/v1/monitor/chatgpt \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "prompt": "Compare the top 3 programming languages for web development in 2025",
    "country": "US",
    "include": {
      "markdown": true,
      "rawResponse": true,
      "searchQueries": true
    }
  }'

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.

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:

Parameter	Description	Default value
`prompt`*	The prompt or question to send to ChatGPT (1-10,000 characters)	–
`country`	Optional country/region code for localized monitoring (e.g., `US`, `GB`, `DE`)	–
`include.markdown`	Include response in Markdown format when set to true	`false`
`include.rawResponse`	Include raw streaming response events for debugging (+2 credits)	`false`
`include.searchQueries`	Include 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:

Learn about shopping cards for automatic product data extraction
Review the complete API reference for detailed parameter documentation
Explore use cases to see how others are using the ChatGPT Scraper API
Understand the response structure for advanced data parsing

Get Started

Core Concepts

Guides

Use Cases

Quickstart

Quickstart

Request parameters

Next steps

​Quickstart

​Request parameters

​Next steps

Quickstart

Request parameters

Next steps