Databento OpenAPI specification

{"openapi":"3.1.0","info":{"title":"Databento OpenAPI specification","version":"0.167.1"},"paths":{"/v0/":{"get":{"summary":"Read Api Root","operationId":"read_api_root_v0__get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/v0/analytics/collect":{"post":{"tags":["analytics"],"summary":"Create Usage Collect Entry","operationId":"create_usage_collect_entry_v0_analytics_collect_post","parameters":[{"name":"retry","in":"query","required":false,"schema":{"type":"integer","default":0,"title":"Retry"}},{"name":"db_session_id","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Db Session Id"}},{"name":"db_device_id","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Db Device Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SessionTrackCreate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v0/auth/login":{"post":{"tags":["auth"],"summary":"Login","operationId":"login_v0_auth_login_post","parameters":[{"name":"db_device_id","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Db Device Id"}}],"requestBody":{"required":true,"content":{"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/Body_login_v0_auth_login_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Token"}}}},"401":{"description":"If user email password authentication fails, or if user is not found."},"403":{"description":"If user does not have sufficient permissions. If team does not have sufficient permissions."},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v0/auth/logout":{"post":{"tags":["auth"],"summary":"Logout","operationId":"logout_v0_auth_logout_post","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DetailResponse"}}}},"401":{"description":"If user authentication fails"},"404":{"description":"If user not found"}},"security":[{"OAuth2PasswordBearerWithCookie":[]}]}},"/v0/auth/recover/{email}":{"post":{"tags":["auth"],"summary":"Recover Account","operationId":"recover_account_v0_auth_recover__email__post","parameters":[{"name":"email","in":"path","required":true,"schema":{"type":"string","format":"email","title":"Email"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DetailResponse"}}}},"404":{"description":"If user not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v0/auth/reset-password":{"post":{"tags":["auth"],"summary":"Reset Password","operationId":"reset_password_v0_auth_reset_password_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_reset_password_v0_auth_reset_password_post"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DetailResponse"}}}},"401":{"description":"If user authentication fails or invalid OTP"},"422":{"description":"If password validation fails"}}}},"/v0/auth/confirm-email-resend":{"post":{"tags":["auth"],"summary":"Confirm Email Resend","operationId":"confirm_email_resend_v0_auth_confirm_email_resend_post","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DetailResponse"}}}},"401":{"description":"If user authentication fails or invalid OTP"},"404":{"description":"If user or OTP not found"},"429":{"description":"If requests exceed rate limit"}},"security":[{"OAuth2PasswordBearerWithCookie":[]}]}},"/v0/auth/confirm-email-otp":{"post":{"tags":["auth"],"summary":"Confirm Email Otp","operationId":"confirm_email_otp_v0_auth_confirm_email_otp_post","security":[{"OAuth2PasswordBearerWithCookie":[]}],"parameters":[{"name":"retry","in":"query","required":false,"schema":{"type":"integer","default":0,"title":"Retry"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"string","title":"Otp"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DetailResponse"}}}},"401":{"description":"If user authentication fails or invalid OTP"},"404":{"description":"If user or OTP not found"},"429":{"description":"If request rate limit exceeded"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v0/auth/confirm-email-token":{"post":{"tags":["auth"],"summary":"Confirm Email Token","operationId":"confirm_email_token_v0_auth_confirm_email_token_post","requestBody":{"content":{"application/json":{"schema":{"type":"string","title":"Token"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"401":{"description":"If user authentication fails or invalid OTP"},"404":{"description":"If user not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v0/auth/cram":{"post":{"tags":["auth"],"summary":"Authenticate Cram","operationId":"authenticate_cram_v0_auth_cram_post","parameters":[{"name":"challenge","in":"query","required":true,"schema":{"type":"string","title":"Challenge"}},{"name":"user_reply","in":"query","required":true,"schema":{"type":"string","title":"User Reply"}},{"name":"dataset","in":"query","required":true,"schema":{"type":"string","title":"Dataset"}},{"name":"caller_pid","in":"query","required":true,"schema":{"type":"integer","title":"Caller Pid"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"400":{"description":"If user reply or bucket ID malformed (e.g. no hyphen), If `dataset` is invalid or not found."},"401":{"description":"If no user API key matches on CRAM user reply"},"403":{"description":"If user not in good standing, is deactivated, or has no entitlement for dataset"},"404":{"description":"If user for API key not found"},"422":{"description":"If dataset is not production ready, or not available for live"}}}},"/v0/auth/test":{"post":{"tags":["auth"],"summary":"Test Access Token","operationId":"test_access_token_v0_auth_test_post","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"401":{"description":"If user authentication fails"},"404":{"description":"If user not found"}},"security":[{"OAuth2PasswordBearerWithCookie":[]}]}},"/v0/auth/test-permissive":{"post":{"tags":["auth"],"summary":"Test Permissive","operationId":"test_permissive_v0_auth_test_permissive_post","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]},"type":"object","title":"Response Test Permissive V0 Auth Test Permissive Post"}}}}}}},"/v0/auth/frill_user_token/{board}":{"get":{"tags":["auth"],"summary":"Generate Frill Sso Token","operationId":"generate_frill_sso_token_v0_auth_frill_user_token__board__get","security":[{"OAuth2PasswordBearerWithCookie":[]}],"parameters":[{"name":"board","in":"path","required":true,"schema":{"type":"string","title":"Board"}},{"name":"retry","in":"query","required":false,"schema":{"type":"integer","default":0,"title":"Retry"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"string","title":"Response Generate Frill Sso Token V0 Auth Frill User Token  Board  Get"}}}},"401":{"description":"If user email password authentication fails"},"403":{"description":"If user does not have sufficient permissions"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v0/auth/intercom_user_hmac":{"get":{"tags":["auth"],"summary":"Generate Intercom User Hmac","operationId":"generate_intercom_user_hmac_v0_auth_intercom_user_hmac_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"string","title":"Response Generate Intercom User Hmac V0 Auth Intercom User Hmac Get"}}}},"401":{"description":"If user email password authentication fails"},"403":{"description":"If user does not have sufficient permissions"}},"security":[{"OAuth2PasswordBearerWithCookie":[]}]}},"/v0/batch/me":{"post":{"tags":["batch","log_post_param_vals"],"summary":"Submit Batch Request With Token Auth","operationId":"submit_batch_request_with_token_auth_v0_batch_me_post","security":[{"OAuth2PasswordBearerWithCookie":[]}],"parameters":[{"name":"dataset","in":"query","required":true,"schema":{"type":"string","title":"Dataset"}},{"name":"symbols","in":"query","required":true,"schema":{"type":"string","title":"Symbols"}},{"name":"schema","in":"query","required":true,"schema":{"type":"string","title":"Schema"}},{"name":"encoding","in":"query","required":true,"schema":{"type":"string","title":"Encoding"}},{"name":"start","in":"query","required":true,"schema":{"type":"string","title":"Start"}},{"name":"end","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"End"}},{"name":"stype_in","in":"query","required":false,"schema":{"type":"string","default":"raw_symbol","title":"Stype In"}},{"name":"stype_out","in":"query","required":false,"schema":{"type":"string","default":"instrument_id","title":"Stype Out"}},{"name":"compression","in":"query","required":false,"schema":{"type":"string","default":"none","title":"Compression"}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Limit"}},{"name":"pretty_px","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Pretty Px"}},{"name":"pretty_ts","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Pretty Ts"}},{"name":"map_symbols","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Map Symbols"}},{"name":"split_symbols","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Split Symbols"}},{"name":"split_duration","in":"query","required":false,"schema":{"type":"string","default":"day","title":"Split Duration"}},{"name":"split_size","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Split Size"}},{"name":"packaging","in":"query","required":false,"schema":{"type":"string","default":"none","title":"Packaging"}},{"name":"delivery","in":"query","required":false,"schema":{"type":"string","default":"download","title":"Delivery"}},{"name":"symbol","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Symbol"}},{"name":"retry","in":"query","required":false,"schema":{"type":"integer","default":0,"title":"Retry"}},{"name":"user-agent","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"User-Agent"}}],"responses":{"200":{"description":"Successful request (all symbols resolve)","content":{"application/json":{"schema":{}}}},"206":{"description":"Successful request (with partial symbol resolution)"},"400":{"description":"If bad or unacceptable query param"},"401":{"description":"If user authentication fails"},"402":{"description":"If insufficient funds"},"403":{"description":"If user does not have sufficient permissions"},"404":{"description":"If no data found for request"},"422":{"description":"If unprocessable request"},"429":{"description":"If request rate limit exceeded"}}},"get":{"tags":["batch","log_post_param_vals"],"summary":"List Batch Jobs With Auth Token","operationId":"list_batch_jobs_with_auth_token_v0_batch_me_get","security":[{"OAuth2PasswordBearerWithCookie":[]}],"parameters":[{"name":"query","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Query"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":500,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","default":0,"title":"Offset"}},{"name":"retry","in":"query","required":false,"schema":{"type":"integer","default":0,"title":"Retry"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"401":{"description":"If user authentication fails"},"403":{"description":"If user does not have sufficient permissions"},"429":{"description":"If request rate limit exceeded"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v0/batch.submit_job":{"post":{"tags":["batch","log_post_param_vals"],"summary":"Submit Batch Request With Basic Auth","operationId":"submit_batch_request_with_basic_auth_v0_batch_submit_job_post","security":[{"HTTPBasic":[]}],"parameters":[{"name":"retry","in":"query","required":false,"schema":{"type":"integer","default":0,"title":"Retry"}},{"name":"user-agent","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"User-Agent"}}],"requestBody":{"required":true,"content":{"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/Body_submit_batch_request_with_basic_auth_v0_batch_submit_job_post"}}}},"responses":{"200":{"description":"Successful request (all symbols resolve)","content":{"application/json":{"schema":{}}}},"206":{"description":"Successful request (with partial symbol resolution)"},"400":{"description":"If bad or unacceptable query param"},"401":{"description":"If user authentication fails"},"402":{"description":"If insufficient funds"},"404":{"description":"If no data found for request"},"422":{"description":"If unprocessable request, or no data found for request"},"429":{"description":"If request rate limit exceeded"}}}},"/v0/batch.list_jobs":{"get":{"tags":["batch","log_post_param_vals"],"summary":"List Batch Jobs","operationId":"list_batch_jobs_v0_batch_list_jobs_get","parameters":[{"name":"states","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"States"}},{"name":"since","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Since"}},{"name":"short","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Short"}},{"name":"retry","in":"query","required":false,"schema":{"type":"integer","default":0,"title":"Retry"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"401":{"description":"If user authentication fails"},"404":{"description":"If no data found for request"},"429":{"description":"If request rate limit exceeded"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v0/batch/progress/{job_id}":{"get":{"tags":["batch","log_post_param_vals"],"summary":"Get Job Progress By Id","operationId":"get_job_progress_by_id_v0_batch_progress__job_id__get","security":[{"OAuth2PasswordBearerWithCookie":[]}],"parameters":[{"name":"job_id","in":"path","required":true,"schema":{"type":"string","title":"Job Id"}},{"name":"retry","in":"query","required":false,"schema":{"type":"integer","default":0,"title":"Retry"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"401":{"description":"If user authentication fails"},"403":{"description":"If user does not have sufficient permissions"},"404":{"description":"If job ID not found"},"429":{"description":"If request rate limit exceeded"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v0/batch/files/{job_id}":{"get":{"tags":["batch","log_post_param_vals"],"summary":"Get Batch Files For Job","operationId":"get_batch_files_for_job_v0_batch_files__job_id__get","security":[{"OAuth2PasswordBearerWithCookie":[]}],"parameters":[{"name":"job_id","in":"path","required":true,"schema":{"type":"string","title":"Job Id"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":100,"title":"Limit"}},{"name":"protocol","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Protocol"}},{"name":"retry","in":"query","required":false,"schema":{"type":"integer","default":0,"title":"Retry"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"401":{"description":"If user authentication fails"},"403":{"description":"If user does not have sufficient permissions"},"429":{"description":"If request rate limit exceeded"},"501":{"description":"Unsupported delivery method"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v0/batch.list_files":{"get":{"tags":["batch","log_post_param_vals"],"summary":"List Batch Job Files With Basic Auth","operationId":"list_batch_job_files_with_basic_auth_v0_batch_list_files_get","security":[{"HTTPBasic":[]}],"parameters":[{"name":"job_id","in":"query","required":true,"schema":{"type":"string","title":"Job Id"}},{"name":"retry","in":"query","required":false,"schema":{"type":"integer","default":0,"title":"Retry"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BatchFileDetails"},"title":"Response List Batch Job Files With Basic Auth V0 Batch List Files Get"}}}},"401":{"description":"If user authentication fails"},"404":{"description":"If job file not found"},"410":{"description":"If job files are no longer available"},"429":{"description":"If request rate limit exceeded"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v0/batch/me/job_description/{job_id}":{"get":{"tags":["batch","log_post_param_vals"],"summary":"Get Job Description By Id","operationId":"get_job_description_by_id_v0_batch_me_job_description__job_id__get","security":[{"OAuth2PasswordBearerWithCookie":[]}],"parameters":[{"name":"job_id","in":"path","required":true,"schema":{"type":"string","title":"Job Id"}},{"name":"instrument_name","in":"query","required":true,"schema":{"type":"boolean","title":"Instrument Name"}},{"name":"retry","in":"query","required":false,"schema":{"type":"integer","default":0,"title":"Retry"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchJobDescription"}}}},"401":{"description":"If user authentication fails"},"403":{"description":"If user does not have sufficient permissions"},"404":{"description":"If job ID not found"},"429":{"description":"If request rate limit exceeded"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v0/batch/me/download/{job_id}/{filename}":{"get":{"tags":["batch","log_post_param_vals"],"summary":"Download Batch File With Token Auth","operationId":"download_batch_file_with_token_auth_v0_batch_me_download__job_id___filename__get","security":[{"OAuth2PasswordBearerWithCookie":[]}],"parameters":[{"name":"job_id","in":"path","required":true,"schema":{"type":"string","title":"Job Id"}},{"name":"filename","in":"path","required":true,"schema":{"type":"string","title":"Filename"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"401":{"description":"If user authentication fails"},"403":{"description":"If user does not have sufficient permissions"},"404":{"description":"If job file not found"},"410":{"description":"If job files are no longer available"},"429":{"description":"If request rate limit exceeded"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v0/batch.download":{"get":{"tags":["batch","log_post_param_vals"],"summary":"Download Batch Zip","operationId":"download_batch_zip_v0_batch_download_get","parameters":[{"name":"job_id","in":"query","required":true,"schema":{"type":"string","title":"Job Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"401":{"description":"If user authentication fails"},"404":{"description":"If job file not found"},"410":{"description":"If job files are no longer available"},"429":{"description":"If request rate limit exceeded"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v0/batch/download/{user_id}/{job_id}/{filename}":{"get":{"tags":["batch","log_post_param_vals"],"summary":"Download Batch File With Basic Auth","operationId":"download_batch_file_with_basic_auth_v0_batch_download__user_id___job_id___filename__get","security":[{"HTTPBasic":[]}],"parameters":[{"name":"user_id","in":"path","required":true,"schema":{"type":"string","title":"User Id"}},{"name":"job_id","in":"path","required":true,"schema":{"type":"string","title":"Job Id"}},{"name":"filename","in":"path","required":true,"schema":{"type":"string","title":"Filename"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"401":{"description":"If user authentication fails"},"404":{"description":"If job file not found"},"410":{"description":"If job files are no longer available"},"429":{"description":"If request rate limit exceeded"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v0/batch/display":{"get":{"tags":["batch","log_post_param_vals"],"summary":"Get Batch Job Display Mappings","operationId":"get_batch_job_display_mappings_v0_batch_display_get","parameters":[{"name":"retry","in":"query","required":false,"schema":{"type":"integer","default":0,"title":"Retry"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"429":{"description":"If request rate limit exceeded"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v0/batch/quote_job":{"post":{"tags":["batch","log_post_param_vals"],"summary":"Quote Batch Request","operationId":"quote_batch_request_v0_batch_quote_job_post","parameters":[{"name":"dataset","in":"query","required":true,"schema":{"type":"string","title":"Dataset"}},{"name":"symbols","in":"query","required":true,"schema":{"type":"string","title":"Symbols"}},{"name":"schema","in":"query","required":true,"schema":{"type":"string","title":"Schema"}},{"name":"encoding","in":"query","required":true,"schema":{"type":"string","title":"Encoding"}},{"name":"start","in":"query","required":true,"schema":{"type":"string","title":"Start"}},{"name":"end","in":"query","required":true,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"End"}},{"name":"stype_in","in":"query","required":false,"schema":{"type":"string","default":"raw_symbol","title":"Stype In"}},{"name":"stype_out","in":"query","required":false,"schema":{"type":"string","default":"instrument_id","title":"Stype Out"}},{"name":"compression","in":"query","required":false,"schema":{"type":"string","default":"none","title":"Compression"}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Limit"}},{"name":"split_symbols","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Split Symbols"}},{"name":"split_duration","in":"query","required":false,"schema":{"type":"string","default":"day","title":"Split Duration"}},{"name":"split_size","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Split Size"}},{"name":"packaging","in":"query","required":false,"schema":{"type":"string","default":"none","title":"Packaging"}},{"name":"map_symbols","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Map Symbols"}},{"name":"retry","in":"query","required":false,"schema":{"type":"integer","default":0,"title":"Retry"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchQuoteJobResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v0/batch/quote_user_job":{"post":{"tags":["batch","log_post_param_vals"],"summary":"Quote User Batch Request","operationId":"quote_user_batch_request_v0_batch_quote_user_job_post","parameters":[{"name":"dataset","in":"query","required":true,"schema":{"type":"string","title":"Dataset"}},{"name":"symbols","in":"query","required":true,"schema":{"type":"string","title":"Symbols"}},{"name":"schema","in":"query","required":true,"schema":{"type":"string","title":"Schema"}},{"name":"encoding","in":"query","required":true,"schema":{"type":"string","title":"Encoding"}},{"name":"start","in":"query","required":true,"schema":{"type":"string","title":"Start"}},{"name":"end","in":"query","required":true,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"End"}},{"name":"stype_in","in":"query","required":false,"schema":{"type":"string","default":"raw_symbol","title":"Stype In"}},{"name":"stype_out","in":"query","required":false,"schema":{"type":"string","default":"instrument_id","title":"Stype Out"}},{"name":"compression","in":"query","required":false,"schema":{"type":"string","default":"none","title":"Compression"}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Limit"}},{"name":"split_symbols","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Split Symbols"}},{"name":"split_duration","in":"query","required":false,"schema":{"type":"string","default":"day","title":"Split Duration"}},{"name":"split_size","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Split Size"}},{"name":"packaging","in":"query","required":false,"schema":{"type":"string","default":"none","title":"Packaging"}},{"name":"map_symbols","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Map Symbols"}},{"name":"retry","in":"query","required":false,"schema":{"type":"integer","default":0,"title":"Retry"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchQuoteJobResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v0/billing/dashboard":{"get":{"tags":["billing"],"summary":"Get Dashboard Data","operationId":"get_dashboard_data_v0_billing_dashboard_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingDashboardView"}}}},"401":{"description":"If user authentication fails"},"403":{"description":"If user does not have sufficient permissions"}},"security":[{"OAuth2PasswordBearerWithCookie":[]}]}},"/v0/billing/invoices":{"get":{"tags":["billing"],"summary":"List Invoice","operationId":"list_invoice_v0_billing_invoices_get","security":[{"OAuth2PasswordBearerWithCookie":[]}],"parameters":[{"name":"query","in":"query","required":true,"schema":{"type":"string","title":"Query"}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":5,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceListResponse"}}}},"401":{"description":"If user authentication fails"},"403":{"description":"If user does not have sufficient permissions"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v0/billing/upcoming_invoice":{"get":{"tags":["billing"],"summary":"Upcoming Invoice","operationId":"upcoming_invoice_v0_billing_upcoming_invoice_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceDraftStateView"}}}},"401":{"description":"If user authentication fails"},"403":{"description":"If user does not have sufficient permissions"}},"security":[{"OAuth2PasswordBearerWithCookie":[]}]}},"/v0/billing/invoice/{invoice_id}":{"get":{"tags":["billing"],"summary":"Get Invoice Detail","operationId":"get_invoice_detail_v0_billing_invoice__invoice_id__get","security":[{"OAuth2PasswordBearerWithCookie":[]}],"parameters":[{"name":"invoice_id","in":"path","required":true,"schema":{"type":"string","title":"Invoice Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"401":{"description":"If user authentication fails"},"403":{"description":"If user does not have sufficient permissions"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v0/billing/events":{"post":{"tags":["billing"],"summary":"Events","operationId":"events_v0_billing_events_post","parameters":[{"name":"stripe-signature","in":"header","required":false,"schema":{"type":"string","title":"Stripe-Signature"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v0/billing/tin":{"post":{"tags":["billing"],"summary":"Tin Updated","operationId":"tin_updated_v0_billing_tin_post","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/v0/billing/credits":{"get":{"tags":["billing"],"summary":"Get Credit Activity","operationId":"get_credit_activity_v0_billing_credits_get","security":[{"OAuth2PasswordBearerWithCookie":[]}],"parameters":[{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":5,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreditDashboardView"}}}},"401":{"description":"If user authentication fails"},"403":{"description":"If user does not have sufficient permissions"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v0/billing/team_budget":{"get":{"tags":["billing"],"summary":"Read Team Budget","operationId":"read_team_budget_v0_billing_team_budget_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BudgetChange"}}}},"401":{"description":"If user authentication fails"},"403":{"description":"If user does not have sufficient permissions"}},"security":[{"OAuth2PasswordBearerWithCookie":[]}]},"post":{"tags":["billing"],"summary":"Change Team Budget","operationId":"change_team_budget_v0_billing_team_budget_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BudgetChange"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BudgetChange"}}}},"401":{"description":"If user authentication fails"},"403":{"description":"If user does not have sufficient permissions"},"422":{"description":"Validation Error","content"

# --- truncated at 32 KB (233 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/databento/refs/heads/main/openapi/databento-platform-openapi-official.json