List Assets

Returns all tracked assets with optional filtering. Each asset record includes the latest market cap in USD plus the Weekly CAPR ByteTrend score and trend regime, denormalised from the latest computed metrics.

Request

curl https://api.bytetree.io/api/assets

# Filter by type
curl "https://api.bytetree.io/api/assets?type=stock"

# FX pairs (synthesised from rate data — see Polymorphic FX rows below)
curl "https://api.bytetree.io/api/assets?type=fx"

# Filter by universe dimension (e.g. Global Trends region = Americas)
curl "https://api.bytetree.io/api/assets?universe=global-trends-200&dimension=region&group=Americas"

# Text search
curl "https://api.bytetree.io/api/assets?q=apple"

# Paginate (advance offset until offset + count >= total)
curl "https://api.bytetree.io/api/assets?limit=100&offset=200"

Query Parameters

NameTypeRequiredDescription
typestringNoAsset type: stock, crypto, etf, index, commodity, or fx (synthesised — see Polymorphic FX rows)
statusstringNoAsset status: active, pending, or inactive
sectorstringNoSector name (e.g. Technology, Financial Services)
universestringNoUniverse slug (e.g. macro, global-trends-200) — see Universes. Use with dimension and group. Out-of-scope slugs return 403.
dimensionstringNoDimension: region, sector, industry, type, or country. Use with universe and group.
groupstringNoGroup label to filter by, exact match (e.g. Europe, Americas)
qstringNoCase-insensitive text search on symbol and name
limitnumberNoMaximum number of assets to return per page. Default 500, capped at 1000.
offsetnumberNoNumber of records to skip before returning results. Default 0. Pair with limit to paginate.

Universe Filter

Filter assets by universe dimension using universe + dimension + group. For direct configs, this filters by the source field value. For mapped configs, the mapping is reverse-resolved.

Available universes can be discovered via GET /api/universes.

Polymorphic FX rows

?type=fx returns FX pairs synthesised from rate data alongside the registered asset universe. FX rows expose the same shape as standard assets so polymorphic consumers can iterate without branching, but several asset-only fields (isin, sector, industry, country, region, mktCap, mktCapUsd) are null because FX pairs aren’t issuer-domiciled instruments. The name field is rendered in slash form (e.g. "EUR/USD") to disambiguate from concatenated symbols like EURUSD.

/api/fx is the canonical zero-ambiguity surface for FX score and metric data — consumers building FX-only views should prefer it. ?type=fx here is the polymorphic veneer for callers iterating across mixed asset types.

Response

This endpoint uses the paginated list envelope:

FieldTypeDescription
countnumberLength of the returned data array (records on this page)
totalnumberFull match count for the same filter, ignoring limit and offset
limitnumberEchoed input limit
offsetnumberEchoed input offset
dataarrayArray of asset objects

Each asset object:

FieldTypeDescription
_idstringMongoDB document ID
symbolstringTicker symbol (e.g. AAPL, BTCUSD)
namestringDisplay name
isinstring | nullISIN code (e.g. US0378331005)
typestringAsset type: stock, crypto, etf, index, or commodity
statusstringactive, pending, or inactive
sectorstring | nullSector name (e.g. Technology)
industrystring | nullIndustry name (e.g. Consumer Electronics)
countrystring | nullISO 3166-1 alpha-2 country code (e.g. US, GB)
regionstring | nullGeographic region derived from country (e.g. North America, Europe)
currencystringTrading currency (e.g. USD, GBP)
mktCapnumber | nullMarket cap in local currency (provider-reported)
mktCapUsdnumber | nullMarket cap in USD (from computed metrics)
byteTrendCapr200wnumber | nullLatest Weekly CAPR ByteTrend score (0–5), denormalised from latest metrics
trendRegimeCapr200wstring | nullLatest Weekly CAPR trend regime: Leading Trend, Emerging Trend, Weakening Trend, Bear Trend, or Neutral
changeCapr200wnumber | nullDay-over-day change in the Weekly CAPR score (−5 to +5)
{
  "count": 3,
  "total": 4287,
  "limit": 500,
  "offset": 0,
  "data": [
    {
      "_id": "66f1a2b3c4d5e6f7a8b9c0d1",
      "symbol": "AAPL",
      "name": "Apple Inc.",
      "isin": "US0378331005",
      "type": "stock",
      "status": "active",
      "sector": "Technology",
      "industry": "Consumer Electronics",
      "country": "US",
      "region": "North America",
      "currency": "USD",
      "mktCap": 3900000000000,
      "mktCapUsd": 3900000000000,
      "byteTrendCapr200w": 4,
      "trendRegimeCapr200w": "Emerging Trend",
      "changeCapr200w": 1
    },
    {
      "_id": "66f1a2b3c4d5e6f7a8b9c0d2",
      "symbol": "BTCUSD",
      "name": "Bitcoin USD",
      "isin": null,
      "type": "crypto",
      "status": "active",
      "sector": "Cryptocurrency",
      "industry": null,
      "country": null,
      "region": null,
      "currency": "USD",
      "mktCap": null,
      "mktCapUsd": 1300000000000,
      "byteTrendCapr200w": 2,
      "trendRegimeCapr200w": "Weakening Trend",
      "changeCapr200w": -1
    },
    {
      "_id": "66f1a2b3c4d5e6f7a8b9c0d3",
      "symbol": "GCUSD",
      "name": "Gold",
      "isin": null,
      "type": "commodity",
      "status": "active",
      "sector": null,
      "industry": null,
      "country": null,
      "region": null,
      "currency": "USD",
      "mktCap": null,
      "mktCapUsd": null,
      "byteTrendCapr200w": 5,
      "trendRegimeCapr200w": "Leading Trend",
      "changeCapr200w": 0
    }
  ]
}

Notes