The thirteen endpoint families as a map of the surface
Why this matters. Nearly ninety paths are not memorable. Thirteen families are. The skill this lesson builds is routing, and routing survives us shipping twenty more endpoints. Foundation: Which instrument does what?
This lesson deliberately does not list every path. Learn the families and one representative path each, and you will be able to place any request in seconds.
| Family | It answers | A path that lives there |
|---|---|---|
| Prices | what did this trade at, at any resolution | /eod/{ticker} |
| Corporate actions | what happened to the shares themselves | /div/{ticker} |
| Fundamentals and ownership | what did the company report, and who holds it | /fundamentals/{ticker} |
| Calendars | what is the market waiting for | /calendar/earnings |
| Reference data | what is this thing called, and where does it trade | /exchanges-list |
| Discovery | which instruments meet a condition | /screener |
| News and sentiment | what is being said, and how it reads | /news |
| Macro | what is the state of this economy | /macro-indicator/{country} |
| Rates | what does money cost | /rates/policy-rates |
| Credit | who might not pay, and at what price | /credit-risk/sovereign/credit-ratings |
| Beyond listed markets | commodities, property, sanctions, European indices | /commodities/historical/{code} |
| Marketplace | what partners sell through us | /mp/unicornbay/options/contracts |
| Account | what is this key allowed to do | /user |
How to use it
Given a request, name the family first and the path second. The family is a judgement you can make from the question alone; the path is a lookup, and looking it up is not a failure.
The full map, with every path, what it returns, the market question it answers and
the public lesson that teaches the idea, is generated and lives at
/academy/reference. It is built from the endpoint index and the market-product
map, so it cannot go stale against them. The next lesson is about reading it.
The families people forget
Two, consistently. Reference data, because it is not a market feed and therefore does not feel like the product, and it answers a surprising share of integration questions. And discovery, because clients who have never heard of the screener pull the entire universe every night to filter it themselves.
Try it now
Without looking anything up, name the family for each: the dates of the next earnings season; whether a country's borrowing costs have risen; every US stock above a billion in market cap; what a ticker was called before it was renamed.