AlgoSeek Dataset API
The Dataset API from AlgoSeek — 10 operation(s) for dataset.
The Dataset API from AlgoSeek — 10 operation(s) for dataset.
openapi: 3.0.2
info:
title: metadata-api AWSAccount Dataset API
version: '1.2'
tags:
- name: Dataset
paths:
/api/v1/internal/dataset/:
get:
tags:
- Dataset
summary: List Dataset
description: Get a list of all datasets
operationId: get_datasets_internal_api_v1_internal_dataset__get
parameters:
- required: false
schema:
title: Is Active
type: boolean
name: is_active
in: query
- required: false
schema:
title: Is Public
type: boolean
name: is_public
in: query
- required: false
schema:
title: Status Id
type: integer
name: status_id
in: query
- required: false
schema:
title: Region Id
type: integer
name: region_id
in: query
- required: false
schema:
title: Datagroup Id
type: integer
name: datagroup_id
in: query
- required: false
schema:
title: Data Format Id
type: integer
name: data_format_id
in: query
- required: false
schema:
title: Data Class Id
type: integer
name: data_class_id
in: query
- required: false
schema:
title: Data Type Id
type: integer
name: data_type_id
in: query
- required: false
schema:
title: Time Granularity Id
type: integer
name: time_granularity_id
in: query
- required: false
schema:
title: Vendor Id
type: integer
name: vendor_id
in: query
- required: false
schema:
title: Publisher Id
type: integer
name: publisher_id
in: query
responses:
'200':
description: Successful Response
content:
application/json:
schema:
title: Response Get Datasets Internal Api V1 Internal Dataset Get
type: array
items:
$ref: '#/components/schemas/DatasetOutAdmin'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- HTTPBearer: []
post:
tags:
- Dataset
summary: Add Dataset
description: Add a new dataset
operationId: create_dataset_api_v1_internal_dataset__post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DatasetCreate'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/DatasetOutAdmin'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- HTTPBearer: []
/api/v1/internal/dataset/{dataset_id}/:
get:
tags:
- Dataset
summary: Get Dataset
description: Get dataset details by id
operationId: get_dataset_internal_api_v1_internal_dataset__dataset_id___get
parameters:
- required: true
schema:
title: Dataset Id
type: integer
name: dataset_id
in: path
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/DatasetOutAdmin'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- HTTPBearer: []
put:
tags:
- Dataset
summary: Update Dataset
description: Update dataset details by id
operationId: update_dataset_api_v1_internal_dataset__dataset_id___put
parameters:
- required: true
schema:
title: Dataset Id
type: integer
name: dataset_id
in: path
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DatasetUpdate'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/DatasetOutAdmin'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- HTTPBearer: []
delete:
tags:
- Dataset
summary: Delete Dataset
description: Delete a dataset record
operationId: delete_dataset_api_v1_internal_dataset__dataset_id___delete
parameters:
- required: true
schema:
title: Dataset Id
type: integer
name: dataset_id
in: path
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/DatasetOutAdmin'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- HTTPBearer: []
/api/v1/internal/dataset/text_id/{text_id}/:
get:
tags:
- Dataset
summary: Get Dataset
description: Get dataset details by text_id
operationId: get_dataset_by_text_id_internal_api_v1_internal_dataset_text_id__text_id___get
parameters:
- required: true
schema:
title: Text Id
type: string
name: text_id
in: path
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/DatasetOutAdmin'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- HTTPBearer: []
/api/v1/internal/dataset/ext/{dataset_id}/:
get:
tags:
- Dataset
summary: Get Extended Dataset
description: Get Extended Dataset details by id
operationId: get_ext_dataset_internal_api_v1_internal_dataset_ext__dataset_id___get
parameters:
- required: true
schema:
title: Dataset Id
type: integer
name: dataset_id
in: path
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ExtDatasetOutAdmin'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- HTTPBearer: []
/api/v1/public/dataset/{dataset_id}/:
get:
tags:
- Dataset
summary: Get Dataset
description: Get dataset details by id
operationId: get_dataset_public_api_v1_public_dataset__dataset_id___get
parameters:
- required: true
schema:
title: Dataset Id
type: integer
name: dataset_id
in: path
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/DatasetOutPublic'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- HTTPBearer: []
/api/v1/public/dataset/platform/frontend/text_id/{text_id}/:
get:
tags:
- Dataset
summary: Get Dataset for Platform Frontend
description: Get dataset details by text_id for platform frontend
operationId: get_platform_frontend_dataset_by_text_id_public_api_v1_public_dataset_platform_frontend_text_id__text_id___get
parameters:
- required: true
schema:
title: Text Id
type: string
name: text_id
in: path
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/PlatformFrontendDatasetOutPublic'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- HTTPBearer: []
/api/v1/public/dataset/platform/frontend/{dataset_id}/:
get:
tags:
- Dataset
summary: Get Dataset for Platform Frontend
description: Get dataset details by id for platform frontend
operationId: get_platform_frontend_dataset_public_api_v1_public_dataset_platform_frontend__dataset_id___get
parameters:
- required: true
schema:
title: Dataset Id
type: integer
name: dataset_id
in: path
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/PlatformFrontendDatasetOutPublic'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- HTTPBearer: []
/api/v1/public/dataset/platform/frontend/:
get:
tags:
- Dataset
summary: List Datasets for Platform Frontend
description: Get a list of all datasets for platform frontend
operationId: get_platform_frontend_datasets_public_api_v1_public_dataset_platform_frontend__get
parameters:
- required: false
schema:
title: Region Id
type: integer
name: region_id
in: query
- required: false
schema:
title: Data Format Id
type: integer
name: data_format_id
in: query
- required: false
schema:
title: Data Class Id
type: integer
name: data_class_id
in: query
- required: false
schema:
title: Data Type Id
type: integer
name: data_type_id
in: query
- required: false
schema:
title: Time Granularity Id
type: integer
name: time_granularity_id
in: query
- required: false
schema:
title: Status Id
type: integer
name: status_id
in: query
responses:
'200':
description: Successful Response
content:
application/json:
schema:
title: Response Get Platform Frontend Datasets Public Api V1 Public Dataset Platform Frontend Get
type: array
items:
$ref: '#/components/schemas/PlatformFrontendDatasetOutPublic'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- HTTPBearer: []
/api/v1/public/dataset/text_id/{text_id}/:
get:
tags:
- Dataset
summary: Get Dataset
description: Get dataset details by text_id
operationId: get_dataset_by_text_id_public_api_v1_public_dataset_text_id__text_id___get
parameters:
- required: true
schema:
title: Text Id
type: string
name: text_id
in: path
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/DatasetOutPublic'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- HTTPBearer: []
/api/v1/public/dataset/:
get:
tags:
- Dataset
summary: List Datasets
description: Get a list of all datasets
operationId: get_datasets_public_api_v1_public_dataset__get
parameters:
- required: false
schema:
title: Status Id
type: integer
name: status_id
in: query
- required: false
schema:
title: Region Id
type: integer
name: region_id
in: query
- required: false
schema:
title: Datagroup Id
type: integer
name: datagroup_id
in: query
- required: false
schema:
title: Data Format Id
type: integer
name: data_format_id
in: query
- required: false
schema:
title: Data Class Id
type: integer
name: data_class_id
in: query
- required: false
schema:
title: Data Type Id
type: integer
name: data_type_id
in: query
- required: false
schema:
title: Time Granularity Id
type: integer
name: time_granularity_id
in: query
- required: false
schema:
title: Publisher Name
type: string
name: publisher_name
in: query
- required: false
schema:
title: Publisher Id
type: integer
name: publisher_id
in: query
responses:
'200':
description: Successful Response
content:
application/json:
schema:
title: Response Get Datasets Public Api V1 Public Dataset Get
type: array
items:
$ref: '#/components/schemas/DatasetOutPublic'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- HTTPBearer: []
components:
schemas:
SQLColumnOutPublic:
title: SQLColumnOutPublic
required:
- table_id
- ordering
- id
type: object
properties:
name:
title: Name
type: string
data_type_simple:
title: Data Type Simple
type: string
data_type_db:
title: Data Type Db
type: string
compression:
title: Compression
type: string
endcoding:
title: Endcoding
type: string
description:
title: Description
type: string
table_id:
title: Table Id
type: integer
ordering:
title: Ordering
type: integer
id:
title: Id
type: integer
ExtDatasetOutAdmin:
title: ExtDatasetOutAdmin
required:
- text_id
- id
- internal_id
- internal_name
- is_active
- is_public
- created
- modified
type: object
properties:
text_id:
title: Text Id
type: string
full_name:
title: Full Name
type: string
display_name:
title: Display Name
type: string
description:
title: Description
type: string
long_description:
title: Long Description
type: string
creation_date:
title: Creation Date
type: string
format: date
start_date:
title: Start Date
type: string
format: date
end_date:
title: End Date
type: string
format: date
price_per_year:
title: Price Per Year
type: number
price_per_symbol:
title: Price Per Symbol
type: number
listing_priority:
title: Listing Priority
type: integer
tags:
title: Tags
type: array
items: {}
datagroup:
$ref: '#/components/schemas/ExtDataGroupOutAdmin'
data_format:
$ref: '#/components/schemas/EnumOutAdmin'
data_class:
$ref: '#/components/schemas/EnumOutAdmin'
data_type:
$ref: '#/components/schemas/EnumOutAdmin'
time_granularity:
$ref: '#/components/schemas/EnumOutAdmin'
region:
$ref: '#/components/schemas/EnumOutAdmin'
status:
$ref: '#/components/schemas/EnumOutAdmin'
publisher:
$ref: '#/components/schemas/ExtVendorOutAdmin'
documentation:
$ref: '#/components/schemas/ExtDocumentationOutAdmin'
delivery_methods:
title: Delivery Methods
type: array
items:
$ref: '#/components/schemas/EnumOutAdmin'
id:
title: Id
type: integer
internal_id:
title: Internal Id
type: string
internal_name:
title: Internal Name
type: string
short_name:
title: Short Name
type: string
vendor:
$ref: '#/components/schemas/ExtVendorOutAdmin'
cloud_storage:
$ref: '#/components/schemas/CloudStorageOutAdmin'
dataset_changes:
title: Dataset Changes
type: array
items:
$ref: '#/components/schemas/DatasetChangeOutAdmin'
database_table:
$ref: '#/components/schemas/DatabaseTableOutAdmin'
is_active:
title: Is Active
type: boolean
is_public:
title: Is Public
type: boolean
notes:
title: Notes
type: string
created:
title: Created
type: string
format: date-time
modified:
title: Modified
type: string
format: date-time
ValidationError:
title: ValidationError
required:
- loc
- msg
- type
type: object
properties:
loc:
title: Location
type: array
items:
anyOf:
- type: string
- type: integer
msg:
title: Message
type: string
type:
title: Error Type
type: string
ExtDataGroupOutAdmin:
title: ExtDataGroupOutAdmin
required:
- text_id
- status
- region
- pricing
- id
- internal_name
- is_active
- is_public
- created
- modified
type: object
properties:
text_id:
title: Text Id
type: string
display_name:
title: Display Name
type: string
full_name:
title: Full Name
type: string
description:
title: Description
type: string
universe_size:
title: Universe Size
type: integer
universe_description:
title: Universe Description
type: string
universe_components:
title: Universe Components
type: array
items:
type: string
symbols_per_component:
title: Symbols Per Component
type: array
items:
type: integer
tags:
title: Tags
type: array
items:
type: string
status:
$ref: '#/components/schemas/EnumOutAdmin'
region:
$ref: '#/components/schemas/EnumOutAdmin'
pricing:
$ref: '#/components/schemas/DataGroupPricingOutAdmin'
id:
title: Id
type: integer
internal_name:
title: Internal Name
type: string
is_active:
title: Is Active
type: boolean
is_public:
title: Is Public
type: boolean
notes:
title: Notes
type: string
created:
title: Created
type: string
format: date-time
modified:
title: Modified
type: string
format: date-time
CSVColumnOutPublic:
title: CSVColumnOutPublic
required:
- cloud_storage_id
- ordering
- id
type: object
properties:
name:
title: Name
type: string
data_type:
title: Data Type
type: string
description:
title: Description
type: string
cloud_storage_id:
title: Cloud Storage Id
type: integer
ordering:
title: Ordering
type: integer
id:
title: Id
type: integer
HTTPValidationError:
title: HTTPValidationError
type: object
properties:
detail:
title: Detail
type: array
items:
$ref: '#/components/schemas/ValidationError'
CloudStorageOutPublic:
title: CloudStorageOutPublic
required:
- text_id
- dataset_id
- id
type: object
properties:
text_id:
title: Text Id
type: string
sample_data_url:
title: Sample Data Url
type: string
sample_file_description:
title: Sample File Description
type: string
sample_file_id:
title: Sample File Id
type: integer
dataset_id:
title: Dataset Id
type: integer
id:
title: Id
type: integer
csv_columns:
title: Csv Columns
type: array
items:
$ref: '#/components/schemas/CSVColumnOutPublic'
bucket_groups:
title: Bucket Groups
type: array
items:
type: integer
ExtS3ObjectOutAdmin:
title: ExtS3ObjectOutAdmin
required:
- aws_account_id
- bucket_name
- object_name
- region_name
- id
- is_active
- is_public
- created
- modified
type: object
properties:
aws_account_id:
title: Aws Account Id
type: integer
bucket_name:
title: Bucket Name
type: string
object_name:
title: Object Name
type: string
region_name:
title: Region Name
type: string
id:
title: Id
type: integer
is_active:
title: Is Active
type: boolean
is_public:
title: Is Public
type: boolean
notes:
title: Notes
type: string
aws_account:
$ref: '#/components/schemas/EnumOutAdmin'
created:
title: Created
type: string
format: date-time
modified:
title: Modified
type: string
format: date-time
PlatformFrontendDatasetOutPublic:
title: PlatformFrontendDatasetOutPublic
required:
- id
- listing_priority
- internal_id
- text_id
type: object
properties:
id:
title: Id
type: integer
status_id:
title: Status Id
type: integer
cloud_storage_id:
title: Cloud Storage Id
type: integer
database_table_id:
title: Database Table Id
type: integer
full_name:
title: Full Name
type: string
short_name:
title: Short Name
type: string
description:
title: Description
type: string
sample_data_description:
title: Sample Data Description
type: string
sample_data_url:
title: Sample Data Url
type: string
bucket_size:
title: Bucket Size
type: string
bucket_name:
title: Bucket Name
type: string
bucket_path_format:
title: Bucket Path Format
type: string
bucket_path_description:
title: Bucket Path Description
type: string
start_year:
title: Start Year
type: integer
end_year:
title: End Year
type: integer
updates_interval:
title: Updates Interval
type: string
updates_expected_time:
title: Updates Expected Time
type: string
updates_size:
title: Updates Size
type: string
delivery_methods:
title: Delivery Methods
type: array
items:
type: string
data_class_id:
title: Data Class Id
type: integer
data_type_id:
title: Data Type Id
type: integer
vendor_id:
title: Vendor Id
type: integer
region_id:
title: Region Id
type: integer
documentation_link:
title: Documentation Link
type: string
listing_priority:
title: Listing Priority
type: integer
internal_id:
title: Internal Id
type: string
text_id:
title: Text Id
type: string
data_format_id:
title: Data Format Id
type: integer
time_granularity_id:
title: Time Granularity Id
type: integer
start_date:
title: Start Date
type: string
format: date
creation_date:
title: Creation Date
type: string
format: date
long_description:
title: Long Description
type: string
db_table_name:
title: Db Table Name
type: string
db_table_text_id_column:
title: Db Table Text Id Column
type: string
db_table_partition_column:
title: Db Table Partition Column
type: string
db_table_partition_expression:
title: Db Table Partition Expression
type: string
db_table_sort_columns:
title: Db Table Sort Columns
type: array
items:
type: string
universe_description:
title: Universe Description
type: string
ExtVendorOutAdmin:
title: ExtVendorOutAdmin
required:
- text_id
- full_name
- display_name
- internal_name
- is_active
- is_public
- id
- created
- modified
type: object
properties:
text_id:
title: Text Id
type: string
full_name:
title: Full Name
type: string
display_name:
title: Display Name
type: string
description:
title: Description
type: string
website:
title: Website
type: string
logo_url:
title: Logo Url
type: string
icon_url:
title: Icon Url
type: string
internal_name:
title: Internal Name
type: string
is_active:
title: Is Active
type: boolean
is_public:
title: Is Public
type: boolean
notes:
title: Notes
type: string
id:
title: Id
type: integer
created:
title: Created
type: string
format: date-time
modified:
title: Modified
type: string
format: date-time
DatasetChangeOutAdmin:
title: DatasetChangeOutAdmin
required:
- dataset_id
- effective_date
- description
- is_active
- is_public
- id
- created
- modified
type: object
properties:
dataset_id:
title: Dataset Id
type: integer
effective_date:
title: Effective Date
type: string
format: date
start_date:
title: Start Date
type: string
format: date
end_date:
title: End Date
type: string
format: date
description:
title: Description
type: string
is_active:
title: Is Active
type: boolean
is_public:
title: Is Public
type: boolean
notes:
title: Notes
type: string
id:
title: Id
type: integer
created:
title: Created
type: string
format: date-time
modified:
title: Modified
type: string
format: date-time
ExtPersonOutAdmin:
title: ExtPersonOutAdmin
required:
- first_name
- last_name
- email
- id
- is_active
- is_public
- created
- modified
type: object
properties:
first_name:
title: First Name
type: string
last_name:
title: Last Name
type: string
email:
title: Email
type: string
phone:
title: Phone
type: string
role:
title: Role
type: string
id:
title: Id
type: integer
is_active:
title: Is Active
type: boolean
is_public:
title: Is Public
type: boolean
notes:
title: Notes
type: string
created:
title: Created
type: string
format: date-time
modified:
title: Modified
type: string
format: date-time
vendor:
$ref: '#/components/schemas/ExtVendorOutAdmin'
DatasetUpdate:
title: DatasetUpdate
type: object
properties:
text_id:
title: Text Id
type: string
full_name:
title: Full Name
type: string
display_name:
title: Display Name
type: string
description:
title: Description
type: string
long_description:
title: Long Description
type: string
creation_date:
title: Creation Date
type: string
format: date
start_date:
title: Start Date
type: string
format: date
end_date:
title: End Date
type: string
format: date
price_per_year:
title: Price Per Year
type: number
price_per_symbol:
title: Price Per Symbol
type: number
listing_priority:
title: Listing Priority
type: integer
tags:
title: Tags
type: array
items: {}
datagroup_id:
title: Datagroup Id
type: integer
data_format_id:
title: Data Format Id
type: integer
data_class_id:
title: Data Class Id
type: integer
data_type_id:
title: Data Type Id
type: integer
time_granularity_id:
title: Time Granularity Id
type: integer
region_id:
title: Region Id
type: integer
status_id:
title: Status Id
type: integer
publisher_id:
title: Publisher Id
type: integer
documentation_id:
title: Documentation Id
type: integer
delivery_methods:
title: Delivery Methods
type: array
items:
type: integer
internal_id:
title: Internal Id
type: string
internal_name:
title: Internal Name
type: string
short_name:
title: Short Name
type: string
vendor_id:
title: Vendor Id
# --- truncated at 32 KB (51 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/algoseek/refs/heads/main/openapi/algoseek-dataset-api-openapi.yml