GET /v1/tokens/{address} returns one token. When the token is linked to a stock, the response includes a stock object with the stock’s ticker, currency, and exchange. When stock data is on for your API key, it also includes the market cap and fundamentals. Use it to show your users what the token tracks.
Enable stock data on your API key
Stock data is off by default on an API key. Without it, thestock object has only ticker, currency, and exchange. To turn it on for your key, contact contact@sunrise.xyz.
When stock data is on, the response includes marketCap, earnings, shares, and dividends. You don’t need to change your request.
Read a stock’s details
CallGET /v1/tokens/{address} with the token’s mint address. Find stock tokens with GET /v1/tokens?issuer=backpack_securities.
earnings entries are reported quarters. When the next report is scheduled, it’s added as a fifth entry with eps.reported set to null.
stock is null for a token that isn’t linked to a stock. Dates are ISO 8601 dates. In shares.outstanding, basic and diluted can be null when the data isn’t available.
marketCap, earnings, shares, and dividends can be missing when that data can’t be loaded. Treat a missing field as “not available right now”, not as an error.
Read earnings
Each entry inearnings is one quarter. fiscalPeriodEndDate is the last day of the quarter, and reportDate is the day the company reports it. reportSession is pre-market, post-market, during-market, or unknown.
Only the last entry can have eps.reported set to null. That quarter hasn’t been reported yet, so surpriseAmount and surprisePercent are null too. If its reportDate is today or earlier, the company is reporting and the results aren’t in yet.
In the other entries, eps.reported is always a number. eps.estimated is the consensus estimate, or null when there isn’t one. surpriseAmount is the reported EPS minus the estimate, or null without an estimate. surprisePercent is null without an estimate, or when the estimate is within 0.05 of zero.
Errors
See Errors for every code. For the full request and response schemas, see the API specification.

