BixelDocs
API reference

Request coverage of a domain

POST
/v1/coverage/requests

Ask Bixel to check whether a domain is company-shaped and worth adding (D22, D24): a request to CHECK, never a mint on ask. The six-part gate decides from stored evidence now (registrable, not a platform tenant, not covered, not already queued, live, within quota); the crawl host probes, banks, names and mints a brand later, and GET /v1/resolve flips to resolved when it lands. Keyless callers get queued_for_capture false with queue_reason account_required and the web request page (one anonymous request a day lives there); nothing is written for them. Quotas: free 50 a day, paid rungs uncapped with queue priority; counters reset 00:00 UTC. Costs 1 credit; the queue itself draws none.

Authorization

AuthorizationBearer <token>

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

curl -X POST "https://example.com/v1/coverage/requests" \  -H "Content-Type: application/json" \  -d '{}'
{  "data": {    "queued_for_capture": true,    "request_id": "string",    "check_url": "string",    "expected_by": "2019-08-24T14:15:22Z",    "queue_reason": "account_required",    "request_page_url": "string",    "request": {      "request_id": "string",      "input": "string",      "apex_domain": "string",      "status": "queued",      "gate_verdict": "admitted",      "gate_reason": "string",      "outcome_reason": "string",      "bixel_id": "string",      "capture_ref": "string",      "created_at": "2019-08-24T14:15:22Z",      "started_at": "2019-08-24T14:15:22Z",      "finished_at": "2019-08-24T14:15:22Z",      "check_url": "string"    },    "covered": true,    "reason": "string",    "cap": 0,    "resets_at": "2019-08-24T14:15:22Z"  },  "meta": {    "generated_at": "2019-08-24T14:15:22Z",    "count": 0,    "total": 0,    "next_cursor": "string",    "notice": "string",    "window": {      "served_from": "string",      "earliest_event_at": "string",      "events_beyond_window": true    },    "data_version": "string",    "resolved_at": "2019-08-24T14:15:22Z",    "attribution": {      "source": "Bixel",      "url": "string",      "license": "CC-BY-4.0",      "notice": "from Bixel",      "data_version": "string"    }  }}
{  "type": "http://example.com",  "title": "string",  "status": 0,  "code": "company_not_found",  "detail": "string",  "hint": "string",  "docs_url": "http://example.com"}
{  "type": "http://example.com",  "title": "string",  "status": 0,  "code": "company_not_found",  "detail": "string",  "hint": "string",  "docs_url": "http://example.com"}
{  "type": "http://example.com",  "title": "string",  "status": 0,  "code": "company_not_found",  "detail": "string",  "hint": "string",  "docs_url": "http://example.com"}