Skip to main content
GET
/
v1
/
assets
/
{idOrSlug}
Get Asset
curl --request GET \
  --url https://api.blockworks.com/v1/assets/{idOrSlug} \
  --header 'x-api-key: <api-key>'
{
  "id": 2147483647,
  "code": "<string>",
  "title": "<string>",
  "slug": "<string>",
  "tag_line": "<string>",
  "description": "<string>",
  "image_url": "<string>",
  "sector": "<string>",
  "category": "<string>",
  "updated_at": 123,
  "market_cap": {
    "asset_id": 2147483647,
    "rank": 2147483647,
    "usd": 8.988465674311579e+307,
    "dominance": 1.7014115e+38,
    "percent_change_btc_1_h": 1.7014115e+38,
    "percent_change_btc_24_h": 1.7014115e+38,
    "percent_change_usd_1_h": 1.7014115e+38,
    "percent_change_usd_24_h": 1.7014115e+38,
    "percent_change_eth_1_h": 1.7014115e+38,
    "percent_change_eth_24_h": 1.7014115e+38,
    "updated_at": 123
  },
  "price": {
    "asset_id": 2147483647,
    "usd": 8.988465674311579e+307,
    "btc": 8.988465674311579e+307,
    "eth": 8.988465674311579e+307,
    "sparkline_7d": "<string>",
    "updated_at": 123
  }
}

​
Overview

Add the ?expand=supply flag to your /assets or /assets/{idOrSlug} page to include supply data in the response.

​
Example Request

curl -H "x-api-key: YOUR_API_KEY" \
  "https://api.blockworks.com/v1/assets/ethereum?expand=supply"

​
Example Response

{
  "id": 2,
  "code": "ETH",
  "title": "Ethereum",
  "slug": "ethereum",
  ... // other asset data
  "supply": {
    "circulating": 120702472.20949,
    "liquid": 0,
    "total": 120702572.39159
  }
}

​
Response Fields

FieldTypeDescription
circulatingnumberNumber of tokens currently in circulation
liquidnumberLiquid supply amount
totalnumberTotal token supply including locked tokens

​
Notes

  • Can be used with other expansion options by joining with a comma (e.g. ?expand=markets,ohlcv_last_24h).
  • Can be used on /v1/assets/ or /v1/assets/{idOrSlug} endpoints.
  • price and market_cap are expanded by default in /assets/{idOrSlug} results unless an explicit ?expand= flag is provided.

​
See also

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
idOrSlug
string
required

Query Parameters

​
expand
enum<string>[]
Available options:
addresses,
chains,
addresses.chain,
markets,
market_cap,
ohlcv_last_24_h,
price,
reference,
sector,
supply

Response

​
id
integer
required
Required range: 0 <= x <= 4294967295
​
code
string | null
required
Maximum string length: 20
​
title
string | null
required
Maximum string length: 100
​
slug
string | null
required
Maximum string length: 100
​
tag_line
string | null
required
Maximum string length: 255
​
description
string | null
required
Maximum string length: 65535
​
image_url
string | null
required
Maximum string length: 255
​
sector
string | null
required
Maximum string length: 50
​
category
string | null
required
Maximum string length: 25
​
updated_at
number | null
required

Unix timestamp

​
type
enum<string> | null
required
Available options:
Infrastructure,
Application
​
market_cap
object

Expandable relationship

​
price
object

Expandable relationship