List User Assets - Payward Developer Documentation

curl

curl -X GET "https://api.services.payward.com/v1/users/AA07%20N84G%20DLNK%20DA3I/assets" \
  -H "API-Key: $PWS_API_KEY" \
  -H "API-Nonce: $PWS_API_NONCE" \
  -H "API-Sign: $PWS_API_SIGN"

import requests

url = "https://api.services.payward.com/v1/users/{user_id}/assets"

headers = {
    "API-Key": "<api-key>",
    "API-Nonce": "<api-key>",
    "API-Sign": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'API-Key': '<api-key>', 'API-Nonce': '<api-key>', 'API-Sign': '<api-key>'}
};

fetch('https://api.services.payward.com/v1/users/{user_id}/assets', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.services.payward.com/v1/users/{user_id}/assets",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "API-Key: <api-key>",
    "API-Nonce: <api-key>",
    "API-Sign: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.services.payward.com/v1/users/{user_id}/assets"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("API-Key", "<api-key>")
	req.Header.Add("API-Nonce", "<api-key>")
	req.Header.Add("API-Sign", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.services.payward.com/v1/users/{user_id}/assets")
  .header("API-Key", "<api-key>")
  .header("API-Nonce", "<api-key>")
  .header("API-Sign", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.services.payward.com/v1/users/{user_id}/assets")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["API-Key"] = '<api-key>'
request["API-Nonce"] = '<api-key>'
request["API-Sign"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "symbol": "BTC",
      "type": "crypto",
      "name": "Bitcoin",
      "status": {
        "swap_trading": {
          "enabled": true,
          "disabled_against": [
            {
              "symbol": "USDT",
              "type": "stablecoin",
              "name": "Tether USD"
            },
            {
              "symbol": "SOL",
              "type": "crypto",
              "name": "Solana"
            }
          ]
        },
        "withdraw": {
          "enabled": true
        },
        "deposit": {
          "enabled": true
        }
      },
      "logo": {
        "width": 400,
        "height": 400,
        "href": "https://assets.kraken.com/marketing/web/icons-uni-webp/s_btc.webp",
        "type": "image/webp"
      },
      "decimals": {
        "funding": 8,
        "swap": 10
      },
      "listing_date": "2013-10-06",
      "price": "62081",
      "market_cap": "1244183483835",
      "market_cap_rank": 1,
      "trending_rank": 66,
      "volume": {
        "last_24h": "53096507160"
      },
      "supply": {
        "circulating": "20038918",
        "total": "20038918",
        "max": "21000000",
        "in_quote": {
          "circulating": "1244036068358",
          "total": "1244036068358",
          "max": "1303701000000"
        }
      },
      "price_change_percent": {
        "last_1h": "-0.312449",
        "last_24h": "-0.584983",
        "last_7d": "-15.616145",
        "last_30d": "-24.558477",
        "last_1y": "-40.690849"
      },
      "ath": {
        "value": "126080",
        "timestamp": "2025-10-06T18:57:42Z"
      }
    },
    {
      "symbol": "ETH",
      "type": "crypto",
      "name": "Ethereum",
      "status": {
        "swap_trading": {
          "enabled": true,
          "disabled_against": [
            {
              "symbol": "USDT",
              "type": "stablecoin",
              "name": "Tether USD"
            },
            {
              "symbol": "SOL",
              "type": "crypto",
              "name": "Solana"
            }
          ]
        },
        "withdraw": {
          "enabled": true
        },
        "deposit": {
          "enabled": true
        }
      },
      "logo": {
        "width": 400,
        "height": 400,
        "href": "https://assets.kraken.com/marketing/web/icons-uni-webp/s_eth.webp",
        "type": "image/webp"
      },
      "decimals": {
        "funding": 10,
        "swap": 10
      },
      "listing_date": "2015-08-07",
      "price": "1659.86",
      "market_cap": "200269280850",
      "market_cap_rank": 2,
      "trending_rank": 55,
      "volume": {
        "last_24h": "27036726996"
      },
      "price_change_percent": {
        "last_1h": "-0.5344",
        "last_24h": "-4.915288",
        "last_7d": "-17.382324",
        "last_30d": "-31.162256",
        "last_1y": "-36.021206"
      },
      "ath": {
        "value": "4946.05",
        "timestamp": "2025-08-24T19:21:03Z"
      }
    },
    {
      "symbol": "USD",
      "type": "fiat",
      "name": "US Dollar",
      "status": {
        "swap_trading": {
          "enabled": true,
          "disabled_against": [
            {
              "symbol": "AED",
              "type": "fiat",
              "name": "UAE Dirham"
            },
            {
              "symbol": "USDT",
              "type": "stablecoin",
              "name": "Tether USD"
            }
          ]
        },
        "withdraw": {
          "enabled": true
        },
        "deposit": {
          "enabled": true
        }
      },
      "logo": {
        "width": 400,
        "height": 400,
        "href": "https://assets.kraken.com/marketing/web/icons-uni-webp/s_usd.webp",
        "type": "image/webp"
      },
      "decimals": {
        "funding": 2,
        "swap": 4
      },
      "listing_date": "2013-10-06"
    },
    {
      "symbol": "TSLAx",
      "type": "xstock",
      "name": "Tesla, Inc.",
      "status": {
        "swap_trading": {
          "enabled": true,
          "disabled_against": []
        },
        "withdraw": {
          "enabled": true
        },
        "deposit": {
          "enabled": true
        }
      },
      "logo": {
        "width": 400,
        "height": 400,
        "href": "https://assets.kraken.com/marketing/web/icons-uni-webp/s_tslax.webp",
        "type": "image/webp"
      },
      "decimals": {
        "funding": 8,
        "swap": 8
      },
      "listing_date": "2025-06-30",
      "price": "248.50",
      "market_cap": "799000000000",
      "market_cap_rank": 12,
      "trending_rank": 8,
      "volume": {
        "last_24h": "1203456789"
      },
      "price_change_percent": {
        "last_1h": "0.15",
        "last_24h": "-1.02",
        "last_7d": "3.44",
        "last_30d": "-2.10",
        "last_1y": "18.73"
      },
      "ath": {
        "value": "488.54",
        "timestamp": "2025-01-31T20:00:00Z"
      }
    }
  ],
  "quote_symbol": "USD",
  "quote_type": "fiat",
  "page_size": 20,
  "sort": "market_cap_rank",
  "sort_direction": "asc",
  "next_page_token": "MjoyRHuBXSgoe0mDHt-iFALROW46EGdvk_trgja31Vwr7H4"
}

GET

users

{user_id}

assets

curl

curl -X GET "https://api.services.payward.com/v1/users/AA07%20N84G%20DLNK%20DA3I/assets" \
  -H "API-Key: $PWS_API_KEY" \
  -H "API-Nonce: $PWS_API_NONCE" \
  -H "API-Sign: $PWS_API_SIGN"

import requests

url = "https://api.services.payward.com/v1/users/{user_id}/assets"

headers = {
    "API-Key": "<api-key>",
    "API-Nonce": "<api-key>",
    "API-Sign": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'API-Key': '<api-key>', 'API-Nonce': '<api-key>', 'API-Sign': '<api-key>'}
};

fetch('https://api.services.payward.com/v1/users/{user_id}/assets', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.services.payward.com/v1/users/{user_id}/assets",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "API-Key: <api-key>",
    "API-Nonce: <api-key>",
    "API-Sign: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.services.payward.com/v1/users/{user_id}/assets"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("API-Key", "<api-key>")
	req.Header.Add("API-Nonce", "<api-key>")
	req.Header.Add("API-Sign", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.services.payward.com/v1/users/{user_id}/assets")
  .header("API-Key", "<api-key>")
  .header("API-Nonce", "<api-key>")
  .header("API-Sign", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.services.payward.com/v1/users/{user_id}/assets")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["API-Key"] = '<api-key>'
request["API-Nonce"] = '<api-key>'
request["API-Sign"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "symbol": "BTC",
      "type": "crypto",
      "name": "Bitcoin",
      "status": {
        "swap_trading": {
          "enabled": true,
          "disabled_against": [
            {
              "symbol": "USDT",
              "type": "stablecoin",
              "name": "Tether USD"
            },
            {
              "symbol": "SOL",
              "type": "crypto",
              "name": "Solana"
            }
          ]
        },
        "withdraw": {
          "enabled": true
        },
        "deposit": {
          "enabled": true
        }
      },
      "logo": {
        "width": 400,
        "height": 400,
        "href": "https://assets.kraken.com/marketing/web/icons-uni-webp/s_btc.webp",
        "type": "image/webp"
      },
      "decimals": {
        "funding": 8,
        "swap": 10
      },
      "listing_date": "2013-10-06",
      "price": "62081",
      "market_cap": "1244183483835",
      "market_cap_rank": 1,
      "trending_rank": 66,
      "volume": {
        "last_24h": "53096507160"
      },
      "supply": {
        "circulating": "20038918",
        "total": "20038918",
        "max": "21000000",
        "in_quote": {
          "circulating": "1244036068358",
          "total": "1244036068358",
          "max": "1303701000000"
        }
      },
      "price_change_percent": {
        "last_1h": "-0.312449",
        "last_24h": "-0.584983",
        "last_7d": "-15.616145",
        "last_30d": "-24.558477",
        "last_1y": "-40.690849"
      },
      "ath": {
        "value": "126080",
        "timestamp": "2025-10-06T18:57:42Z"
      }
    },
    {
      "symbol": "ETH",
      "type": "crypto",
      "name": "Ethereum",
      "status": {
        "swap_trading": {
          "enabled": true,
          "disabled_against": [
            {
              "symbol": "USDT",
              "type": "stablecoin",
              "name": "Tether USD"
            },
            {
              "symbol": "SOL",
              "type": "crypto",
              "name": "Solana"
            }
          ]
        },
        "withdraw": {
          "enabled": true
        },
        "deposit": {
          "enabled": true
        }
      },
      "logo": {
        "width": 400,
        "height": 400,
        "href": "https://assets.kraken.com/marketing/web/icons-uni-webp/s_eth.webp",
        "type": "image/webp"
      },
      "decimals": {
        "funding": 10,
        "swap": 10
      },
      "listing_date": "2015-08-07",
      "price": "1659.86",
      "market_cap": "200269280850",
      "market_cap_rank": 2,
      "trending_rank": 55,
      "volume": {
        "last_24h": "27036726996"
      },
      "price_change_percent": {
        "last_1h": "-0.5344",
        "last_24h": "-4.915288",
        "last_7d": "-17.382324",
        "last_30d": "-31.162256",
        "last_1y": "-36.021206"
      },
      "ath": {
        "value": "4946.05",
        "timestamp": "2025-08-24T19:21:03Z"
      }
    },
    {
      "symbol": "USD",
      "type": "fiat",
      "name": "US Dollar",
      "status": {
        "swap_trading": {
          "enabled": true,
          "disabled_against": [
            {
              "symbol": "AED",
              "type": "fiat",
              "name": "UAE Dirham"
            },
            {
              "symbol": "USDT",
              "type": "stablecoin",
              "name": "Tether USD"
            }
          ]
        },
        "withdraw": {
          "enabled": true
        },
        "deposit": {
          "enabled": true
        }
      },
      "logo": {
        "width": 400,
        "height": 400,
        "href": "https://assets.kraken.com/marketing/web/icons-uni-webp/s_usd.webp",
        "type": "image/webp"
      },
      "decimals": {
        "funding": 2,
        "swap": 4
      },
      "listing_date": "2013-10-06"
    },
    {
      "symbol": "TSLAx",
      "type": "xstock",
      "name": "Tesla, Inc.",
      "status": {
        "swap_trading": {
          "enabled": true,
          "disabled_against": []
        },
        "withdraw": {
          "enabled": true
        },
        "deposit": {
          "enabled": true
        }
      },
      "logo": {
        "width": 400,
        "height": 400,
        "href": "https://assets.kraken.com/marketing/web/icons-uni-webp/s_tslax.webp",
        "type": "image/webp"
      },
      "decimals": {
        "funding": 8,
        "swap": 8
      },
      "listing_date": "2025-06-30",
      "price": "248.50",
      "market_cap": "799000000000",
      "market_cap_rank": 12,
      "trending_rank": 8,
      "volume": {
        "last_24h": "1203456789"
      },
      "price_change_percent": {
        "last_1h": "0.15",
        "last_24h": "-1.02",
        "last_7d": "3.44",
        "last_30d": "-2.10",
        "last_1y": "18.73"
      },
      "ath": {
        "value": "488.54",
        "timestamp": "2025-01-31T20:00:00Z"
      }
    }
  ],
  "quote_symbol": "USD",
  "quote_type": "fiat",
  "page_size": 20,
  "sort": "market_cap_rank",
  "sort_direction": "asc",
  "next_page_token": "MjoyRHuBXSgoe0mDHt-iFALROW46EGdvk_trgja31Vwr7H4"
}

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.

Path Parameters

user_id

string

required

User Iiban

Example:

"AA07 N84G DLNK DA3I"

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 <= 25

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.

Required string length: 3 - 16

Example:

"USD"

quote_type

enum<string>

default:fiat

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

Available options:

fiat

Response

data

object[]

required

The list of matching assets.

Show child attributes

quote_symbol

string

required

Quote asset symbol the prices are denominated in (resolved, defaults to USD).

Example:

"USD"

quote_type

enum<string>

required

Classification of the quote asset (resolved, defaults to fiat).

Available options:

fiat

page_size

integer<int32>

required

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

sort

enum<string>

required

Field the results were sorted by (resolved, defaults to market_cap_rank).

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>

required

Direction the results were sorted in (resolved, defaults to asc).

Available options:

asc,

desc

type

enum<string>[]

Asset classifications the listing was filtered to. Empty when no type filter was applied.

Available options:

fiat,

crypto,

stablecoin,

xstock

swap_trading

boolean

Swap-trading filter that was applied, echoed back. Absent when not filtered.

withdraw

boolean

Withdrawal filter that was applied, echoed back. Absent when not filtered.

deposit

boolean

Deposit filter that was applied, echoed back. Absent when not filtered.

next_page_token

string

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

Required string length: 1 - 256

List Assets Get Asset

⌘I