API Reference

Quick Start

curl -X POST https://api.geotoolhub.com/v1/chat/completions \
  -H "Authorization: Bearer sk-your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "geo-monitor",
    "messages": [{"role": "user", "content": "What are the best CRM tools?"}],
    "platforms": [{"platform": "deepseek", "mode": "search"}]
  }'

{ "choices": [{ "message": { "content": "{\"task_id\":\"a1b2c3d4...\",\"status\":\"pending\"}" } }] }

# Poll every 5-10 seconds until status is "completed":
curl https://api.geotoolhub.com/v1/tasks/a1b2c3d4.../status \
  -H "Authorization: Bearer sk-your-api-key"

# Then fetch the result:
curl https://api.geotoolhub.com/v1/tasks/a1b2c3d4.../result \
  -H "Authorization: Bearer sk-your-api-key"

import httpx, json, time

API_KEY = "sk-your-api-key"
BASE = "https://api.geotoolhub.com"
headers = {"Authorization": f"Bearer {API_KEY}"}

# 1. Submit
resp = httpx.post(f"{BASE}/v1/chat/completions", headers=headers, json={
    "model": "geo-monitor",
    "messages": [{"role": "user", "content": "What are the best CRM tools?"}],
    "platforms": [{"platform": "deepseek", "mode": "search"}]
})
task_id = json.loads(resp.json()["choices"][0]["message"]["content"])["task_id"]

# 2. Poll
while True:
    status = httpx.get(f"{BASE}/v1/tasks/{task_id}/status", headers=headers).json()
    if status["status"] == "completed": break
    time.sleep(10)

# 3. Get result
result = httpx.get(f"{BASE}/v1/tasks/{task_id}/result", headers=headers).json()
print(result["data"]["subTaskList"][0]["answerContent"])

Base URL

Authentication

Include your API key in the Authorization header of every request:

Authorization: Bearer sk-your-api-key

Get your API key at api.geotoolhub.com or on RapidAPI.

Workflow

Submit a monitoring query using the standard OpenAI chat completion format. Works with any OpenAI-compatible client library.

Request Body

PlatformConfig

Example

curl -X POST https://api.geotoolhub.com/v1/chat/completions \
  -H "Authorization: Bearer sk-your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "geo-monitor",
    "messages": [{"role": "user", "content": "What are the best CRM tools?"}],
    "platforms": [{"platform": "deepseek", "mode": "search"}],
    "monitorKeywords": "Salesforce,HubSpot"
  }'

# Response (OpenAI-compatible):
{
  "id": "chatcmpl-a1b2c3d4-...",
  "object": "chat.completion",
  "choices": [{
    "message": {
      "content": "{\"task_id\":\"a1b2c3d4-...\",\"status\":\"pending\"}"
    }
  }]
}

# Extract task_id, then poll /v1/tasks/{task_id}/status

Poll the status of a monitoring task. Call every 5-10 seconds until status is completed.

Path Parameters

Status Values

Example

curl https://api.geotoolhub.com/v1/tasks/{task_id}/status \
  -H "Authorization: Bearer sk-your-api-key"

# Response:
{
  "task_id": "a1b2c3d4-...",
  "status": "completed",
  "created_at": "2026-05-17 12:00:00"
}

Fetch the full monitoring result. Only call when status is completed.

Example

curl https://api.geotoolhub.com/v1/tasks/{task_id}/result \
  -H "Authorization: Bearer sk-your-api-key"

# Response:
{
  "task_id": "a1b2c3d4-...",
  "status": "completed",
  "data": {
    "subTaskList": [
      {
        "subTaskId": "4124831",
        "platform": "deepseek",
        "mode": "search",
        "prompt": "What are the best CRM tools?",
        "status": "completed",
        "answerContent": "### Best CRM Tools...\n\n1. **Salesforce** ...",
        "referenceList": [
          {"index": 1, "title": "CRM Comparison 2026", "url": "https://...", "site": "TechReview", "icon": "https://..."}
        ],
        "citationList": [
          {"index": 1, "title": "CRM Comparison 2026", "url": "https://...", "site": "TechReview", "icon": "https://..."}
        ],
        "reasoningProcess": { "summary": "", "content": "" },
        "recommendedQuestions": ["What is the pricing for Salesforce?"],
        "mediaContent": [],
        "pageScreenshot": "https://..."
      }
    ]
  }
}

Get available region codes for geo-targeted queries. No authentication required.

curl https://api.geotoolhub.com/v1/regions

# Response:
{
  "regions": [
    {"province": "北京市", "regionCode": ["110000"]},
    {"province": "上海市", "regionCode": ["310000"]},
    {"province": "广东省", "regionCode": ["440000"]}
  ]
}

Pass regionCode in the submit request to simulate queries from a specific Chinese province.

Supported Platforms

Error Codes

Rate Limits

Rate limits depend on your subscription plan. Tasks typically complete in 2-3 minutes. Results are cached for identical queries within 24 hours.