BixelDocs
API reference

Search companies

GET
/v1/search

Resolve a free-text name to canonical identifiers: top-10 matching companies (by domain, slug, or name) and categories. The entry point when you don't know the apex domain yet.

Query Parameters

q*string

Free text: a company name, domain fragment, or category name.

Lengthlength <= 100

Response Body

application/json

application/problem+json

application/problem+json

curl -X GET "https://example.com/v1/search?q=pinecone"
{  "data": {    "query": "string",    "companies": [      {        "name": "string",        "domain": "string",        "slug": "string"      }    ],    "categories": [      {        "slug": "string",        "name": "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"}