API Reference
Markdown

Datasets, feedback & status

Inspect active and historical dataset snapshots (/v1/metadata/datasets), submit network corrections (/v1/feedback), and probe service health (/v1/status).

# 1. Dataset snapshots metadata (`GET /v1/metadata/datasets`)

GEThttps://api.ipscope.io/v1/metadata/datasetsscope: lookup API key

Returns the currently active dataset snapshot version, the previous rollback snapshot version, and the list of compiled snapshot manifests (DatasetsMetadataResponse).

curl -sS "https://api.ipscope.io/v1/metadata/datasets" \
  -H "Authorization: Bearer $IPSCOPE_KEY"
Responses
application/json

Active and historical dataset snapshot manifests and prefix counts.

{
  "active_version": "2026-10-27T00:00:00Z.crawl-1793088000000",
  "previous_version": "2026-10-26T00:00:00Z.crawl-1793001600000",
  "snapshots": [
    {
      "snapshot_version": "2026-10-27T00:00:00Z.crawl-1793088000000",
      "digest": "sha256:9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
      "ruleset_version": "2026.10.2",
      "published_at": "2026-10-27T00:00:00Z",
      "ipv4_prefix_count": 28410200,
      "ipv6_prefix_count": 6912400
    }
  ]
}

# 2. Submit a correction report (`POST /v1/feedback`)

POSThttps://api.ipscope.io/v1/feedbackscope: lookup · 201 Created API key

Programmatically submit a geolocation, virtual-location, or VPN/anonymizer false-positive correction report. Submissions are persisted via PlatformStateService with status pending_review and feed directly into our RFC 8805 geofeed and active-probe verification pipeline.

Request bodyFeedbackSubmissionRequestDtoapplication/json
curl -sS -X POST "https://api.ipscope.io/v1/feedback" \
  -H "Authorization: Bearer $IPSCOPE_KEY" \
  -H "Content-Type: application/json" \
  -d '{"prefix_or_ip":"198.51.100.0/24","role":"network_owner","issue_type":"wrong_city","requested_correction":{"country_code":"US","city":"Ashburn"},"evidence_url":"https://example.net/geofeed.csv"}'
Responses
application/json

Correction report queued for automated geofeed & active-probe review.

{
  "id": "fb_01J8Z5A9M4",
  "prefix_or_ip": "198.51.100.0/24",
  "role": "network_owner",
  "issue_type": "wrong_city",
  "requested_correction": {
    "country_code": "US",
    "city": "Ashburn"
  },
  "evidence_url": "https://example.net/geofeed.csv",
  "contact_consent": true,
  "contact_email": "noc@example.net",
  "createdAt": "2026-10-27T01:15:00.000Z",
  "status": "pending_review"
}

# 3. Service liveness & snapshot status (`GET /v1/status`)

GEThttps://api.ipscope.io/v1/statusPublic · Unmetered No key

Unauthenticated health check endpoint (GET /v1/status). Returns status: "ok" alongside the node’s currentVersion and previousVersion snapshot identifiers. Does not require an API key and never counts against rate limits or lookup credits.

curl -sS "https://api.ipscope.io/v1/status"
Responses
application/json

Node liveness and loaded snapshot versions.

{
  "status": "ok",
  "snapshot": {
    "currentVersion": "2026-10-27T00:00:00Z.crawl-1793088000000",
    "previousVersion": "2026-10-26T00:00:00Z.crawl-1793001600000"
  }
}