API Documentation

Integrate GeoScrape Nexus directly into your applications.

Authentication

Authenticate requests using the X-API-KEY header.

X-API-KEY: your_api_key_here

Scrape Data

POST /api/scrape

Request Body (JSON)

Field	Type	Description
query	string	Search term (e.g., "Pizza in NYC")
limit	integer	Max results (5, 10, 20, 50)
webhook_url	string	Optional. URL to receive results.

Example Request

curl -X POST https://geoscrape.alfidigital.com/api/scrape \
  -H "Content-Type: application/json" \
  -H "X-API-KEY: sk_12345" \
  -d '{
    "query": "Gyms in London",
    "limit": 10,
    "webhook_url": "https://your-site.com/webhook"
  }'

Check Balance

GET /api/balance

Returns the current credit balance for the API key.