Sign in
latestOpenAPI 3.1.02026-08-145096557.0 KB

1c983de099e2

dataset-info

Get dataset info

Retrieves the dataset metadata details

get/v1/meta/datasets/{dataset_id}/info

Path parameters

dataset_idstring required

A short internal dataset identifier (unique).

A short internal dataset identifier (unique).

Response

Successful Response

dataset_idstring required

A short internal dataset identifier (unique).

dataset_namestring required

A human-readable display name of the dataset.

data_groupstring required

The Data group to which the dataset belongs.

vendorstring required

The name of the data vendor.

descriptionstring nullable required

A detailed description of the dataset.

dataset_classstring required

The name of dataset's asset class.

dataset_formatstring required

The format of the dataset.

time_granularitystring required

The format of the time interval between data points in the dataset.

documentation_linkstring uri required

A URL to the dataset documentation.

start_datestring date required

The earliest available date of data in the dataset.

end_datestring date nullable required

The latest available date of data in the dataset, or null if ongoing.

is_time_seriesboolean required

A flag indicating whether the dataset contains time-series data.

universe_identifierstring nullable required

The name of the identifier used for the universe of instruments.

creation_datestring date required

The date when the dataset was created.

Example response

{
  "dataset_id": "US1032",
  "dataset_name": "US Equities Trade and Quote",
  "data_group": "US Equity",
  "vendor": "algoseek",
  "description": "The dataset provides a deep dive into the US Equities market through detailed trade and quote data. It leverages the full SIP feed from Tape A, Tape B, and Tape C, incorporating trades and bid/ask quotes from all listed exchanges.",
  "dataset_class": "Futures",
  "dataset_format": "Market Data",
  "time_granularity": "Tick",
  "documentation_link": "https://www.algoseek.com/datasets/doc/eq_taq",
  "start_date": "2007-08-01",
  "is_time_series": true,
  "universe_identifier": "Ticker",
  "creation_date": "2024-03-26"
}