companies

Get Company

get/api/v1/companies/{ticker}

Request

Base URL
https://usebolsai.com (the document declares no server; this is the origin it was published from)
Auth
API key in header X-API-Key
TypeScript
https://skmtc.dev/usebolsai/apis/bolsai/docs/api/v1/companies/:ticker/get.ts
A function with typed inputs. Its response is checked against the schema.

tickerstring required

formatstring

Response format: json or csv

Successful Response

cvm_codestring required

cnpjstring required

corporate_namestring required

trade_namestring nullable required

ticker_primarystring nullable

queried_tickerstring nullable

tickersstring[]

sectorstring nullable required

statusstring nullable required

registration_datestring date nullable required

registration_categorystring nullable required

market_typestring nullable required

countrystring nullable required

statestring nullable required

citystring nullable required

emailstring nullable required

websitestring nullable required

Jul 26, 202659340bd46c6c Revision changes
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status