Get dataset info

Retrieves the dataset metadata details

GET https://api.devalgoseek.com/api/v1/meta/datasets/:dataset_id/info#

Retrieves the dataset metadata details

Request#

Path Parameters#

dataset_id Dataset Idrequired

A short internal dataset identifier (unique).

Example: US1032

Responses#

Successful Response

application/json

Schema
Example (auto)

Schema

dataset_idstringrequired

A short internal dataset identifier (unique).

Example: US1032

dataset_text_idstringrequired

A unique text identifier of the dataset.

Example: eq_taq

dataset_namestringrequired

A human-readable display name of the dataset.

Example: US Equities Trade and Quote

data_groupstringrequired

The Data group to which the dataset belongs.

Example: US Equity

vendorstringrequired

The name of the data vendor.

Example: algoseek

descriptionstringrequired

A detailed description of the dataset.

Example:

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_classstringrequired

The name of dataset's asset class.

Example: Futures

dataset_formatstringrequired

The format of the dataset.

Example: Market Data

time_granularitystringrequired

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

Example: Tick

documentation_linkurirequired

A URL to the dataset documentation.

Possible values: non-empty and <= 2083 characters

Example: https://www.algoseek.com/datasets/doc/eq_taq

start_datedaterequired

The earliest available date of data in the dataset.

Example: 2007-08-01

end_datedaterequired

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

Examples:

Example 1
Example 2

Example: null

Example: 2024-12-31

is_time_seriesbooleanrequired

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

Example: true

universe_identifierstringrequired

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

Example: Ticker

creation_datedaterequired

The date when the dataset was created.

Example: 2024-03-26

{
  "dataset_id": "US1032",
  "dataset_text_id": "eq_taq",
  "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",
  "end_date": null,
  "is_time_series": true,
  "universe_identifier": "Ticker",
  "creation_date": "2024-03-26"
}

Validation Error

application/json

Schema
Example (auto)

Schema

detail object[]

Array [

loc object[]required

Array [

anyOf

string
integer

string

]

msgstringrequired

typestringrequired

inputInput

ctxobject

]

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string",
      "ctx": {}
    }
  ]
}

Authorization: X-API-KEY#

name: X-API-KEYtype: apiKeyin: header

HTTPCLIENT
RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://api.devalgoseek.com/api/v1/meta/datasets/:dataset_id/info");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("X-API-KEY", "<X-API-KEY>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Response

Click the Send API Request button above and see the response here!

← Previous

US Futures Trade and Quote

US Equities Lookup File