Companies
Find a company and retrieve its identifiers and reporting information.
A company record is called an entity in the API. Use company search to
obtain an entity_id, then use that ID to retrieve its information, documents,
wiki, or financial dataset.
These endpoints require entities:read permission. Examples assume you have
an access token stored as ACCESS_TOKEN.
Search companies
GET /v1/entities
| Query parameter | Required | Meaning |
|---|---|---|
q | Yes | Company name or ticker to search for |
limit | No | Requested page size; default 10, effective maximum 25 |
cursor | No | Continuation value from the previous response's next_cursor |
curl --fail-with-body --silent --show-error --get \
'https://api.finbar.com/v1/entities' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--data-urlencode 'q=AAPL' \
--data-urlencode 'limit=5'
The entities array contains entity_id, name and score for each match.
score measures search relevance; results are ordered with the most relevant
first. Search only returns companies available to your account. A strong exact
match may be returned on its own.
If next_cursor is present, pass it as cursor with the same q to read the
next page. An empty array means no available matches.
Read company information
GET /v1/entities/{entity_id}
Set ENTITY_ID to an ID from search:
curl --fail-with-body --silent --show-error \
"https://api.finbar.com/v1/entities/$ENTITY_ID" \
--header "Authorization: Bearer $ACCESS_TOKEN"
The response identifies the company and includes available tickers, security identifiers, investor-relations website and upcoming reporting information. An ISIN is an international identifier for a security; a ticker is its trading symbol. Optional information may be absent.
GET /v1/entities/{entity_id} — 200 response
Example response. IDs and values are illustrative.
Show less
{
"entity_id": "O-03049bdc0cb94012b761a4c3046c2a2d",
"name": "Apple Inc.",
"ticker": [
"AAPL US"
],
"isin": [
"US0378331005"
],
"ir_website_url": "https://investor.apple.com",
"next_report_date": "2026-10-29T00:00:00Z",
"next_report_period": {
"year": 2026,
"period_type": "Q",
"period": 4
}
}
Use the company's ID to list its documents or
discover its dataset. IDs for documents, paragraphs and
tables cannot be used in place of an entity_id.
Read company wiki
GET /v1/entities/{entity_id}/wiki
Retrieve the saved OVERVIEW, PRODUCTS, GEOGRAPHY, SEGMENTS, and HISTORY
sections. Omit types to request all sections, or repeat it to select sections:
curl --fail-with-body --silent --show-error --get \
"https://api.finbar.com/v1/entities/$ENTITY_ID/wiki" \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--data-urlencode 'types=OVERVIEW' \
--data-urlencode 'types=PRODUCTS'
GET /v1/entities/{entity_id}/wiki — 200 response
Example response. IDs and values are illustrative.
Show less
{
"entity_id": "O-03049bdc0cb94012b761a4c3046c2a2d",
"sections": [
{
"type": "OVERVIEW",
"content": "Apple designs and sells consumer electronics and services [https://www.apple.com]."
}
]
}
The response contains the canonical entity_id and a sections array of
type and content pairs, ordered overview, products, geography, segments,
then history. Duplicate filters are ignored. Types are case-sensitive; use
repeated query parameters, not comma-separated or JSON-encoded arrays.
Available sections may be missing or contain empty text; a company with no wiki
sections returns an empty array. Inline source citations are preserved. Use the document read endpoint
with documents:read to retrieve cited paragraph or table IDs; web citations
remain URLs. Each wiki request uses the shared data-request quota and does
not generate new content or incur an AI generation charge.
Search company wikis
POST /v1/wiki-search
Find companies by keywords in their saved wiki sections:
curl --fail-with-body --silent --show-error \
'https://api.finbar.com/v1/wiki-search' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header 'Content-Type: application/json' \
--data '{"query":"semiconductor manufacturing equipment","types":["PRODUCTS","OVERVIEW"],"limit":10}'
Search uses English full-text matching, including quoted phrases, OR, and
minus-prefixed exclusions. Search runs across company wikis. Omitted or empty
types searches all five section types.
Each item in results contains entity_id, name, a relevance score, and
up to three matching sections with type and preview. Companies appear once,
ranked by their best matching section. Previews show the first 500 characters of
the saved section; read the full wiki for complete text and citations.
search_mode is keyword.
Pages default to 10 companies, with a maximum of 25. When next_cursor is
present, send it as cursor with the same query and filters; limit may change.
Results remain stable until expires_at, ten minutes after the initial search.
A cursor is bound to your identity and filters. Invalid or expired cursors return
400; restart without a cursor. Searches return at most 200 companies and are
not exhaustive exports. Each page uses one data request under entities:read.