Skip to content
Geo API Docs

Quickstart

1. Create an account

Section titled “1. Create an account”

Sign up at /auth/register.

2. Create an API key

Section titled “2. Create an API key”

Once logged in, head to the API Keys page in your dashboard and click New key. You can pick either tier:

  • Free — 50 requests/day, no payment required. One active free key per account.
  • Paid — no daily limit, each request consumes 1 credit.

3. (Paid keys only) Buy credits

Section titled “3. (Paid keys only) Buy credits”

Skip this step if you’re using a free key.

Go to the Billing page, pick a package, and pay the PIX QR code:

  • R$ 10 → 10,000 credits
  • R$ 15 → 25,000 credits
  • R$ 25 → 50,000 credits

Credits are added to your balance automatically once the payment is confirmed.

4. Make your first request

Section titled “4. Make your first request”

Base URL: https://api.hlgsws.xyz

Terminal window
curl -X POST https://api.hlgsws.xyz/geo/resolve \
  -H "Authorization: Bearer gaz_<your-api-key>" \
  -H "Content-Type: text/plain" \
  --data "Cuiabá
Sinop
Rondonópolis"

Response:

{
  "region": "Mato Grosso",
  "type": "state",
  "region_id": 3457419,
  "unresolved": 0,
  "total": 3,
  "locationIds": [
    { "name": "Cuiabá",       "id": 3664728 },
    { "name": "Sinop",        "id": 3449581 },
    { "name": "Rondonópolis", "id": 3451638 }
  ]
}

Each successful request to /geo/resolve, /geo/place/{id}, or /geo/search either deducts 1 credit from your balance (paid keys) or counts against your 50/day quota (free keys).