Developer quick start

Make your first API request.

Most API endpoints use an API key in the X-API-Key request header. Batch IP enrichment is available without an API key and is rate-limited like web lookups.

IP detail

Replace 1.2.3.4 with an IPv4 address and YOUR_API_KEY with your own key. Keep the key private and do not commit it to source control.

curl --request GET \
  --url https://griffinguard.io/api/ipquery/1.2.3.4 \
  --header "X-API-Key: YOUR_API_KEY"

A successful response contains the network details and any available observations for that address. A 404 means no record is available; 401 means the key is missing or invalid. The public web lookup is separate from this key-protected endpoint.

Try building a request

curl --request GET \
  --url https://griffinguard.io/api/ipquery/1.2.3.4 \
  --header "X-API-Key: YOUR_API_KEY"

Endpoint guide

EndpointUseLimit
GET /api/ipquery/:ipIP detailsAPI key quota
GET /api/ipquery/:ip/activityDaily activity timelineUp to 365 days
POST /api/ipquery/batchBatch GeoIP/ASN enrichmentNo API key; 10/hour guests, 50/hour when signed in; up to 100 IPv4s
GET /api/scansPaginated scan feedPage size up to 500
GET /api/feeds/:id/dataPaginated saved feedAPI key quota; page size up to 500
GET /api/usageKey usage and quotaAPI key required

Each saved feed has a URL like /api/feeds/FEED_ID/data?limit=100. Send your API key in the X-API-Key header. Follow the returned next_cursor by adding it as a cursor query parameter; each page request counts toward your API key quota.

Public web lookups: 10/hour for guests and 50/hour when signed in. API-key quotas are key/plan-specific; call /api/usage for the current allowance.

Next steps

  • See the Swagger reference for endpoint parameters, response codes, and batch lookup.
  • Use the dashboard or IP lookup to investigate observations interactively.
  • Review the methodology and limitations before automating response actions.