Query Core Data#

Here is the easiest way to get started querying core financial data.

Prerequisite

IEX Cloud Apperate account - Create one here.

Step 1: Go to the API Reference#

Go to the IEX Cloud Data in the API Reference. The core endpoint names appear grouped by data bundle in the navigation sidebar.

Note

If the IEX Cloud Data endpoint names aren’t showing in the sidebar, click IEX Cloud Data in the sidebar to expand the endpoint list.

Step 2: Open a Data Endpoint Page#

Click a data endpoint name to view its reference page. The endpoint page appears.

Endpoint reference pages include the following items:

Description
Example HTTP requests (the one used in the HTTP Request/Response section on the right)
Path parameters
Query parameters
Response attributes
Data Bundle
Workspace ID
Dataset ID
Data timing
Update schedule
Resource links

Step 3: Try Out an Example HTTP Request#

Click one of the Example HTTP Request URLs (the image above highlights one). Your browser sends the request and shows the response.

Here’s a request and response for Microsoft’s latest Historical EOD Options data.

Request:

https://api.iex.cloud/v1/data/CORE/OPTION_PRICES/MSFT

Response:

[
  {
    "ask": 19.45,
    "bid": 19.1,
    "cfiCode": "OPAXXX",
    "close": 21.9,
    "closingPrice": 21.9,
    "contractDescription": "MSFT Option Put 16/06/2023 270 on Ordinary Shares",
    "contractName": "Microsoft Corp",
    "contractSize": 100,
    "currency": "USD",
    "exchangeCode": null,
    "exchangeMIC": null,
    "exerciseStyle": "A",
    "expirationDate": "20230616",
    "figi": "",
    "high": 20.75,
    "isAdjusted": false,
    "lastTradeDate": "2023-03-14",
    "lastTradeTime": "21:01:35",
    "lastUpdated": "2023-03-14",
    "low": 19.55,
    "marginPrice": 0,
    "open": 20.75,
    "openInterest": 5906,
    "optionId": "MSFT20230616P00270000",
    "settlementPrice": 0,
    "side": "put",
    "strikePrice": 270,
    "symbol": "MSFT",
    "type": "equity",
    "volume": 5,
    "id": "OPTION_PRICES",
    "key": "MSFT",
    "subkey": "MSFT20230616P00270000",
    "date": 1678752000000,
    "updated": 1678895081172.354
  }
]

Note

If the request didn’t include your API token, you can get for your API token in the Console.

Step 4: Examine the Endpoint’s Options#

In the endpoint reference page, scroll down to the Path Parameters table. A key label and subkey label (not in all endpoints) denotes the dataset’s primary index and secondary index. Most core endpoints accept a key path parameter. Some core endpoints have a subkey; the subkey can be used as an additional path parameter, after the key path parameter.

The Response Attributes table, further down the page, describes the data’s attributes (columns) and also indicates indexes. In addition to key and subkey it includes the date index.

key denotes the primary index
subkey (not in all endpoints) denotes a secondary index
date denotes the date index

The image below shows some of the Historical EOD Options endpoint response attributes.

If a data endpoint has a date index, it is a time series endpoint and it supports time-windowing–filtering on a specific time or time range.

Step 5: Refine Your Query#

Experiment with endpoints by entering different values for the key path parameter. If it’s a time series data endpoint, you can use on=timestamp, range=some_range, or other time range query parameters to time-window your results.

For example, below is a request and response for the last hour of Amazon option prices.

Request:

https://api.iex.cloud/v1/data/CORE/OPTION_PRICES/AMZN?range=1h

Response:

[
  {
    "ask": 8.75,
    "bid": 8.4,
    "cfiCode": "OPAXXX",
    "close": 8.3,
    "closingPrice": 8.3,
    "contractDescription": "AMZN Option Put 24/03/2023 102 on Ordinary Shares",
    "contractName": "Amazon.com",
    "contractSize": 100,
    "currency": "USD",
    "exchangeCode": null,
    "exchangeMIC": null,
    "exerciseStyle": "A",
    "expirationDate": "20230324",
    "figi": "BBG01CB25Y23",
    "high": 8.3,
    "isAdjusted": false,
    "lastTradeDate": "2023-02-28",
    "lastTradeTime": "22:01:31",
    "lastUpdated": "2023-02-28",
    "low": 8.3,
    "marginPrice": 0,
    "open": 8.3,
    "openInterest": 239,
    "optionId": "AMZN20230324P00102000",
    "settlementPrice": 0,
    "side": "put",
    "strikePrice": 102,
    "symbol": "AMZN",
    "type": "equity",
    "volume": 1,
    "id": "OPTION_PRICES",
    "key": "AMZN",
    "subkey": "AMZN20230324P00102000",
    "date": 1677542400000,
    "updated": 1677685433166.881
  }
]

Congratulations on your start in querying a IEX Cloud core financial data!

What’s Next#

Querying Data in iexjs shows how to query data using the iexjs JavaScript client library.

Batch Data Queries demonstrates batching data queries in a single call.

Data Bundles describes the data categories and their data bundles. The data bundle pages link directly to each API endpoint’s reference page.

Work with Core Time Series Data in the Console shows you how to explore IEX Cloud time series data endpoints, query them, share them, and access their docs from the Apperate Console.

Create a View demonstrates using SQL JOIN to combine datasets into views.