Quickstart
1. Create an account
Section titled “1. Create an account”curl -X POST https://api.gazetteer.dev/auth/register \ -H "Content-Type: application/json" \ -d '{"email": "you@example.com", "password": "your-password"}'Save the token from the response — you’ll need it to manage your account.
2. Create an API key
Section titled “2. Create an API key”curl -X POST https://api.gazetteer.dev/auth/keys \ -H "Authorization: Bearer <your-jwt-token>" \ -H "Content-Type: application/json" \ -d '{"name": "my-first-key"}'3. Buy credits
Section titled “3. Buy credits”curl -X POST https://api.gazetteer.dev/billing/purchase \ -H "Authorization: Bearer <your-jwt-token>" \ -H "Content-Type: application/json" \ -d '{"package": "1000"}'Pay the PIX QR code returned in the response. Credits are added to your account automatically after payment confirmation.
4. Make your first request
Section titled “4. Make your first request”curl -X POST https://api.gazetteer.dev/geo/resolve \ -H "Authorization: Bearer gaz_<your-api-key>" \ -H "Content-Type: text/plain" \ --data "CuiabáSinopRondonópolis"Response:
{ "region": "Mato Grosso", "type": "state", "region_id": 3457419, "unresolved": 0, "total": 3}Each successful request to /geo/resolve, /geo/place/{id}, or /geo/search deducts 1 credit from your balance.