# Olympus

> Olympus (Government Data Infrastructure by New Odyssey) serves U.S. government data as developer APIs with provenance on every record. Live APIs: the US Geographic & Demographics API (Census ACS 5-year demographics for ZCTAs and counties, NCES public schools, comparison; paths under /v1/geo-demographics) and the US SEC Filings & Financial Data API (SEC EDGAR companies, 10-K/10-Q filings, standardised XBRL financial metrics; paths under /v1/sec). The other 32 APIs in the catalogue are planned and not available yet.

Base URL: https://api.olympus.new-odyssey.com
Authentication: send an organization API key in the X-API-Key header (or Authorization: Bearer). Keys are created in the console at https://olympus.new-odyssey.com/console/keys after sign-up at https://olympus.new-odyssey.com/signup.
Errors: JSON {"error", "code", "product"?, "details"?}; every response has X-Request-Id.
Limits: per-minute rate limit and monthly per-product quota by plan; see X-RateLimit-* and X-Quota-* headers; 429 RATE_LIMIT_EXCEEDED / QUOTA_EXCEEDED.

Important caveats:
- ZCTAs are Census ZIP Code Tabulation Areas, not USPS ZIP codes; codes resolve only by exact ZCTA match (404 ZCTA_NOT_FOUND otherwise).
- ACS values are 5-year survey estimates with 90% margins of error (moe) and a stated vintage; they describe that period, not the present.
- SEC values are as filed (EDGAR nightly bulk archives); restatements are flagged with the first reported value.
- Not included: crime data, school ratings, risk scores, private schools, insider trading, full-text filing search, real-time streams.

## US Geographic & Demographics API

Census ACS demographics for ZCTAs and counties, NCES public schools, comparison.

- Reference: https://olympus.new-odyssey.com/docs/geo-demographics
- OpenAPI: https://olympus.new-odyssey.com/openapi/geo-demographics.yaml

- GET /v1/geo-demographics/locations/{zcta}: ZCTA profile
- GET /v1/geo-demographics/locations/{zcta}/demographics: ZCTA demographics
- GET /v1/geo-demographics/locations/{zcta}/schools: Public schools near a ZCTA
- POST /v1/geo-demographics/locations/compare: Compare two ZCTAs
- GET /v1/geo-demographics/counties/{fips}: County profile
- GET /v1/geo-demographics/coverage: Datasets, vintages and coverage

## US SEC Filings & Financial Data API

SEC EDGAR companies, 10-K / 10-Q filings and standardised XBRL financials.

- Reference: https://olympus.new-odyssey.com/docs/sec
- OpenAPI: https://olympus.new-odyssey.com/openapi/sec.yaml

- GET /v1/sec/companies/search: Search companies by name or ticker, or resolve a ticker
- GET /v1/sec/companies/{cik}: Company profile
- GET /v1/sec/companies/{cik}/filings: 10-K and 10-Q filings of a company
- GET /v1/sec/companies/{cik}/financials: Financial metric history of a company
- GET /v1/sec/financials/compare: Compare one metric across companies

## Platform

Accounts, organizations, API keys and usage.

- Reference: https://olympus.new-odyssey.com/docs/platform
- OpenAPI: https://olympus.new-odyssey.com/openapi/platform.yaml

- GET /health: Liveness
- GET /health/live: Liveness
- GET /health/ready: Readiness (database and Redis)
- POST /v1/auth/signup: Create an account
- POST /v1/auth/verify-email: Verify an email address
- POST /v1/auth/resend-verification: Resend the verification email
- POST /v1/auth/login: Sign in
- POST /v1/auth/logout: Sign out
- POST /v1/auth/forgot-password: Request a password reset email
- POST /v1/auth/reset-password: Set a new password with a reset token
- GET /v1/me: The signed-in user and their organizations
- GET /v1/organizations: List my organizations
- GET /v1/organizations/{org_id}: Get an organization with its plan and entitlements
- GET /v1/organizations/{org_id}/members: List members
- PATCH /v1/organizations/{org_id}/members/{user_id}: Change a member's role
- DELETE /v1/organizations/{org_id}/members/{user_id}: Remove a member
- GET /v1/organizations/{org_id}/api-keys: List API keys (secrets are never returned)
- POST /v1/organizations/{org_id}/api-keys: Create an API key
- DELETE /v1/organizations/{org_id}/api-keys/{key_id}: Revoke an API key
- POST /v1/organizations/{org_id}/api-keys/{key_id}/rotate: Rotate an API key
- GET /v1/organizations/{org_id}/audit-log: List audit events (owners and admins)
- GET /v1/organizations/{org_id}/usage: Organization usage (console)
- GET /v1/usage: Usage for the API key's organization

## Plans

- Free: $0/month, 1,000 requests per product per month, 10/min
- Developer: $79/month, 50,000 requests per product per month, 60/min
- Growth: $299/month, 250,000 requests per product per month, 300/min
- Business: $999/month, 1,000,000 requests per product per month, 1000/min
- Enterprise: $2,500/month, Unlimited requests per product per month, 3000/min

## Docs

- Quickstart: https://olympus.new-odyssey.com/docs
- API catalogue (live and planned): https://olympus.new-odyssey.com/apis
- Coverage and sources: https://olympus.new-odyssey.com/coverage
- Pricing: https://olympus.new-odyssey.com/pricing