Skip to main content
GET
/
v1
/
ledger
/
{ledger_key}
/
asset
List all Assets
curl --request GET \
  --url https://api.sandbox.nxos.io/v1/ledger/{ledger_key}/asset \
  --header 'Authorization: <authorization>'
[
  {
    "asset_code": "<string>",
    "name": "<string>",
    "scale": 1,
    "symbol": "<string>",
    "metadata": {}
  }
]

Headers

​
Authorization
string
required

The Basic Authentication header. Format: "Basic {base64(orgID:apiKey)}"

Path Parameters

​
ledger_key
string
required

The key of the ledger. Examples:

  • "123e4567-e89b-12d3-a456-426614174000"
  • "id:123e4567-e89b-12d3-a456-426614174000"
  • "ref:ledger:customer_a"

Query Parameters

​
cursor
string

The cursor for the next set of results. This is an opaque string representing the starting point for the next page. For the first request, this should be omitted or set to null.

​
limit
integer<int32>
default:25

The number of items to be returned per page. Determines the page size for the paginated results. Default value: 25 Maximum value: 100 (to prevent excessive load on the server)

Response

200 - application/json

The request has succeeded.

​
asset_code
string
required

The reference of the asset

Minimum string length: 1
​
name
string
required

The name of the asset

​
scale
integer<int32>
required

The scale of the asset. Defines the power of 10 to use for the asset. For example, a scale of 2 would mean 100 is 100/(10^2) = 1.00 units of the asset

Required range: x >= 0
​
symbol
string

The symbol of the asset

​
metadata
object

Additional, optional, metadata for the asset