Sign in

v2

latestOpenAPI 3.1.02026-07-312954143.9 KB
Dataset Metadata

Get Dataset Metadata

Get a dataset and its metadata

get/datasets/{dataset_id}

Path parameters

dataset_idstring required

Query parameters

api_keystring nullable

API key for authentication (query)

API key for authentication (query)

return_format'json' | 'csv'

The return format of the response

downloadboolean

Whether to download the file or not

Whether to download the file or not

json_schema'array-of-objects' | 'array-of-arrays'

The json schema of the response

Headers

x-api-keystring nullable

API key for authentication (header)

API key for authentication (header)

Response

Successful response

idstring required
namestring required
descriptionstring nullable required
earliest_available_time_utcstring date-time nullable required
latest_available_time_utcstring date-time nullable required
sourcestring nullable required
last_checked_time_utcstring date-time nullable required
primary_key_columnsstring[] nullable required
publish_time_columnstring nullable required
time_index_columnstring nullable required
subseries_index_columnstring nullable required
number_of_rows_approximateinteger nullable required
table_typestring nullable required
is_in_snowflakeboolean nullable required
data_frequencystring nullable required
source_urlstring nullable required
publication_frequencystring nullable required
is_publishedboolean nullable required
created_at_utcstring date-time nullable required
status'retired' | 'active' | 'deprecated' required
popularity_rankinteger nullable