Skip to main content

Algoseek Datasets API — Advanced Reference

Markdown translation of the LaTeX guidebook (Algoseek_Datasets_API_Advanced_Guide.pdf / .tex), formatted for Docusaurus.

Layout

Each top-level chapter of the guide is one numbered markdown file (01-intro.md through 17-pitfalls.md). The two appendices live under appendix/. The numeric prefixes drive the Docusaurus sidebar order; you can either keep the prefixes or use the sidebar_position value in each file's front matter and rename to plain slugs.

FileChapter
01-intro.mdWhat this API gives you
02-setup.mdSetting up: API keys, environment hygiene, and key lifecycle
03-auth.mdAuthentication: the X-API-KEY header and account-level quotas
04-conventions.mdAPI conventions cheatsheet
05-first-request.mdYour first request: /status and the identity envelope
06-catalog.mdThe dataset catalog: programmatic discovery
07-filter-project.mdFiltering and projection
08-pagination.mdPagination: walking large result sets
09-formats.mdResponse formats: JSON, CSV, and streaming gzip
10-errors.mdErrors, HTTP status codes, and idempotency
11-quotas.mdRate limits and quotas: scheduling, backoff, and quota arithmetic
12-eq-taq.mdUS Equity Trade and Quote (TAQ) data
13-eq-opt.mdUS Equity Options data
14-eq-ref.mdReference data: corporate actions, IPOs, calendars, security master
15-fut.mdUS Futures data
16-ingestion.mdBuilding a robust ingestion client
17-pitfalls.mdCommon pitfalls and gotchas
appendix/endpoints.mdEndpoint reference (full per-endpoint cards)
appendix/glossary.mdGlossary

Docusaurus conventions used

  • Front matter with id, title, sidebar_position, and slug on every page.
  • Admonitions (:::tip, :::note, :::warning, :::caution) replace the LaTeX tipbox, notebox, warningbox, and gotchabox environments. :::caution Gotcha is used for the LaTeX gotchabox.
  • Code blocks use Docusaurus's title="..." attribute on the opening fence to reproduce the LaTeX caption= text. Language identifiers (bash, http, json, python, java, cpp, csv, powershell) are set on each fence so syntax highlighting works.
  • Math (used only in the reference chapter) uses $...$ and $$...$$ and assumes you have enabled the remark-math / rehype-katex plugins in docusaurus.config.js. If you have not, see the Docusaurus math docs.
  • Internal links are relative paths between files (e.g. [quotas](./11-quotas.md)).