Getting Started

Three steps to your first API call.

1. Get Your API Key

Create a free account. No credit card required.

Go to Settings → API Keys and create a key:

• Format: hb_live_xxxxxxxxxxxxx

TIP

Store your API key securely. You won't be able to see the full key again after creation.

2. Make a Request

cURL

curl -H "X-API-Key: hb_live_xxxxx" \
  "https://api.hummingbirdapi.com/v1/geo/lookup"

JavaScript

const response = await fetch(
  'https://api.hummingbirdapi.com/v1/geo/lookup',
  { headers: { 'X-API-Key': 'hb_live_xxxxx' } }
);
const data = await response.json();

Python

import requests

response = requests.get(
    'https://api.hummingbirdapi.com/v1/geo/lookup',
    headers={'X-API-Key': 'hb_live_xxxxx'}
)
data = response.json()

3. Get the Response

{
  "success": true,
  "data": {
    "ip": "203.0.113.42",
    "continent_code": "NA",
    "continent_name": "North America",
    "country_code": "US",
    "country_name": "United States",
    "region_name": "California",
    "city_name": "San Francisco",
    "postal_code": "94102",
    "latitude": 37.7749,
    "longitude": -122.4194,
    "time_zone": "America/Los_Angeles",
    "weather_code": "USCA0987",
    "is_eu": false,
    "asn": 7922,
    "asn_organization": "Comcast Cable Communications, LLC",
    "isp": "Comcast Cable",
    "organization": "Comcast Cable",
    "connection_type": "Cable/DSL",
    "user_type": "residential"
  }
}

Next Steps

• Authentication — API key security
• Rate Limits — Request limits and quotas
• IP Geolocation API — Full endpoint reference
• Error Codes — Troubleshooting