Welcome
Key Concepts
Everything in the ByteTree API builds on a handful of ideas. This page explains each one in plain terms. Every section ends with a link to the detailed reference, for when you want to go deeper.
Assets and symbols
An asset is anything ByteTree tracks: a stock, an ETF, a cryptocurrency, a commodity or a market
index. Each asset has a symbol — AAPL for Apple, BTCUSD for Bitcoin — and you use that symbol
whenever you ask about it. Currency pairs such as EURUSD (euros priced in US dollars) are tracked
too.
Go deeper: List Assets · Get Asset
Prices
ByteTree records a price for every asset once a day: the open, high, low and close, plus how much traded (volume). Stocks have a price for each trading day; crypto trades every day of the week, so it has one for every calendar day.
Prices are adjusted for stock splits and dividends by default. That keeps a price chart smooth — it doesn’t suddenly halve when a company splits its shares. If you need the price exactly as it was printed on the day, you can ask for the raw price instead.
Go deeper: Price History · Data Model
The ByteTrend score
ByteTrend is ByteTree’s measure of how strong an asset’s trend is: a whole number from 0 to 5, one point for each of five tests on the asset’s recent price. ByteTrend’s own documentation explains how the score works and the five rules.
Each score has a name, which ByteTrend.io uses too:
| Score | Reads as |
|---|---|
| 5 | Strong Bullish |
| 4 | Bullish |
| 3 | Neutral-Bullish |
| 2 | Neutral-Bearish |
| 1 | Bearish |
| 0 | Strong Bearish |
Four scores per asset
Every score comes in two timescales, Weekly (long-term) and Daily (shorter-term), see Daily and Weekly. It is also worked out two ways: Local, on the asset’s own price, and CAPR, against the world stock market, see Local and CAPR. That gives four scores for every asset, every day:
| Local (own price) | CAPR (against the market) | |
|---|---|---|
| Weekly | byteTrendLocal200w |
byteTrendCapr200w |
| Daily | byteTrendLocal30d |
byteTrendCapr30d |
Both timescales are recalculated every day: “Weekly” and “Daily” describe how far back each one looks, not how often it updates. List Assets rows carry the two CAPR scores, Weekly and Daily.
Go deeper: Latest Metrics — ByteTrend scores
Trend regimes
A trend regime is a short label for where an asset’s trend stands. It combines the score with
whether the price is at a recent high or low; ByteTrend’s documentation explains
the trend regimes. The API uses five labels:
Leading Trend, Emerging Trend, Weakening Trend, Bear Trend and Neutral. For Weekly CAPR, a
new label has to hold for five days in a row before it counts as confirmed, and the confirmed
label is the one to use when you look back over history.
Go deeper: Latest Metrics — Trend Regime · Regime Transitions
Universes
A universe is a named list of assets. bytetrend, for example, contains every stock, ETF,
cryptocurrency and commodity ByteTree tracks. Add a universe to an asset search to list just its
members:
/api/assets?universe=bytetrend
Go deeper: Universes — the full list, and how each one’s membership is decided
Dimensions and groups
Every asset is classified five ways: by region, country, sector, industry and asset type. These five are the dimensions. Each value within a dimension — Europe, Technology, Banks - Diversified — is a group.
ByteTree publishes daily figures for every group: average trend scores, how many assets are in each regime, returns and risk. That lets you compare, say, the average trend of European stocks with North American ones.
- Across everything ByteTree tracks — the Macro Dataset.
- Within one universe — Universe Groups.
Go deeper: Dimensions
Reading field names
Field names are compact but regular. byteTrendCapr200w reads as ByteTrend score · CAPR · Weekly,
and returnUsd12M as return in US dollars over 12 months. A trailing number and letter give the time
window:
| Suffix | Means | Example |
|---|---|---|
d |
days | 30d — the Daily score’s window |
w |
weeks | 200w — the Weekly score’s window |
M |
months | returnUsd1M — one-month return |
closeRawUsd, caprRaw and marketCapRawUsd hold the unadjusted, as-printed versions of the price, CAPR and
market value — see Data Model.
How often data updates
Once a day. Stocks and indices update on trading days; crypto updates every day; exchange rates update on weekdays. Scores and metrics are recalculated after each day’s prices arrive. Each nightly run adds the previous day (UTC) for assets, so an asset’s newest row is dated yesterday (UTC) at the latest, never the current day. A crypto day’s price is final at its 00:00 UTC close, so a crypto row’s price, CAPR and ByteTrend scores normally don’t change after it is published; the exception is a correction announced by the index publisher (see Data sources).
Next: Getting Started walks you through your first request.