API Documentation
Welcome to the marketstack API documentation! In the following series of articles you will learn how to query the marketstack JSON API for real-time, intraday and historical stock market data, define multiple stock symbols, retrieve extensive data about 2700+ stock exchanges, 50000+ stock tickers from more than 50 countries, as well as 100+ stock market indexes, information about timezones, currencies, and more.
Our API is built upon a RESTful and easy-to-understand request and response structure. API requests are always sent using a simple API request URL with a series of required and optional HTTP GET parameters, and API responses are provided in lightweight JSON format. Continue below to get started, or click the blue button above to jump to our 3-Step Quickstart Guide.
Fork collection into your workspace
Getting Started
API Authentication
For every API request you make, you will need to make sure to be authenticated with the API by passing your API access key to the API's access_key
parameter. You can find an example below.
Example API Request:
Sign Up to Run API Requesthttps://api.marketstack.com/v2/eod ? access_key = YOUR_ACCESS_KEY & symbols = AAPL
Important: Please make sure not to expose your API access key publicly. If you believe your API access key may be compromised, you can always reset in your account dashboard.
256-bit HTTPS Encryption Available on: Basic Plan and higher
If you are subscribed to the Basic Plan or higher, you will be able to access the marketstack API using industry-standard HTTPS. To do that, simply use the https
protocol when making API requests.
Example API Request:
https://api.marketstack.com/v2
Are you a Free Plan user and looking to connect via HTTPS? You will need to upgrade your account to the Basic Plan.
API Errors
API errors consist of error code
and message
response objects. If an error occurs, the marketstack will return HTTP status codes, such as 404
for "not found" errors. If your API request succeeds, status code 200
will be sent.
For validation errors, the marketstack API will also provide a context
response object returning additional information about the error that occurred in the form of one or multiple sub-objects, each equipped with the name of the affected parameter as well as key
and message
objects. You can find an example error below.
Example Error:
{ "error": { "code": "validation_error", "message": "Request failed with validation error", "context": { "symbols": [ { "key": "missing_symbols", "message": "You did not specify any symbols." } ] } } }
Common API Errors:
Code | Type | Description |
---|---|---|
401 |
Unauthorized |
Check your access key or activity of the account |
403 |
https_access_restricted |
HTTPS access is not supported on the current subscription plan. |
403 |
function_access_restricted |
The given API endpoint is not supported on the current subscription plan. |
404 |
invalid_api_function |
The given API endpoint does not exist. |
404 |
404_not_found |
Resource not found. |
429 |
too_many_requests |
The given user account has reached its monthly allowed request volume. |
429 |
rate_limit_reached |
The given user account has reached the rate limit. |
500 |
internal_error |
An internal error occurred. |
Note: The api is limited to 5 requests per second.
API Features
End-of-Day Data Available on: All plans
You can use the API's eod
endpoint in order to obtain end-of-day data for one or multiple stock tickers. A single or multiple comma-separated ticker symbols are passed to the API using the symbols
parameter.
Note: To request end-of-day data for single ticker symbols, you can also use the API's Tickers Endpoint.
Example API Request:
Sign Up to Run API Requesthttps://api.marketstack.com/v2/eod ? access_key = YOUR_ACCESS_KEY & symbols = AAPL
Endpoint Features:
Object | Description |
---|---|
/eod/[date] |
Specify a date in YYYY-MM-DD format. You can also specify an exact time in ISO-8601 date format, e.g. 2020-05-21T00:00:00+0000 . Example: /eod/2020-01-01 |
/eod/latest |
Obtain the latest available end-of-day data for one or multiple stock tickers. |
HTTP GET Request Parameters:
Object | Description |
---|---|
access_key |
[Required] Specify your API access key, available in your account dashboard. |
symbols |
[Required] Specify one or multiple comma-separated stock symbols (tickers) for your request, e.g. AAPL or AAPL,MSFT . Each symbol consumes one API request. Maximum: 100 symbols |
exchange |
[Optional] Filter your results based on a specific stock exchange by specifying the MIC identification of a stock exchange. Example: XNAS |
sort |
[Optional] By default, results are sorted by date/time descending. Use this parameter to specify a sorting order. Available values: DESC (Default), ASC . |
date_from |
[Optional] Filter results based on a specific timeframe by passing a from-date in YYYY-MM-DD format. You can also specify an exact time in ISO-8601 date format, e.g. 2020-05-21T00:00:00+0000 . |
date_to |
[Optional] Filter results based on a specific timeframe by passing an end-date in YYYY-MM-DD format. You can also specify an exact time in ISO-8601 date format, e.g. 2020-05-21T00:00:00+0000 . |
limit |
[Optional] Specify a pagination limit (number of results per page) for your API request. Default limit value is 100 , maximum allowed limit value is 1000 . |
offset |
[Optional] Specify a pagination offset value for your API request. Example: An offset value of 100 combined with a limit value of 10 would show results 100-110. Default value is 0 , starting with the first available result. |
Example API Response:
If your API request was successful, the marketstack API will return both pagination
information as well as a data
object, which contains a separate sub-object for each requested date/time and symbol. All response objects are explained below.
{ "pagination": { "limit": 100, "offset": 0, "count": 100, "total": 9944 }, "data": [ { "open": 228.46, "high": 229.52, "low": 227.3, "close": 227.79, "volume": 34025967.0, "adj_high": 229.52, "adj_low": 227.3, "adj_close": 227.79, "adj_open": 228.46, "adj_volume": 34025967.0, "split_factor": 1.0, "dividend": 0.0, "name": "Apple Inc", "exchange_code": "NASDAQ", "asset_type": "Stock", "price_currency": "usd", "symbol": "AAPL", "exchange": "XNAS", "date": "2024-09-27T00:00:00+0000" }, [...] ] }
API Response Objects:
Response Object | Description |
---|---|
pagination > limit |
Returns your pagination limit value. |
pagination > offset |
Returns your pagination offset value. |
pagination > count |
Returns the results count on the current page. |
pagination > total |
Returns the total count of results available. |
date |
Returns the exact UTC date/time the given data was collected in ISO-8601 format. |
symbol |
Returns the stock ticker symbol of the current data object. |
exchange |
Returns the exchange MIC identification associated with the current data object. |
split_factor |
Returns the split factor, which is used to adjust prices when a company splits, reverse splits, or pays a distribution. |
dividend |
Returns the dividend, which are the distribution of earnings to shareholders. |
open |
Returns the raw opening price of the given stock ticker. |
high |
Returns the raw high price of the given stock ticker. |
low |
Returns the raw low price of the given stock ticker. |
close |
Returns the raw closing price of the given stock ticker. |
volume |
Returns the raw volume of the given stock ticker. |
adj_open |
Returns the adjusted opening price of the given stock ticker. |
adj_high |
Returns the adjusted high price of the given stock ticker. |
adj_low |
Returns the adjusted low price of the given stock ticker. |
adj_close |
Returns the adjusted closing price of the given stock ticker. |
adj_volume |
Returns the adjusted volume of given stock ticker. |
name |
Returns the full-length name of the asset. |
exchange_code |
Returns the identifier that maps which Exchange this asset is listed on. |
asset_type |
Returns the asset type. |
price_currency |
Returns the price currency. |
Adjusted Prices: "Adjusted" prices are stock price values that were amended to accurately reflect the given stock's value after accounting for any corporate actions, such as splits or dividends. Adjustments are made in accordance with the "CRSP Calculations" methodology set forth by the Center for Research in Security Prices (CRSP).
Intraday Data Available on: Basic Plan and higher
In additional to daily end-of-day stock prices, the marketstack API also supports intraday data with data intervals as short as one minute. Intraday prices are available for all US stock tickers included in the IEX (Investors Exchange) stock exchange.
To obtain intraday data, you can use the API's intraday
endpoint and specify your preferred stock ticker symbols.
Note: To request intraday data for single ticker symbols, you can also use the API's Tickers Endpoint.
Example API Request:
Sign Up to Run API Requesthttps://api.marketstack.com/v2/intraday ? access_key = YOUR_ACCESS_KEY & symbols = AAPL
Endpoint Features:
Object | Description |
---|---|
/intraday/[date] |
Specify a date in YYYY-MM-DD format. You can also specify an exact time in ISO-8601 date format, e.g. 2020-05-21T00:00:00+0000 . Example: /intraday/2020-01-01 |
/intraday/latest |
Obtain the latest available intraday data for one or multiple stock tickers. |
HTTP GET Request Parameters:
Object | Description |
---|---|
access_key |
[Required] Specify your API access key, available in your account dashboard. |
symbols |
[Required] Specify one or multiple comma-separated stock symbols (tickers) for your request, e.g. AAPL or AAPL,MSFT . Each symbol consumes one API request. Maximum: 100 symbols |
exchange |
[Optional] Filter your results based on a specific stock exchange by specifying the MIC identification of a stock exchange. Example: IEXG |
interval |
[Optional] Specify your preferred data interval. Available values: 1min , 5min , 10min , 15min , 30min , 1hour (Default), 3hour , 6hour , 12hour and 24hour . |
sort |
[Optional] By default, results are sorted by date/time descending. Use this parameter to specify a sorting order. Available values: DESC (Default), ASC . |
date_from |
[Optional] Filter results based on a specific timeframe by passing a from-date in YYYY-MM-DD format. You can also specify an exact time in ISO-8601 date format, e.g. 2020-05-21T00:00:00+0000 . |
date_to |
[Optional] Filter results based on a specific timeframe by passing an end-date in YYYY-MM-DD format. You can also specify an exact time in ISO-8601 date format, e.g. 2020-05-21T00:00:00+0000 . |
limit |
[Optional] Specify a pagination limit (number of results per page) for your API request. Default limit value is 100 , maximum allowed limit value is 1000 . |
offset |
[Optional] Specify a pagination offset value for your API request. Example: An offset value of 100 combined with a limit value of 10 would show results 100-110. Default value is 0 , starting with the first available result. |
Real-Time Updates: Please note that data frequency intervals below 15 minutes (15min
) are only supported if you are subscribed to the Professional Plan or higher. If you are the Free or Basic Plan, please upgrade your account.
Example API Response:
If your API request was successful, the marketstack API will return both pagination
information as well as a data
object, which contains a separate sub-object for each requested date/time and symbol. All response objects are explained below.
{ "pagination": { "limit": 100, "offset": 0, "count": 100, "total": 5000 }, "data": [ { "open": 228.45, "high": 229.53, "low": 227.3, "mid": 227.28, "last_size": 6, "bid_size": 120.0, "bid_price": 227.02, "ask_price": 227.54, "ask_size": 100.0, "last": 227.54, "close": 227.52, "volume": 311345.0, "date": "2024-09-27T16:00:00+0000", "symbol": "AAPL", "exchange": "IEXG" }, [...] ] }
API Response Objects:
Response Object | Description |
---|---|
pagination > limit |
Returns your pagination limit value. |
pagination > offset |
Returns your pagination offset value. |
pagination > count |
Returns the results count on the current page. |
pagination > total |
Returns the total count of results available. |
date |
Returns the exact UTC date/time the given data was collected in ISO-8601 format. |
symbol |
Returns the stock ticker symbol of the current data object. |
exchange |
Returns the exchange MIC identification associated with the current data object. |
open |
Returns the raw opening price of the given stock ticker. |
high |
Returns the raw high price of the given stock ticker. |
low |
Returns the raw low price of the given stock ticker. |
close |
Returns the raw closing price of the given stock ticker. |
last |
Returns the last executed trade of the given symbol on its exchange. |
volume |
Returns the volume of the given stock ticker. |
mid |
Returns the mid price of the current timestamp when both "bidPrice" and "askPrice" are not-null. In mathematical terms: mid = (bidPrice + askPrice)/2.0. This value is calculated by Tiingo and not provided by IEX or Marketstack. |
last_size |
Returns the amount of shares traded (volume) at the last price on IEX. |
bid_size |
Returns the amount of shares at the bid price. |
bid_price |
Returns the current bid price. |
ask_price |
Returns the current ask price. |
ask_size |
Returns the amount of shares at the asking price. |
Real-Time Updates Available on: Professional Plan and higher
For customers with an active subscription to the Professional Plan, the marketstack API's intraday
endpoint is also capable of providing real-time market data, updated every minute, every 5 minutes or every 10 minutes.
To obtain real-time data using this endpoint, simply append the API's interval
parameter and set it to 1min
, 5min
or 10min
.
Example API Request:
Sign Up to Run API Requesthttps://api.marketstack.com/v2/intraday ? access_key = YOUR_ACCESS_KEY & symbols = AAPL & interval = 1min
Endpoint Features, Parameters & API Response:
To learn about endpoint features, request parameters and API response objects, please navigate to the Intraday Data section.
Historical Data Available on: All plans
Historical stock prices are available both from the end-of-day (eod
) and intraday (intraday
) API endpoints. To obtain historical data, simply use the date_from
and date_to
parameters as shown in the example request below.
Example API Request:
Sign Up to Run API Requesthttps://api.marketstack.com/v2/eod ? access_key = YOUR_ACCESS_KEY & symbols = AAPL & date_from = 2024-12-11 & date_to = 2024-12-21
HTTP GET Request Parameters:
For details on request parameters on the eod
data endpoint, please jump to the End-of-Day Data section.
Example API Response:
{ "pagination": { "limit": 100, "offset": 0, "count": 22, "total": 22 }, "data": [ { "open": 228.46, "high": 229.52, "low": 227.3, "close": 227.79, "volume": 34025967.0, "adj_high": 229.52, "adj_low": 227.3, "adj_close": 227.79, "adj_open": 228.46, "adj_volume": 34025967.0, "split_factor": 1.0, "dividend": 0.0, "name": "Apple Inc", "exchange_code": "NASDAQ", "asset_type": "Stock", "price_currency": "usd", "symbol": "AAPL", "exchange": "XNAS", "date": "2024-09-27T00:00:00+0000" } [...] ] }
API Response Objects:
For details on API response objects, please jump to the End-of-Day Data section.
Note: Historical end-of-day data (eod
) is available for up to 30 years back, while intraday data (intraday
) always only offers the last 10,000 entries for each of the intervals available. Example: For a 1-minute interval, historical intraday data is available for up to 10,000 minutes back.
Splits Data Available on: All plans
Using the APIssplits
endpoint you will be able to look up information about the stock splits factor for different symbols. You will be able to find and try out an example API request below.
To obtain splits data, you can use the API's splits
endpoint and specify your preferred stock ticker symbols.
Note: To request splits data for single ticker symbols, you can also use the API's Tickers Endpoint.
Example API Request:
Sign Up to Run API Requesthttps://api.marketstack.com/v2/splits ? access_key = YOUR_ACCESS_KEY & symbols = AAPL
Endpoint Features:
HTTP GET Request Parameters:
Object | Description |
---|---|
access_key |
[Required] Specify your API access key, available in your account dashboard. |
symbols |
[Required] Specify one or multiple comma-separated stock symbols (tickers) for your request, e.g. AAPL or AAPL,MSFT . Each symbol consumes one API request. Maximum: 100 symbols |
sort |
[Optional] By default, results are sorted by date/time descending. Use this parameter to specify a sorting order. Available values: DESC (Default), ASC . |
date_from |
[Optional] Filter results based on a specific timeframe by passing a from-date in YYYY-MM-DD format. You can also specify an exact time in ISO-8601 date format, e.g. 2020-05-21T00:00:00+0000 . |
date_to |
[Optional] Filter results based on a specific timeframe by passing an end-date in YYYY-MM-DD format. You can also specify an exact time in ISO-8601 date format, e.g. 2020-05-21T00:00:00+0000 . |
limit |
[Optional] Specify a pagination limit (number of results per page) for your API request. Default limit value is 100 , maximum allowed limit value is 1000 . |
offset |
[Optional] Specify a pagination offset value for your API request. Example: An offset value of 100 combined with a limit value of 10 would show results 100-110. Default value is 0 , starting with the first available result. |
Example API Response:
If your API request was successful, the marketstack API will return both pagination
information as well as a data
object, which contains a separate sub-object for each requested date/time and symbol. All response objects are explained below.
{ "pagination": { "limit": 100, "offset": 0, "count": 100, "total": 50765 }, "data": [ { "date": "2020-08-31", "split_factor": 4.0, "stock_split": "4:1", "symbol": "AAPL" }, [...] ] }
API Response Objects:
Response Object | Description |
---|---|
pagination > limit |
Returns your pagination limit value. |
pagination > offset |
Returns your pagination offset value. |
pagination > count |
Returns the results count on the current page. |
pagination > total |
Returns the total count of results available. |
date |
Returns the exact UTC date/time the given data was collected in ISO-8601 format. |
symbol |
Returns the stock ticker symbol of the current data object. |
split_factor |
Returns the split factor for that symbol on the date. |
stock_split |
Returns the stock split. |
Dividends Data Available on: All plans
Using the APIsdividends
endpoint you will be able to look up information about the stock dividend for different symbols. You will be able to find and try out an example API request below.
To obtain dividends data, you can use the API's dividends
endpoint and specify your preferred stock ticker symbols.
Note: To request dividends data for single ticker symbols, you can also use the API's Tickers Endpoint.
Example API Request:
Sign Up to Run API Requesthttps://api.marketstack.com/v2/dividends ? access_key = YOUR_ACCESS_KEY & symbols = AAPL
Endpoint Features:
HTTP GET Request Parameters:
Object | Description |
---|---|
access_key |
[Required] Specify your API access key, available in your account dashboard. |
symbols |
[Required] Specify one or multiple comma-separated stock symbols (tickers) for your request, e.g. AAPL or AAPL,MSFT . Each symbol consumes one API request. Maximum: 100 symbols |
sort |
[Optional] By default, results are sorted by date/time descending. Use this parameter to specify a sorting order. Available values: DESC (Default), ASC . |
date_from |
[Optional] Filter results based on a specific timeframe by passing a from-date in YYYY-MM-DD format. You can also specify an exact time in ISO-8601 date format, e.g. 2020-05-21T00:00:00+0000 . |
date_to |
[Optional] Filter results based on a specific timeframe by passing an end-date in YYYY-MM-DD format. You can also specify an exact time in ISO-8601 date format, e.g. 2020-05-21T00:00:00+0000 . |
limit |
[Optional] Specify a pagination limit (number of results per page) for your API request. Default limit value is 100 , maximum allowed limit value is 1000 . |
offset |
[Optional] Specify a pagination offset value for your API request. Example: An offset value of 100 combined with a limit value of 10 would show results 100-110. Default value is 0 , starting with the first available result. |
Example API Response:
If your API request was successful, the marketstack API will return both pagination
information as well as a data
object, which contains a separate sub-object for each requested date/time and symbol. All response objects are explained below.
{ "pagination": { "limit": 100, "offset": 0, "count": 100, "total": 50765 }, "data": [ { "date": "2024-08-12", "dividend": 0.25, "payment_date": "2024-08-15 04:00:00", "record_date": "2024-08-12 04:00:00", "declaration_date": "2024-08-01 00:00:00", "distr_freq": "q", "symbol": "AAPL" }, [...] ] }
API Response Objects:
Response Object | Description |
---|---|
pagination > limit |
Returns your pagination limit value. |
pagination > offset |
Returns your pagination offset value. |
pagination > count |
Returns the results count on the current page. |
pagination > total |
Returns the total count of results available. |
date |
Returns the exact UTC date/time the given data was collected in ISO-8601 format. |
symbol |
Returns the stock ticker symbol of the current data object. |
dividend |
Returns the dividend for that symbol on the date. |
payment_date |
Returns the payment date of the distribution. |
record_date |
Returns the record date of the distribution. |
declaration_date |
Returns the declaration date of the distribution. |
distr_freq |
Returns the frequency that's associated with this distribution. For example "q" means quarterly, meaning this is a declared quarterly distribution. The full list of codes is available here: ● w: Weekly ● bm: Bimonthly ● m: Monthly ● tm: Trimesterly ● q: Quarterly ● sa: Semiannually ● a: Annually ● ir: Irregular ● f: Final ● u: Unspecified ● c: Cancelled |
Tickers Available on: All plans
Using the API's tickers
endpoint you will be able to look up information about one or multiple stock ticker symbols as well as obtain end-of-day, real-time and intraday market data for single tickers. You will be able to find and try out an example API request below.
Example API Request:
Sign Up to Run API Requesthttps://api.marketstack.com/v2/tickers/AAPL ? access_key = YOUR_ACCESS_KEY
Endpoint Features:
Object | Description |
---|---|
/tickers/[symbol] |
Obtain information about a specific ticker symbol by attach it to your API request URL, e.g. /tickers/AAPL . |
/tickers/[symbol]/eod |
Obtain end-of-day data for a specific stock ticker by attaching /eod to your URL, e.g. /tickers/AAPL/eod . This route supports parameters of the End-of-day Data endpoint. |
/tickers/[symbol]/splits |
Obtain end-of-day data for a specific stock ticker by attaching /splits to your URL, e.g. /tickers/AAPL/splits . This route supports parameters like date period date_from and date_to and also you can sort the results |
/tickers/[symbol]/dividends |
Obtain end-of-day data for a specific stock ticker by attaching /dividends to your URL, e.g. /tickers/AAPL/dividends . This route supports parameters like date period date_from and date_to and also you can sort the results |
/tickers/[symbol]/intraday |
Obtain real-time & intraday data for a specific stock ticker by attaching /intraday to your URL, e.g. /tickers/AAPL/intraday . This route supports parameters of the Intraday Data endpoint. |
/tickers/[symbol]/eod/[date] |
Specify a date in YYYY-MM-DD format. You can also specify an exact time in ISO-8601 date format, e.g. 2020-05-21T00:00:00+0000 . Example: /eod/2020-01-01 or /intraday/2020-01-01 |
/tickers/[symbol]/eod/latest |
Obtain the latest end-of-day data for a given stock symbol. Example: /tickers/AAPL/eod/latest |
/tickers/[symbol]/intraday/latest |
Obtain the latest intraday data for a given stock symbol. Example: /tickers/AAPL/intraday/latest |
HTTP GET Request Parameters:
Object | Description |
---|---|
access_key |
[Required] Specify your API access key, available in your account dashboard. |
exchange |
[Optional] To filter your results based on a specific stock exchange, use this parameter to specify the MIC identification of a stock exchange. Example: XNAS |
search |
[Optional] Use this parameter to search stock tickers by name or ticker symbol. |
limit |
[Optional] Specify a pagination limit (number of results per page) for your API request. Default limit value is 100 , maximum allowed limit value is 1000 . |
offset |
[Optional] Specify a pagination offset value for your API request. Example: An offset value of 100 combined with a limit value of 10 would show results 100-110. Default value is 0 , starting with the first available result. |
API Response:
{ "name": "Apple Inc.", "symbol": "AAPL", "cik": "320193", "isin": "US0378331005", "cusip": "037833100", "ein_employer_id": "942404110", "lei": "HWUPKR0MPOU8FGXBT394", "series_id": "", "item_type": "equity", "sector": "Technology", "industry": "Consumer Electronics", "sic_code": "3571", "sic_name": "Electronic Computers", "stock_exchange": { "name": "NASDAQ - ALL MARKETS", "acronym": "NASDAQ", "mic": "XNAS", "country": null, "country_code": "US", "city": "NEW YORK", "website": "WWW.NASDAQ.COM", "operating_mic": "XNAS", "oprt_sgmt": "OPRT", "legal_entity_name": "", "exchange_lei": "", "market_category_code": "NSPD", "exchange_status": "ACTIVE", "date_creation": { "date": "2005-06-27 00:00:00.000000", "timezone_type": 1, "timezone": "+00:00" }, "date_last_update": { "date": "2005-06-27 00:00:00.000000", "timezone_type": 1, "timezone": "+00:00" }, "date_last_validation": { "date": "-0001-11-30 00:00:00.000000", "timezone_type": 1, "timezone": "+00:00" }, "date_expiry": null, "comments": "" } }
API Response Objects:
Response Object | Description |
---|---|
name |
Returns the name of the given stock ticker. |
symbol |
Returns the symbol of the given stock ticker. |
cik |
Returns the unique identifier assigned by the SEC to U.S. corporations and individuals for regulatory filings. |
isin |
Returns the International Securities Identification Number. |
cusip |
Returns the CUSIP number identifies most financial instruments, including: stocks of all registered U.S. and Canadian companies, commercial paper, and U.S. government and municipal bonds. |
ein_employer_id |
Returns the unique nine-digit number that is assigned to a business entity. |
lei |
Returns the Legal Entity Identifier. |
series_id |
Returns the ID of the options series in which the stock option is. |
item_type |
Returns the The type of the stock ticker. |
sector |
Returns the Sector in which the company holding the stock ticker is. |
industry |
Returns the Industry in which the company holding the stock ticker is. |
sic_code |
Returns the Standard Industrial Clasification code. |
sic_name |
Returns the Standard Industrial Clasification name. |
stock_exchange > name |
Returns the name of the stock exchange associated with the given stock ticker. |
stock_exchange > acronym |
Returns the acronym of the stock exchange associated with the given stock ticker. |
stock_exchange > mic |
Returns the MIC identification of the stock exchange associated with the given stock ticker. |
stock_exchange > country |
Returns the country of the stock exchange associated with the given stock ticker. |
stock_exchange > country_code |
Returns the 3-letter country code of the stock exchange associated with the given stock ticker. |
stock_exchange > city |
Returns the city of the stock exchange associated with the given stock ticker. |
stock_exchange > website |
Returns the website URL of the stock exchange associated with the given stock ticker. |
stock_exchange > operating_mic |
Returns the operating Market Identifier Code for the given stock ticker. |
stock_exchange > oprt_sgmt |
Returns whether the MIC is an operating MIC or market segment MIC for the given stock ticker. |
stock_exchange > legal_entity_name |
Returns the legal entity name for the given stock ticker. |
stock_exchange > exchange_lei |
Returns the exchange Legal Entity Identifier for the given stock ticker. |
stock_exchange > market_category_code |
Returns the market categoty code for the given stock ticker. |
stock_exchange > exchange_status |
Returns the exchange status for the given stock ticker. |
stock_exchange > date_creation > date |
Returns date creation date for the given stock ticker. |
stock_exchange > date_creation > timezone_type |
Returns date creation timezone type for the given stock ticker. |
stock_exchange > date_creation > timezone |
Returns date creation timezone for the given stock ticker. |
stock_exchange > date_last_update > date |
Returns last date update for the given stock ticker. |
stock_exchange > date_last_update > timezone_type |
Returns last date update timezone type for the given stock ticker. |
stock_exchange > date_last_update > timezone |
Returns last date update timezone for the given stock ticker. |
stock_exchange > date_last_validation > date |
Returns last date validation for the given stock ticker. |
stock_exchange > date_last_validation > timezone_type |
Returns last date validation timezone type for the given stock ticker. |
stock_exchange > date_last_validation > timezone |
Returns last date validation timezone for the given stock ticker. |
stock_exchange > date_expiry |
Returns Expiry date for the given stock ticker. |
stock_exchange > comments |
Returns comments for the given stock ticker. |
Tickers List Available on: All plans
Using the API's tickerslist
endpoint you will be able to get the full list of supported tickers. You will be able to find and try out an example API request below.
Example API Request:
Sign Up to Run API Requesthttps://api.marketstack.com/v2/tickerslist ? access_key = YOUR_ACCESS_KEY
HTTP GET Request Parameters:
Object | Description |
---|---|
access_key |
[Required] Specify your API access key, available in your account dashboard. |
limit |
[Optional] Specify a pagination limit (number of results per page) for your API request. Default limit value is 100 , maximum allowed limit value is 1000 . |
offset |
[Optional] Specify a pagination offset value for your API request. Example: An offset value of 100 combined with a limit value of 10 would show results 100-110. Default value is 0 , starting with the first available result. |
API Response:
{ "pagination": { "limit": 100, "offset": 0, "count": 100, "total": 50911 }, "data": [ { "ticker": "MSFT" }, { "ticker": "AAPL" }, [......] ] }
API Response Objects:
Response Object | Description |
---|---|
pagination > limit |
Returns your pagination limit value. |
pagination > offset |
Returns your pagination offset value. |
pagination > count |
Returns the results count on the current page. |
pagination > total |
Returns the total count of results available. |
ticker |
Returns the ticker symbol. |
Tickers Info Available on: All plans
Using the API's tickerinfo
endpoint you will be able to look up information about tickers. You will be able to find and try out an example API request below.
Example API Request:
Sign Up to Run API Requesthttps://api.marketstack.com/v2/tickerinfo ? access_key = YOUR_ACCESS_KEY & ticker = MSFT
HTTP GET Request Parameters:
Object | Description |
---|---|
access_key |
[Required] Specify your API access key, available in your account dashboard. |
ticker |
[Required] To get results based on a ticker. |
API Response:
{ "data": { "name": "MICROSOFT CORP", "ticker": "MSFT", "item_type": "equity", "sector": "Technology", "industry": "Software—Infrastructure", "exchange_code": "NMS", "full_time_employees": "221000", "ipo_date": null, "date_founded": null, "key_executives": [ { "name": "Mr. Judson B. Althoff", "salary": "3.36M", "function": "Executive VP & Chief Commercial Officer", "exercised": "", "birth_year": "1974" }, [....] ], "incorporation": "WA", "incorporation_description": "WA", "start_fiscal": null, "end_fiscal": "0630", "reporting_currency": null, "address": { "city": "REDMOND", "street1": "ONE MICROSOFT WAY", "street2": "", "postal_code": "98052-6399", "stateOrCountry": "WA", "state_or_country_description": "WA" }, "post_address": { "city": "REDMOND", "street1": "ONE MICROSOFT WAY", "street2": "", "postal_code": "98052-6399", "stateOrCountry": "WA", "state_or_country_description": "WA" }, "phone": "425-882-8080", "website": "https://www.microsoft.com", "previous_names": [], "about": "Microsoft Corporation develops, licenses, and supports software, services, devices, and solutions worldwide. The company operates in three segments: Productivity and Business Processes, Intelligent Cloud, and More Personal Computing. The Productivity and Business Processes segment offers Office, Exchange, SharePoint, Microsoft Teams, Office 365 Security and Compliance, Microsoft Viva, and Skype for Business; Skype, Outlook.com, OneDrive, and LinkedIn; and Dynamics 365, a set of cloud-based and on-premises business solutions for organizations and enterprise divisions. The Intelligent Cloud segment licenses SQL, Windows Servers, Visual Studio, System Center, and related Client Access Licenses; GitHub that provides a collaboration platform and code hosting service for developers; Nuance provides healthcare and enterprise AI solutions; and Azure, a cloud platform. It also offers enterprise support, Microsoft consulting, and nuance professional services to assist customers in developing, deploying, and managing Microsoft server and desktop solutions; and training and certification on Microsoft products. The More Personal Computing segment provides Windows original equipment manufacturer (OEM) licensing and other non-volume licensing of the Windows operating system; Windows Commercial, such as volume licensing of the Windows operating system, Windows cloud services, and other Windows commercial offerings; patent licensing; and Windows Internet of Things. It also offers Surface, PC accessories, PCs, tablets, gaming and entertainment consoles, and other devices; Gaming, including Xbox hardware, and Xbox content and services; video games and third-party video game royalties; and Search, including Bing and Microsoft advertising. The company sells its products through OEMs, distributors, and resellers; and directly through digital marketplaces, online stores, and retail stores. Microsoft Corporation was founded in 1975 and is headquartered in Redmond, Washington.", "mission": null, "vision": null, "stock_exchanges": [ { "city": "New York", "country": "USA", "website": "www.iextrading.com", "acronym1": "IEX", "alpha2_code": "US", "exchange_mic": "IEXG", "exchange_name": "Investors Exchange" }, [....] ] } }
API Response Objects:
Response Object | Description |
---|---|
name |
Returns the name of the ticker stock. |
ticker |
Returns the symbol of the ticker stock. |
item_type |
Returns the type of the stock. |
sector |
Returns the sector in which the stock ticker is exist. |
industry |
Returns the industry in which the stock ticker is exist. |
exchange_code |
Returns the Exchange market code. |
full_time_employees |
Returns the number of full employees in the company holding the ticker. |
ipo_date |
Returns the date when the company stock went public. |
date_founded |
Returns the date when the company is founded. |
key_executives > name |
Returns the name of the key executive of the company. |
key_executives > salary |
Returns the salary of the key executive of the company. |
key_executives > function |
Returns the function of the key executive of the company. |
key_executives > exercised |
Returns the exercised of the key executive of the company. |
key_executives > birth_year |
Returns the bith year of the key executive of the company. |
incorporation |
Returns the state of incorporation. |
incorporation_description |
Returns the incorporation description. |
start_fiscal |
Returns the start of a fiscal period. |
end_fiscal |
Returns the end of a fiscal period. |
reporting_currency |
Returns the reporting currency. |
address > street1 |
Returns the incorporation address of the company holding the ticker. |
address > street2 |
Returns the incorporation address of the company holding the ticker. |
address > city |
Returns the incorporation city of the company holding the ticker. |
address > stateOrCountry |
Returns the incorporation state or country of the company holding the ticker. |
address > postal_code |
Returns the incorporation postal code of the company holding the ticker. |
address > state_or_country_description |
Returns the incorporation state or country abbr of the company holding the ticker. |
post_address > street1 |
Returns the post address of the company holding the ticker. |
post_address > street2 |
Returns the post address of the company holding the ticker. |
post_address > city |
Returns the post city of the company holding the ticker. |
post_address > stateOrCountry |
Returns the post state or country of the company holding the ticker. |
post_address > postal_code |
Returns the postal code of the company holding the ticker. |
post_address > state_or_country_description |
Returns the post state or country abbr of the company holding the ticker. |
phone |
Returns the phone number of the company. |
website |
Returns the website of the company. |
previous_names > name |
Returns previous name of the company. |
previous_names > from |
Returns the date from when it was known by this name. |
about |
Returns the about company details. |
mission |
Returns the company mission. |
vision |
Returns the company vision. |
stock_exchanges > exchange_name |
Returns the exchange name of the ticker. |
stock_exchanges > acronym1 |
Returns the exchange acronym of the ticker. |
stock_exchanges > exchange_mic |
Returns the exchange mic of the ticker. |
stock_exchanges > country |
Returns the exchange country data of the ticker. |
stock_exchanges > alpha2_code |
Returns the exchange alpha code of the ticker. |
stock_exchanges > city |
Returns the exchange city of the ticker. |
stock_exchanges > website |
Returns the exchange website of the ticker. |
Stock Market Index Listing Available on: Basic Plan and higher
The Stock Market Index API delivers instantly real-time and historical stock market index data. API End points return the full list of supported benchmarks/indexes.
The example API request below illustrates how to obtain data for the Stock market index.
Example API Request:
Sign Up to Run API Requesthttps://api.marketstack.com/v2/indexlist ? access_key = YOUR_ACCESS_KEY
Endpoint Features:
HTTP GET Request Parameters:
Object | Description |
---|---|
access_key |
[Required] Specify your API access key, available in your account dashboard. |
limit |
[Optional] Specify a pagination limit (number of results per page) for your API request. Default limit value is 100 , maximum allowed limit value is 1000 . |
offset |
[Optional] Specify a pagination offset value for your API request. Example: An offset value of 100 combined with a limit value of 10 would show results 100-110. Default value is 0 , starting with the first available result. |
API Response:
{ "pagination": { "limit": 100, "offset": 0, "count": 86, "total": 86 }, "data": [ { "benchmark": "adx_general" }, { "benchmark": "ase" }, { "benchmark": "aspi" }, { "benchmark": "asx200" } [...] ] }
API Response Objects:
Response Object | Description |
---|---|
pagination > limit |
Returns your pagination limit value. |
pagination > offset |
Returns your pagination offset value. |
pagination > count |
Returns the results count on the current page. |
pagination > total |
Returns the total count of results available. |
benchmark |
Returns the benchmark code of the market index. |
Stock Market Index Info Available on: Basic Plan and higher
The Stock Market Index API delivers instantly real-time and historical stock market index data Infrmaion. API End points return the details for the desired index.
The example API request below illustrates how to obtain data for the Stock market index Information.
Example API Request:
Sign Up to Run API Requesthttps://api.marketstack.com/v2/indexinfo ? access_key = YOUR_ACCESS_KEY & index = australia_all_ordinaries
Endpoint Features:
HTTP GET Request Parameters:
Object | Description |
---|---|
access_key |
[Required] Specify your API access key, available in your account dashboard. |
index |
[Required] Specify your benchmark/index id for your request, e.g. australia_all_ordinaries. |
API Response:
[ { "benchmark": "australia all ordinaries", "region": "australia", "country": "australia", "price": "8553", "price_change_day": "71", "percentage_day": "0.84%", "percentage_week": "2.06%", "percentage_month": "1.13%", "percentage_year": "18.54%", "date": "2024-11-08" } ]
API Response Objects:
Response Object | Description |
---|---|
benchmark |
Returns the benchmark of the market index. |
region |
Returns the region of the market index. |
country |
Returns the country of the market index. |
price |
Returns the current price of the market index. |
price_change_day |
Returns the change of the price in a day. |
percentage_day |
Returns the change of the price in a day in percentage. |
percentage_week |
Returns the change of the price in a week in percentage. |
percentage_month |
Returns the change of the price in a month in percentage. |
percentage_year |
Returns the benchmark code of the market index. |
date |
Returns the Current date. |
Exchanges Available on: All plans
Using the exchanges
API endpoint you will be able to look up information any of the 2700+ stock exchanges supported by marketstack. You will be able to find and try out an example API request below.
Example API Request:
Sign Up to Run API Requesthttps://api.marketstack.com/v2/exchanges ? access_key = YOUR_ACCESS_KEY
Endpoint Features:
Object | Description |
---|---|
/exchanges/[mic] |
Obtain information about a specific stock exchange by attaching its MIC identification to your API request URL, e.g. /exchanges/XNAS . |
/exchanges/[mic]/tickers |
Obtain all available tickers for a specific exchange by attaching the exchange MIC as well as /tickers , e.g. /exchanges/XNAS/tickers . |
/exchanges/[mic]/eod |
Obtain end-of-day data for all available tickers from a specific exchange, e.g. /exchanges/XNAS/eod . For parameters, refer to End-of-day Data endpoint. |
/exchanges/[mic]/intraday |
Obtain intraday data for tickers from a specific exchange, e.g. /exchanges/XNAS/intraday . For parameters, refer to Intraday Data endpoint. |
/exchanges/[mic]/eod/[date] |
Obtain end-of-day data for a specific date in YYYY-MM-DD or ISO-8601 format. Example: /exchanges/XNAS/eod/2020-01-01 . |
/exchanges/[mic]/intraday/[date] |
Obtain intraday data for a specific date and time in YYYY-MM-DD or ISO-8601 format. Example: /exchanges/IEXG/intraday/2020-05-21T00:00:00+0000 . |
/exchanges/[mic]/eod/latest |
Obtain the latest end-of-day data for tickers of the given exchange. Example: /exchanges/XNAS/eod/latest |
/exchanges/[mic]/intraday/latest |
Obtain the latest intraday data for tickers of the given exchange. Example: /exchanges/IEXG/intraday/latest |
HTTP GET Request Parameters:
Object | Description |
---|---|
access_key |
[Required] Specify your API access key, available in your account dashboard. |
search |
[Optional] Use this parameter to search stock exchanges by name or MIC. |
limit |
[Optional] Specify a pagination limit (number of results per page) for your API request. Default limit value is 100 , maximum allowed limit value is 1000 . |
offset |
[Optional] Specify a pagination offset value for your API request. Example: An offset value of 100 combined with a limit value of 10 would show results 100-110. Default value is 0 , starting with the first available result. |
API Response:
{ "pagination": { "limit": 100, "offset": 0, "count": 100, "total": 2700 }, "data": [ { "name": "ALM. BRAND BANK", "acronym": "", "mic": "ABSI", "country": null, "country_code": "DK", "city": "COPENHAGEN", "website": "www.almbrand.dk", "operating_mic": "ABSI", "oprt_sgmt": "OPRT", "legal_entity_name": "", "exchange_lei": "2UM1RGHWEBOSN4PMNL63", "market_category_code": "SINT", "exchange_status": "ACTIVE", "date_creation": "2017-10-10", "date_last_update": "2017-10-10", "date_last_validation": "2017-10-10", "date_expiry": "2017-10-10", "comments": "SYSTEMATIC INTERNALISER." }, [...] ] }
API Response Objects:
Response Object | Description |
---|---|
pagination > limit |
Returns your pagination limit value. |
pagination > offset |
Returns your pagination offset value. |
pagination > count |
Returns the results count on the current page. |
pagination > total |
Returns the total count of results available. |
name |
Returns the name of the given stock exchange. |
acronym |
Returns the acronym of the given stock exchange. |
mic |
Returns the MIC identification of the given stock exchange. |
country |
Returns the country of the given stock exchange. |
country_code |
Returns the 3-letter country code of the given stock exchange. |
city |
Returns the given city of the stock exchange. |
website |
Returns the website URL of the given stock exchange. |
operating_mic |
Returns operating Market Identifier Code for the Exchange. |
oprt_sgmt |
Indicates whether the MIC is an operating MIC or a. market segment MIC. |
legal_entity_name |
Returns the website URL of the given stock exchange. |
exchange_lei |
Returns the website URL of the given stock exchange. |
market_category_code |
Returns the website URL of the given stock exchange. |
exchange_status |
Returns current status of the Exchange. |
date_creation |
Returns date when the Exchange is created. |
date_last_update |
Returns the website URL of the given stock exchange. |
date_last_validation |
Returns the date when the Exchange is updated. |
date_expiry |
Returns the date when the Exchange is expiring. |
comments |
Returns any comments for the Exchange. |
Currencies Available on: All plans
Using the currencies
API endpoint you will be able to look up all currencies supported by the marketstack API. You will be able to find and try out an example API request below.
Example API Request:
Sign Up to Run API Requesthttps://api.marketstack.com/v2/currencies ? access_key = YOUR_ACCESS_KEY
HTTP GET Request Parameters:
Object | Description |
---|---|
access_key |
[Required] Specify your API access key, available in your account dashboard. |
limit |
[Optional] Specify a pagination limit (number of results per page) for your API request. Default limit value is 100 , maximum allowed limit value is 1000 . |
offset |
[Optional] Specify a pagination offset value for your API request. Example: An offset value of 100 combined with a limit value of 10 would show results 100-110. Default value is 0 , starting with the first available result. |
API Response:
{ "pagination": { "limit": 100, "offset": 0, "count": 40, "total": 40 }, "data": [ { "code": "USD", "name": "US Dollar", "symbol": "$", "symbol_native": "$", }, [...] ] }
API Response Objects:
Response Object | Description |
---|---|
pagination > limit |
Returns your pagination limit value. |
pagination > offset |
Returns your pagination offset value. |
pagination > count |
Returns the results count on the current page. |
pagination > total |
Returns the total count of results available. |
code |
Returns the 3-letter code of the given currency. |
name |
Returns the name of the given currency. |
symbol |
Returns the text symbol of the given currency. |
symbol_native |
Returns the native text symbol of the given currency. |
Timezones Available on: All plans
Using the timezones
API endpoint you will be able to look up information about all supported timezones. You will be able to find and try out an example API request below.
Example API Request:
Sign Up to Run API Requesthttps://api.marketstack.com/v2/timezones ? access_key = YOUR_ACCESS_KEY
HTTP GET Request Parameters:
Object | Description |
---|---|
access_key |
[Required] Specify your API access key, available in your account dashboard. |
limit |
[Optional] Specify a pagination limit (number of results per page) for your API request. Default limit value is 100 , maximum allowed limit value is 1000 . |
offset |
[Optional] Specify a pagination offset value for your API request. Example: An offset value of 100 combined with a limit value of 10 would show results 100-110. Default value is 0 , starting with the first available result. |
API Response:
{ "pagination": { "limit": 100, "offset": 0, "count": 57, "total": 57 }, "data": [ { "timezone": "America/New_York", "abbr": "EST", "abbr_dst": "EDT" }, [...] ] }
API Response Objects:
Response Object | Description |
---|---|
pagination > limit |
Returns your pagination limit value. |
pagination > offset |
Returns your pagination offset value. |
pagination > count |
Returns the results count on the current page. |
pagination > total |
Returns the total count of results available. |
timezone |
Returns the name of the given timezone. |
abbr |
Returns the abbreviation of the given timezone. |
abbr_dst |
Returns the Summer time abbreviation of the given timezone. |
Bonds Listing Available on: Basic Plan and higher
The Bonds Listing API delivers the list of the supported countries data. API End points return the full list of supported countries.
The example API request below illustrates how to obtain for the bonds.
Example API Request:
Sign Up to Run API Requesthttps://api.marketstack.com/v2/bondlist ? access_key = YOUR_ACCESS_KEY
Endpoint Features:
HTTP GET Request Parameters:
Object | Description |
---|---|
access_key |
[Required] Specify your API access key, available in your account dashboard. |
limit |
[Optional] Specify a pagination limit (number of results per page) for your API request. Default limit value is 100 , maximum allowed limit value is 1000 . |
offset |
[Optional] Specify a pagination offset value for your API request. Example: An offset value of 100 combined with a limit value of 10 would show results 100-110. Default value is 0 , starting with the first available result. |
API Response:
{ "pagination": { "limit": 100, "offset": 0, "count": 53, "total": 53 }, "data": [ { "country": "austria" }, { "country": "australia" }, { "country": "belgium" }, { "country": "brazil" } [...] ] }
API Response Objects:
Response Object | Description |
---|---|
pagination > limit |
Returns your pagination limit value. |
pagination > offset |
Returns your pagination offset value. |
pagination > count |
Returns the results count on the current page. |
pagination > total |
Returns the total count of results available. |
country |
Returns the name of the country. |
Bond Info Available on: Basic Plan and higher
The Bond API delivers immediately real-time government bond data. The bond data focuses on treasury notes issued in leading countries worldwide for ten years. The Bond API delivers info for every country. API End points return the details for the desired country.
The example API request below illustrates how to obtain conuntry data for the Bonds.
Example API Request:
Sign Up to Run API Requesthttps://api.marketstack.com/v2/bond ? access_key = YOUR_ACCESS_KEY & country = kenya
HTTP GET Request Parameters:
Object | Description |
---|---|
access_key |
[Required] Specify your API access key, available in your account dashboard. |
country |
[Required] Specify your country for your request, e.g. kenya or united%20states |
API Response:
{ "pagination": { "limit": 100, "offset": 0, "count": 1, "total": 1 }, "data": [ { "region": "africa", "country": "kenya", "type": "10Y", "yield": "16.801", "price_change_day": "0.0490", "percentage_week": "-0.05%", "percentage_month": "-0.21%", "percentage_year": "0.57%", "date": "2024-11-08" } ] }
API Response Objects:
Response Object | Description |
---|---|
pagination > limit |
Returns your pagination limit value. |
pagination > offset |
Returns your pagination offset value. |
pagination > count |
Returns the results count on the current page. |
pagination > total |
Returns the total count of results available. |
region |
Returns the region where the bond is supported. |
country |
Returns the country where the bond is supported. |
type |
Returns the type of the bond. |
yield |
Returns the current bond yield. |
price_change_day |
Returns the price change of a bond in a day. |
percentage_week |
Returns the price change of a bond in a week in percentage. |
percentage_month |
Returns the price change of a bond in a month in percentage. |
percentage_year |
Returns the price change of a bond in a year in percentage. |
date |
Returns the current date info. |
ETF Holdings Listing Available on: Basic Plan and higher
The ETF Holdings API delivers instantly complete set of exchange-traded funds data based on the unique identifier code of an ETF data. API End points return the full list of supported ETF tickers.
The example API request below illustrates how to obtain data for the ETF Holdings.
Example API Request:
Sign Up to Run API Requesthttps://api.marketstack.com/v2/etflist ? access_key = YOUR_ACCESS_KEY & list = ticker
Endpoint Features:
HTTP GET Request Parameters:
Object | Description |
---|---|
access_key |
[Required] Specify your API access key, available in your account dashboard. |
list |
[Required] Specify your list as ticker for your request. |
limit |
[Optional] Specify a pagination limit (number of results per page) for your API request. Default limit value is 100 , maximum allowed limit value is 1000 . |
offset |
[Optional] Specify a pagination offset value for your API request. Example: An offset value of 100 combined with a limit value of 10 would show results 100-110. Default value is 0 , starting with the first available result. |
API Response:
{ "pagination": { "limit": 100, "offset": 0, "count": 100, "total": 1104 }, "data": [ { "ticker": "PIFFX" }, { "ticker": "PIG.PA" }, { "ticker": "PIGDX" }, [...] ] }
API Response Objects:
Response Object | Description |
---|---|
pagination > limit |
Returns your pagination limit value. |
pagination > offset |
Returns your pagination offset value. |
pagination > count |
Returns the results count on the current page. |
pagination > total |
Returns the total count of results available. |
ticker |
A unique symbol assigned to publicly traded shares of a company. |
ETF Holdings Info Available on: Basic Plan and higher
The ETF Holdings API delivers instantly complete set of exchange-traded funds data based on the unique identifier code of an ETF data Informaion. API End points return the details for the desired ETF ticker.
The example API request below illustrates how to obtain data for the Stock market index Information.
Example API Request:
Sign Up to Run API Requesthttps://api.marketstack.com/v2/etfholdings ? access_key = YOUR_ACCESS_KEY & ticker = PIFFX
Endpoint Features:
HTTP GET Request Parameters:
Object | Description |
---|---|
access_key |
[Required] Specify your API access key, available in your account dashboard. |
ticker |
[Required] To get results based on a ETF ticker. |
date_from |
[Optional] Filter results based on a specific timeframe by passing a from-date in YYYY-MM-DD format. |
date_to |
[Optional] Filter results based on a specific timeframe by passing an end-date in YYYY-MM-DD format. |
API Response:
{ "basics": { "fund_name": "AIM Investment Funds (Invesco Investment Funds)", "file_number": "811-05426", "cik": "0000826644", "reg_lei": "Y5W0BJB7U2X9V6NIC803" }, "output": { "attributes": { "series_name": "Invesco Multi-Asset Income Fund", "series_id": "S000035024", "series_lei": "54930019G62M8SP8B305", "ticker": "PIFFX", "isin": "US00888Y8396", "date_report_period": "2024-04-30", "end_report_period": "2024-10-31", "final_filing": false }, "signature": { "date_signed": "2024-05-30", "name_of_applicant": "AIM Investment Funds (Invesco Investment Funds)", "signature": "Adrien Deberghes", "signer_name": "Adrien Deberghes", "title": "Principal Financial Officer and Treasurer" }, "holdings": [ { "investment_security": { "lei": "549300MHDRBVRF6B9117", "isin": "US195325DL65", "name": "Colombia Government International Bond", "cusip": "195325DL6", "title": "Colombia Government International Bond", "units": "PA", "balance": "2250000.00000000", "currency": "USD", "value_usd": "2093614.81000000", "loan_by_fund": "N", "percent_value": "0.208307501168", "asset_category": "DBT", "payoff_profile": "Long", "restricted_sec": "N", "cash_collateral": "N", "issuer_category": "NUSS", "fair_value_level": "2", "invested_country": "CO", "non_cash_collateral": "N" } }, [...] ] } }
API Response Objects:
Response Object | Description |
---|---|
fund_name |
Returns the information for the Fund Name |
file_number |
Returns the file number under which the fund is registered. |
cik |
Returns the. SEC assigned key of the main trust fund |
reg_lei |
Returns the legal Entity Identifier. |
output > attributes > series_name |
Returns the name of the ETF series held by the fund. |
output > attributes > series_id |
Returns the ID of the ETF held by the fund. |
output > attributes > series_lei |
Returns the legal Entity Identifier of the ETF held by the fund. |
output > attributes > ticker |
Returns the unique ticker symbol assigned to the ETF. |
output > attributes > isin |
Returns international Securities Identification Number. |
output > attributes > date_report_period |
Returns the start date of the report needed. |
output > attributes > end_report_period |
Returns the end date of the report needed. |
output > attributes > final_filing |
Returns the final filling number. |
output > signature > date_signed |
Returns the date when the report is signed. |
output > signature > name_of_applicant |
Returns the name information of the applicant. |
output > signature > signature |
Returns the signature of the person who signed the report. |
output > signature > signer_name |
Returns the name of the person who signed the report. |
output > signature > title |
Returns the title of the person who signed the report. |
output > holdings > investment_security > lei |
Returns the legal Entity Identifier. |
output > holdings > investment_security > isin |
Returns international Securities Identification Number. |
output > holdings > investment_security > name |
Returns the name of the Holding owning the ETF. |
output > holdings > investment_security > cusip |
Returns nine-digit standard for identifying securities, only used for securities issued in the United States and Canada. |
output > holdings > investment_security > title |
Returns the title of the holding. |
output > holdings > investment_security > units |
Returns the units. |
output > holdings > investment_security > balance |
Returns the holding balance. |
output > holdings > investment_security > currency |
Returns the currency. |
output > holdings > investment_security > value_usd |
Returns the value usd. |
output > holdings > investment_security > loan_by_fund |
Returns the loan by fund. |
output > holdings > investment_security > percent_value |
Returns the percent value. |
output > holdings > investment_security > asset_category |
Returns the asset category. |
output > holdings > investment_security > payoff_profile |
Returns the payoff profile. |
output > holdings > investment_security > restricted_sec |
Returns the restricted sec. |
output > holdings > investment_security > cash_collateral |
Returns the cash collateral. |
output > holdings > investment_security > issuer_category |
Returns the issuer category. |
output > holdings > investment_security > fair_value_level |
Returns the fair value level. |
output > holdings > investment_security > invested_country |
Returns the invested country. |
output > holdings > investment_security > non_cash_collateral |
Returns the non cash collateral. |
ETF Holding Info (timeframe) Available on: Basic Plan and higher
ETF Holding Info (timeframe) holding data within a specified date range using a unique ticker identifier. You can adjust the ticker, date_from, and date_to parameters based on your specific needs.
The example API request below illustrates how to obtain data for the Stock market index Information within a specified date range.
Example API Request:
Sign Up to Run API Requesthttps://api.marketstack.com/v2/etfholdings ? access_key = YOUR_ACCESS_KEY & ticker = PIFFX & date_from = 2024-04-29 & date_to = 2024-11-01
HTTP GET Request Parameters:
For details on request parameters on the etfholdings
data endpoint, please jump to the ETF Holdings Information Data section.
Example API Response:
{ "basics": { "fund_name": "AIM Investment Funds (Invesco Investment Funds)", "file_number": "811-05426", "cik": "0000826644", "reg_lei": "Y5W0BJB7U2X9V6NIC803" }, "output": { "attributes": { "series_name": "Invesco Multi-Asset Income Fund", "series_id": "S000035024", "series_lei": "54930019G62M8SP8B305", "ticker": "PIFFX", "isin": "US00888Y8396", "date_report_period": "2024-04-30", "end_report_period": "2024-10-31", "final_filing": false }, "signature": { "date_signed": "2024-05-30", "name_of_applicant": "AIM Investment Funds (Invesco Investment Funds)", "signature": "Adrien Deberghes", "signer_name": "Adrien Deberghes", "title": "Principal Financial Officer and Treasurer" }, "holdings": [ { "investment_security": { "lei": "549300MHDRBVRF6B9117", "isin": "US195325DL65", "name": "Colombia Government International Bond", "cusip": "195325DL6", "title": "Colombia Government International Bond", "units": "PA", "balance": "2250000.00000000", "currency": "USD", "value_usd": "2093614.81000000", "loan_by_fund": "N", "percent_value": "0.208307501168", "asset_category": "DBT", "payoff_profile": "Long", "restricted_sec": "N", "cash_collateral": "N", "issuer_category": "NUSS", "fair_value_level": "2", "invested_country": "CO", "non_cash_collateral": "N" } }, [...] ] } }
API Response Objects:
For details of API response objects on the etfholdings
data endpoint, please jump to the ETF Holdings Information Data section.
FAQ
Ensuring our customers achieve success is paramount to what we do at APILayer. For this reason, we will be rolling out our Business Continuity plan guaranteeing your end users will never see a drop in coverage. Every plan has a certain amount of API calls that you can make in the given month. However, we would never want to cut your traffic or impact user experience negatively for your website or application in case you get more traffic.
What is an overage?
An overage occurs when you go over a quota for your API plan. When you reach your API calls limit, we will charge you a small amount for each new API call so we can make sure there will be no disruption in the service we provide to you and your website or application can continue running smoothly.
Prices for additional API calls will vary based on your plan. See table below for prices per call and example of an overage billing.
Plan Name | Monthly Price | Number of Calls | Overage Price per call | Overage | Total price |
---|---|---|---|---|---|
Basic | $9.99 | 10,000 | 0.0014985 | 2000 | $12.99 |
Professional | $49.99 | 100,000 | 0.00074985 | 20,000 | $64.99 |
Business | $149.99 | 500,000 | 0.00044997 | 100,000 | $194.99 |
Why does APILayer have overage fees?
Overage fees allow developers to continue using an API once a quota limit is reached and give them time to upgrade their plan based on projected future use while ensuring API providers get paid for higher usage.
How do I know if I will be charged for overages?
When you are close to reaching your API calls limit for the month, you will receive an automatic notification (at 75%, 90% and 100% of your monthly quota). However, it is your responsibility to review and monitor for the plan’s usage limitations. You are required to keep track of your quota usage to prevent overages. You can do this by tracking the number of API calls you make and checking the dashboard for up-to-date usage statistics.
How will I be charged for my API subscription?
You will be charged for your monthly subscription plan, plus any overage fees applied. Your credit card will be billed after the billing period has ended.
What happens if I don’t have any overage fees?
In this case, there will be no change to your monthly invoice. Only billing cycles that incur overages will see any difference in monthly charges. The Business Continuity plan is an insurance plan to be used only if needed and guarantees your end users never see a drop in coverage from you.
What if I consistently have more API calls than my plan allows?
If your site consistently surpasses the set limits each month, you may face additional charges for the excess usage. Nevertheless, as your monthly usage reaches a certain threshold, it becomes more practical to consider upgrading to the next plan. By doing so, you ensure a smoother and more accommodating experience for your growing customer base.
I would like to upgrade my plan. How can I do that?
You can easily upgrade your plan by going to your Dashboard and selecting the new plan that would be more suitable for your business needs. Additionally, you may contact your Account Manager to discuss a custom plan if you expect a continuous increase in usage.
Introducing Platinum Support - Enterprise-grade support for APILayer
Upgrade your APIlayer subscription with our exclusive Platinum Support, an exceptional offering designed to enhance your business’ API management journey. With Platinum Support, you gain access to a host of premium features that take your support experience to a whole new level.
What does Platinum Support include?
Standard Support | Platinum Support | |
---|---|---|
General review on the issue | ||
Access to knowledge base articles | ||
Email support communication | ||
Regular products updates and fixes | ||
Dedicated account team | ||
Priority Email Support with unlimited communication | ||
Priority bug and review updates | ||
Option for quarterly briefing call with product Management | ||
Features requests as priority roadmap input into product |
Priority Email Support: Experience unrivaled responsiveness with our priority email support. Rest assured that your inquiries receive top-priority attention, ensuring swift resolutions to any issues.
Unlimited Communication: Communication is key, and with Platinum Support, you enjoy unlimited access to our support team. No matter how complex your challenges are, our experts are here to assist you every step of the way.
Priority Bug Review and Fixes: Bugs can be a headache, but not with Platinum Support. Benefit from accelerated bug review and fixes, minimizing disruptions and maximizing your API performance.
Dedicated Account Team: We understand the value of personalized attention. That's why Platinum Support grants you a dedicated account team, ready to cater to your specific needs and provide tailored solutions.
Quarterly Briefing Call with Product Team: Stay in the loop with the latest updates and insights from our Product team. Engage in a quarterly briefing call to discuss new features, enhancements, and upcoming developments.
Priority Roadmap Input: Your input matters! As a Platinum Support subscriber, your feature requests receive top priority, shaping our product roadmap to align with your evolving requirements.
Don't settle for the standard when you can experience the exceptional. Upgrade to Platinum Support today and supercharge your APIlayer experience!