Roic

ROIC API

The ROIC API reference for v3 (/v3.0.0) and legacy v2 (/v2). In v3, Bearer authentication is recommended because it keeps credentials out of URLs. For browser…

Finance & banking#finance

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

The ROIC API reference for v3 (/v3.0.0) and legacy v2 (/v2). In v3, Bearer authentication is recommended because it keeps credentials out of URLs. For browser testing, you may instead pass your key as the apikey query parameter. Use exactly one authentication method per request, never both. v2 takes the key only as the apikey query parameter.

Endpoints 81

Reference Data

  • GETList exchanges/v3.0.0/exchangesReturns every exchange in one response, with segment MICs, names, markets, and symbol counts. Each code can be passed to the ticker-list exchange filter.
  • GETRetrieve exchange trading hours/v3.0.0/exchanges/trading-hours?exchange=stringRetrieves the complete regular and extended trading-hours history of one exchange as structured arrays.
  • GETRetrieve exchange holidays/v3.0.0/exchanges/holidays?exchange=stringRetrieves the holiday calendar of one exchange by exchange code, as YYYY-MM-DD dates.
  • GETList markets/v3.0.0/marketsReturns every market in one response, with its exchanges, listing country, and symbol count. Each code can be passed to the ticker-search market filter.
  • GETList sectors/v3.0.0/sectorsReturns every company sector in one response, with symbol counts.
  • GETList industries/v3.0.0/industriesReturns every company industry in one response, with symbol counts.
  • GETList countries/v3.0.0/countriesReturns every company country in one response, with names, ISO codes, and symbol counts.
  • GETList all tickers/v3.0.0/tickersReturns a filtered page of ticker resources.
  • GETSearch tickers/v3.0.0/tickers/search?query=stringRanks ticker codes and qualified symbols with typo-tolerant ranking by default. Set 'search_by' to 'name' to rank company names, or to another ticker field…
  • GETRetrieve a ticker/v3.0.0/tickers/:identifierRetrieves one ticker by public ID or supported market identifier.
  • GETRetrieve a company profile/v3.0.0/company/profile/:identifierRetrieves a primary-listing company profile by public profile ID or supported market identifier.
  • GETList historical employee counts/v3.0.0/company/employeesReturns a page of fiscal-year employee counts across all companies, or one company via the identifier filter. Any listing identifier resolves to the primary…
  • GETRetrieve a company logo/v3.0.0/company/logo/:identifierReturns a resized company logo as WebP or PNG image bytes. Secondary listings resolve to the primary company logo.

Market Data

  • GETList stock splits/v3.0.0/stock-splitsReturns a page of per-ticker stock-split events across all tickers, or one ticker via the identifier filter.
  • GETList latest stock prices/v3.0.0/stock-prices/latestReturns a page with one row per ticker carrying its latest available daily OHLCV quote from the last 10 days. Tickers without a price in that window (halted,…
  • GETList historical stock prices/v3.0.0/stock-prices/:identifierReturns a page of historical daily prices for a ticker, symbol, or other supported security identifier.
  • GETRetrieve the latest stock price/v3.0.0/stock-prices/latest/:identifierReturns the latest available daily price for a ticker, symbol, or other supported security identifier.

Fundamentals

  • GETList income statements/v3.0.0/fundamental/income-statement/:identifierReturns income-statement line items by financial period.
  • GETList balance sheets/v3.0.0/fundamental/balance-sheet/:identifierReturns balance-sheet line items by financial period.
  • GETList cash flow statements/v3.0.0/fundamental/cash-flow/:identifierReturns cash-flow line items by financial period.
  • GETList profitability ratios/v3.0.0/fundamental/ratios/profitability/:identifierReturns profitability ratios by financial period.
  • GETList credit ratios/v3.0.0/fundamental/ratios/credit/:identifierReturns credit and debt values by financial period.
  • GETList liquidity ratios/v3.0.0/fundamental/ratios/liquidity/:identifierReturns liquidity ratios by financial period.
  • GETList working-capital ratios/v3.0.0/fundamental/ratios/working-capital/:identifierReturns working-capital ratios by financial period.
  • GETList yield-analysis ratios/v3.0.0/fundamental/ratios/yield-analysis/:identifierReturns yield-analysis ratios by financial period.
  • GETList enterprise values/v3.0.0/fundamental/enterprise-value/:identifierReturns enterprise values by financial period.
  • GETList valuation multiples/v3.0.0/fundamental/multiples/:identifierReturns valuation multiples by financial period.
  • GETList per-share metrics/v3.0.0/fundamental/per-share/:identifierReturns per-share metrics by financial period.

Forex

  • GETList forex pairs/v3.0.0/forex-pairsReturns a page of tradable currency pairs with their currency codes and human-readable names. Use a pair symbol from this list with the forex price endpoints.
  • GETList latest forex prices/v3.0.0/forex-prices/latestReturns a page with one row per currency pair carrying its latest available daily OHLC quote from the last 10 days. Pairs without a price in that window…
  • GETList historical forex prices/v3.0.0/forex-prices/:identifierReturns a page of historical daily prices for a currency pair, addressed by bare currency-pair code or qualified pair symbol.
  • GETRetrieve the latest forex price/v3.0.0/forex-prices/latest/:identifierReturns the latest available daily price for a currency pair, addressed by bare currency-pair code or qualified pair symbol.

Content

  • GETList earnings calls/v3.0.0/earnings-callsReturns earnings-call summaries across all companies. Free plans can access each company’s latest two calls; paid-plan history follows the plan’s lookback…
  • GETRetrieve an earnings call/v3.0.0/earnings-calls/:identifier?fiscal_year=0&fiscal_quarter=0Returns one complete earnings-call transcript for a company and fiscal period. Free plans can retrieve the company’s latest two calls; paid-plan history…
  • GETList news/v3.0.0/newsReturns news articles from publishers and articles ROIC writes, newest first. Each article appears once, with every company it is about. History follows the…
  • GETList company news/v3.0.0/news/:identifierReturns the news articles about one company, newest first. Identify the company by an exchange and symbol separated by a colon (e.g. NASDAQ:AAPL), a ticker…

Calendar

  • GETList earnings calendar events/v3.0.0/calendar/earningsReturns a page of dated earnings events across all tickers, or one ticker via the identifier filter. Each event carries the scheduled release date and session…

Company Events

  • GETList company earnings events/v3.0.0/company-eventsReturns earnings events with everything attached to them: the transcript in transcripts, one entry per edition (raw and edited) with a stable id, audio…
  • GETRetrieve a raw transcript/v3.0.0/documents/transcripts/:id/rawReturns the plain-text transcript of an earnings event, without speaker labels or line breaks. Free plans can read each company’s latest two events;…
  • GETRetrieve an edited transcript/v3.0.0/documents/transcripts/:id/editedReturns the speaker-labelled transcript of an earnings event: ordered segments with a speaker_id, and a speakers map with each speaker’s name, role, and…
  • GETRetrieve a slide deck/v3.0.0/documents/slides/:idReturns the metadata of an earnings-event slide deck together with a signed download URL that expires at expires_at (one hour by default). Professional and…
  • GETRetrieve a filing/v3.0.0/documents/filings/:idReturns the metadata of an earnings-event filing (earnings release, quarterly or annual report, and similar) together with a signed download URL that expires…
  • GETRetrieve an audio recording/v3.0.0/documents/audio/:idReturns the metadata of an earnings-call audio recording together with a signed download URL that expires at expires_at (one hour by default). Professional…

Bulk Downloads

  • GETList bulk fundamentals files/v3.0.0/fundamental/bulkLists pre-generated CSV files partitioned by fiscal year and financial cadence, each with a short-lived signed download URL. Filter with the optional year and…
  • GETList bulk earnings-call files/v3.0.0/earnings-calls/bulkLists pre-generated transcript CSV files partitioned by fiscal year and quarter, each with a short-lived signed download URL. Filter with the optional year…
  • GETList bulk stock-price files/v3.0.0/stock-prices/bulkLists pre-generated daily-price CSV files partitioned by calendar year and month, each with a short-lived signed download URL. Filter with the optional year…
  • GETgetV2TickersList/v2/tickers/list
  • GETgetV2TickersSearch/v2/tickers/search?query=string
  • GETgetV2TickersSearchName/v2/tickers/search/name?query=string
  • GETgetV2TickersSearchCikByCik/v2/tickers/search/cik/:cik
  • GETgetV2TickersSearchCusipByCusip/v2/tickers/search/cusip/:cusip
  • GETgetV2TickersSearchIsinByIsin/v2/tickers/search/isin/:isin
  • GETgetV2TickersSearchExchangeByExchange/v2/tickers/search/exchange/:exchange
  • GETgetV2ExchangesList/v2/exchanges/list
  • GETgetV2SectorsList/v2/sectors/list
  • GETgetV2IndustriesList/v2/industries/list
  • GETgetV2CountriesList/v2/countries/list
  • GETgetV2CompanyProfileByIdentifier/v2/company/profile/:identifier
  • GETgetV2CompanyNewsByIdentifier/v2/company/news/:identifier
  • GETgetV2CompanyLogoByIdentifier/v2/company/logo/:identifier
  • GETgetV2CompanyEarnings-callsLatestByIdentifier/v2/company/earnings-calls/latest/:identifier
  • GETgetV2CompanyEarnings-callsListByIdentifier/v2/company/earnings-calls/list/:identifier
  • GETgetV2CompanyEarnings-callsTranscriptByIdentifier/v2/company/earnings-calls/transcript/:identifier?year=0&quarter=0
  • GETgetV2Stock-pricesByIdentifier/v2/stock-prices/:identifier
  • GETgetV2Stock-pricesLatestByIdentifier/v2/stock-prices/latest/:identifier
  • GETgetV2Stock-splits/v2/stock-splits
  • GETgetV2Stock-splitsByIdentifier/v2/stock-splits/:identifier
  • GETgetV2FundamentalIncome-statementByIdentifier/v2/fundamental/income-statement/:identifier
  • GETgetV2FundamentalBalance-sheetByIdentifier/v2/fundamental/balance-sheet/:identifier
  • GETgetV2FundamentalCash-flowByIdentifier/v2/fundamental/cash-flow/:identifier
  • GETgetV2FundamentalRatiosProfitabilityByIdentifier/v2/fundamental/ratios/profitability/:identifier
  • GETgetV2FundamentalRatiosCreditByIdentifier/v2/fundamental/ratios/credit/:identifier
  • GETgetV2FundamentalRatiosLiquidityByIdentifier/v2/fundamental/ratios/liquidity/:identifier
  • GETgetV2FundamentalRatiosWorking-capitalByIdentifier/v2/fundamental/ratios/working-capital/:identifier
  • GETgetV2FundamentalRatiosYield-analysisByIdentifier/v2/fundamental/ratios/yield-analysis/:identifier
  • GETgetV2FundamentalEnterprise-valueByIdentifier/v2/fundamental/enterprise-value/:identifier
  • GETgetV2FundamentalMultiplesByIdentifier/v2/fundamental/multiples/:identifier
  • GETgetV2FundamentalPer-shareByIdentifier/v2/fundamental/per-share/:identifier
  • GETgetV2ExcelMetrics/v2/excel/metrics
  • POSTpostV2ExcelData/v2/excel/data
  • GETgetV2Usage/v2/usage

API details

Base URL
https://api.roic.ai
Authentication
A bearer token in the Authorization header
An API key in the apikey query parameter
Operations
81 operations on 81 pathsGET 80POST 1
Main resources
Reference Data 13Fundamentals 11Company Events 6Content 4Forex 4Market Data 4Bulk Downloads 3Calendar 1
Response formats
application/json image/png image/webp
Description format
OpenAPI 3.0.3, API version 3.0.0

How to test the ROIC API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the ROIC API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses A bearer token in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “List exchanges” (GET /v3.0.0/exchanges), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the ROIC API?

The ROIC API reference for v3 (/v3.0.0) and legacy v2 (/v2). In v3, Bearer authentication is recommended because it keeps credentials out of URLs. For browser… It is listed under Finance & banking and has 81 endpoints.

Who publishes the ROIC API?

It is listed from Roic's public API description (an OpenAPI document), not published by Roic on Swastik Codes. Anyone who controls roic.ai can claim the profile by adding a DNS TXT record.

What is the base URL of the ROIC API?

Requests go to https://api.roic.ai. Endpoint paths are added to this base URL.

How do I authenticate with the ROIC API?

It accepts 2 methods: A bearer token in the Authorization header; an API key in the apikey query parameter.

How many endpoints does the ROIC API have?

81 operations on 81 paths (80 GET, 1 POST). The largest groups are Reference Data, Fundamentals, Company Events, Content.

Is forking the ROIC API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.