Skip to main content
GET
/
v1
/
assets
curl
curl -X GET "https://api.services.payward.com/v1/assets" \
  -H "API-Key: $PWS_API_KEY" \
  -H "API-Nonce: $PWS_API_NONCE" \
  -H "API-Sign: $PWS_API_SIGN"
{
  "data": [
    {
      "symbol": "BTC",
      "type": "crypto",
      "name": "Bitcoin",
      "status": {
        "swap_trading": {
          "enabled": true,
          "disabled_against": []
        },
        "withdraw": {
          "enabled": true
        },
        "deposit": {
          "enabled": true
        }
      },
      "listing_date": "2013-09-12",
      "logo": {
        "width": 64,
        "height": 64,
        "href": "https://assets.payward.com/logos/btc.png",
        "type": "image/png"
      },
      "decimals": {
        "funding": 8,
        "swap": 8
      },
      "price": "67234.18",
      "market_cap": "1325840000000",
      "market_cap_rank": 1,
      "trending_rank": 3,
      "volume": {
        "last_24h": "38421000000"
      },
      "supply": {
        "circulating": "19720893",
        "total": "19720893",
        "max": "21000000",
        "in_quote": {
          "circulating": "1325840000000",
          "total": "1325840000000",
          "max": "1411917780000"
        }
      },
      "price_change_percent": {
        "last_1h": "0.21",
        "last_24h": "1.84",
        "last_7d": "-2.13",
        "last_30d": "6.42",
        "last_1y": "78.34"
      },
      "ath": {
        "value": "73750.07",
        "timestamp": "2024-03-14T14:08:00Z"
      }
    },
    {
      "symbol": "ETH",
      "type": "crypto",
      "name": "Ethereum",
      "status": {
        "swap_trading": {
          "enabled": true,
          "disabled_against": [
            {
              "symbol": "XLM",
              "type": "crypto"
            }
          ]
        },
        "withdraw": {
          "enabled": true
        },
        "deposit": {
          "enabled": true
        }
      },
      "listing_date": "2015-08-07",
      "logo": {
        "width": 64,
        "height": 64,
        "href": "https://assets.payward.com/logos/eth.png",
        "type": "image/png"
      },
      "decimals": {
        "funding": 8,
        "swap": 8
      },
      "price": "3251.40",
      "market_cap": "391200000000",
      "market_cap_rank": 2,
      "trending_rank": 5,
      "volume": {
        "last_24h": "17820000000"
      },
      "supply": {
        "circulating": "120284512",
        "total": "120284512",
        "max": null,
        "in_quote": {
          "circulating": "391200000000",
          "total": "391200000000",
          "max": null
        }
      },
      "price_change_percent": {
        "last_1h": "-0.12",
        "last_24h": "2.45",
        "last_7d": "-1.07",
        "last_30d": "4.91",
        "last_1y": "52.18"
      },
      "ath": {
        "value": "4878.26",
        "timestamp": "2021-11-10T14:24:00Z"
      }
    }
  ],
  "next_page_token": "eyJjdXJzb3IiOiJFVEgifQ=="
}

Authorizations

​
API-Key
string
header
required

Your public API key. Identifies the partner making the request.

​
API-Nonce
string
header
required

Monotonically increasing nonce included in the request signature.

​
API-Sign
string
header
required

HMAC signature over the request, computed with your private key.

Query Parameters

​
type
enum<string>[]

Filter assets by classification. Repeat the parameter to filter on multiple types.

Maximum array length: 4
Available options:
fiat,
crypto,
stablecoin,
xstock
​
swap_trading
boolean

Filter to assets that are currently enabled for swap trading. Omit to ignore this dimension.

​
withdraw
boolean

Filter to assets that are currently enabled for withdrawal. Omit to ignore this dimension.

​
deposit
boolean

Filter to assets that are currently enabled for deposit. Omit to ignore this dimension.

​
sort
enum<string>
default:market_cap_rank

Field to sort the results by. Use sort_direction to control ascending vs descending. Defaults to market_cap_rank (largest assets first when paired with asc).

Available options:
trending_rank,
market_cap_rank,
market_cap,
price,
volume.last_24h,
price_change_percent.last_1h,
price_change_percent.last_24h,
price_change_percent.last_7d,
price_change_percent.last_30d,
price_change_percent.last_1y,
symbol,
name,
listing_date
​
sort_direction
enum<string>
default:asc

Direction of the sort. Use asc for natural ascending order (rank 1 first, oldest first, lowest first); desc for the inverse.

Available options:
asc,
desc
​
page_size
integer<int32>
default:20

Maximum number of results to return on a single page. Defaults to 20, maximum 100.

Required range: 1 <= x <= 100
​
page_token
string

Opaque page token returned by a previous response's next_page_token. Omit to start from the beginning.

Required string length: 1 - 256
​
quote_symbol
string
default:USD

Ticker symbol of the fiat quote asset to use for valuations (e.g. USD, EUR). Defaults to USD. Ticker symbol of an asset (e.g. BTC, USDC, EUR).

Required string length: 3 - 16
Example:

"BTC"

​
quote_type
enum<string>
default:fiat

Classification of the quote asset. Currently only fiat is supported.

Available options:
fiat

Response

Response

​
data
object[]
required

The list of matching assets.

​
next_page_token
string

Opaque token for the next page of results. Absent when there are no more pages.

Required string length: 1 - 256