BixelDocs
API reference

Read a company now

POST
/v1/companies/{company}/reads

A fresh full read of ONE company, once: Bixel reads the company's own pages now and nothing follows — no re-read list, no alerts (that is POST /v1/coverage/requests, "keep checking"). 25 credits, settled only when the fresh record lands with facts; a read that fails or publishes nothing is never charged. A record read within the last 7 days is served as it is (status fresh, nothing charged) — the second reader in the window costs nothing. Free accounts get 5 reads a month; at most 20 reads in flight per account; an account whose last landed read could not be charged waits until credits are added (403 read_limit_reached). A live domain Bixel has never covered is checked first for free (the coverage request gate and quota) and read once when its identity lands: the answer carries queued_for_capture, request_id and check_url like POST /v1/coverage/requests plus read.status identity_queued. Managing the ask costs 0 credits. Landing times measured 10/22: two to three minutes for a company already in the identity layer, three to six for one never seen (identity first). The answer carries the read's state; fetch the record with GET /v1/companies/{company} once it lands.

Authorization

AuthorizationBearer <token>

bx_-prefixed API key. Free keys: https://bixel.com/account/

In: header

Path Parameters

company*string

Apex domain (canonical, e.g. pinecone.io). Bare values are resolved as legacy slugs. Unknown names: resolve via /v1/search first.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X POST "https://example.com/v1/companies/pinecone.io/reads"
{  "data": {    "company": {      "domain": "string"    },    "read": {      "status": "fresh",      "request_id": "string",      "check_url": "string",      "read_at": "2019-08-24T14:15:22Z",      "credits_due": 0,      "credits_charged": 0,      "settlement": "charged",      "requested_at": "2019-08-24T14:15:22Z",      "finished_at": "2019-08-24T14:15:22Z",      "continues_as": "read_once",      "note": "string"    },    "queued_for_capture": true,    "request_id": "string",    "check_url": "string",    "expected_by": "2019-08-24T14:15:22Z",    "queue_reason": "string"  },  "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"}
{  "type": "http://example.com",  "title": "string",  "status": 0,  "code": "company_not_found",  "detail": "string",  "hint": "string",  "docs_url": "http://example.com"}