The machine-readable OpenAPI 3.1 document is at
docs.atlasyield.club/api-reference/openapi.yaml.
Authentication
None for everything above. The API is public and read only. No key, no signup.Partner keys
Partners embedding Atlas in their own interface get a key, sent asx-api-key. It is an
unlock, not a gate: every public endpoint behaves the same with or without it. What it
adds (bulk factor breakdowns, the timestamped score history, a larger request budget) is
documented for partners only.
Contact us for partner keys and more
Tell us what you are building and which vaults you list. We reply with a key, the partner
endpoint reference, and pricing.
/scores and /catalog serve whatever is currently cached. /portfolio fails closed:
an allocation is an active recommendation, so it returns 503 rather than allocating on
stale scoring data. Treat a 503 as “ask again shortly”, not as an outage.Rate limits
60 requests / minute per IP. Exceeding it returns429 with standard
RateLimit-* headers. The dataset refreshes on a scoring cadence of hours, not seconds —
cache responses and poll sparingly.
Versioning
Everything lives under the/v1 prefix. Breaking changes ship under a new prefix; /v1
stays stable. Every score row also carries scorerVersion so you can pin to a scoring
engine revision.
Disclaimer
Atlas Scores are research and information, not investment advice. The same line ships on every response — as adisclaimer field and an X-Atlas-Disclaimer header. Scores are
neutral, model-driven signals; you are responsible for your own listing and allocation
decisions. See Limitations.