Discover the API

API Documentation

Welcome to our API documentation! Here you will find detailed information about the available endpoints, tickers, fields, and limits for accessing financial data. We also provide sections on finance, account management, and getting started with the API. Additionally, you can learn about your plan and API limit. Start exploring and leveraging our powerful financial data API today!


Get Started
To get started with our API, you will need to obtain an API key. You can sign up for a free key by clicking the "Free Key" button below. Once you have your API key, you can start making requests to our endpoints to access the data.

Your Plan
No active plan.
Your API Limit

100 per minute

Requests

7 calls



Structure

Learn how to structure an API call


API Key

How to use your API Key

In order to make an call, you will need to pass an API key into the URL or the header of your request. This can be anywhere in the URL or header, but must be in the format: apiKey={yourApiKey}

bdpo.io/api/endpoint?apiKey={yourApiKey}


Endpoints

How to use our endpoints

In order to make an call, you will need to pass an Endpoint into the URL or the header of your request. This can be anywhere in the URL or header, but must be in the format, the list of endpoints are future in the docs. /{endpoint}

bdpo.io/api/income_statement?apiKey={yourApiKey}


Tickers

How to pass in tickers

In order to make an call, you will need to pass a ticker or a list of tickers into the URL or the header of your request. This can be anywhere in the URL or header, but must be in the format: tickers={ticker} or tickers={ticker1,ticker2}

bdpo.io/api/income_statement?apiKey={yourApiKey}&tickers=AAPL,GOOG


Fields

How to select your fields

In order to make an call, you will need to pass a field or a list of fields into the URL or the header of your request. This can be anywhere in the URL or header, but must be in the format below. A list of fields are in the docs of each endpoint. fields={field} or fields={field1,field2}

bdpo.io/api/income_statement?apiKey={yourApiKey}&tickers=AAPL&fields=revenue,net_income


Limits

How to set a response limit

By default the response limit is 1. If you want to number of datapoints, you will need to pass a limit into the URL or the header of your request. This can be anywhere in the URL or header, but must be in the format below: limit={limit}

bdpo.io/api/income_statement?apiKey={yourApiKey}&tickers=AAPL&fields=revenue,net_income&limit=5


Income Statement

Explore the income statement API

Our income statement API has been designed in a way that allows you to query the underlying data quickly and for multiple tickers. Use the endpoint /income_statement. You are then able to set the periods back using the limit parameter. The fields parameter then allows you to select the data you want to see, the list of fields are in the income statement docs below. You are able to select as many fields as you want.

bdpo.io/api/income_statement?apiKey={yourApiKey}&tickers=AAPL&fields=operating_income&limit=1


Revenue

How to get the top line revenue

Use the field revenue to get the top line revenue for companies.

bdpo.io/api/income_statement?apiKey={yourApiKey}&tickers=AAPL&fields=revenue

Example response

{
  "AAPL": {
    "revenue": [
      {
        "accn": "0000320193-23-000106",
        "end": "2023-09-30",
        "filed": "2023-11-03",
        "form": "10-K",
        "fp": "FY",
        "frame": "CY2023",
        "start": "2022-09-25",
        "val": 383285000000
      }
    ]
  }
}

Diluted EPS

How to get the diluted EPS

Use the field eps_diluted to get the top line diluted EPS for companies.

bdpo.io/api/income_statement?apiKey={yourApiKey}&tickers=AAPL&fields=eps_diluted

Example response

{
  "AAPL": {
    "eps_diluted": [
      {
        "accn": "0000320193-23-000106",
        "end": "2023-09-30",
        "form": "10-K",
        "fp": "FY",
        "frame": "CY2023",
        "start": "2022-09-25",
        "val": 6.13
      }
    ]
  }
}