The asset registry.

GET

/v1/assets

const url = 'https://example.com/v1/assets';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/v1/assets \
  --header 'Authorization: Bearer <token>'

Authorizations

bearer

Responses

200

The answer, from one consistent view (REQ-QR-2).

application/json

Array<object>

One asset of the registry (REQ-AS-1).

object

binding

required

book_only, binding or bound (amendment 0011, REQ-AS-7, REQ-AS-8).

string

required

Its symbol.

string

kind

required

fiat, stable, native or other.

string

location

Its location on the settlement layer, once a binding was asked for (REQ-AS-8).

string | null

precision

required

Its one precision (INV-24).

integer format: uint8

<= 255

status

required

active or deprecated.

string

Example^generated

[
  {
    "binding": "example",
    "id": "example",
    "kind": "example",
    "location": "example",
    "precision": 1,
    "status": "example"
  }
]

4XX

Refused, with the named condition. The status is the alternative’s x-http-status.

application/json

One of:

ERR-NotAuthorised

object

description

required

Allowed value: The initiating principal holds no authority that covers this operation, account, asset or bound

error

required

Allowed value: ERR-NotAuthorised

Example

{
  "description": "The initiating principal holds no authority that covers this operation, account, asset or bound",
  "error": "ERR-NotAuthorised"
}

5XX

Refused, with the named condition. The status is the alternative’s x-http-status.

application/json

One of:

ERR-NotAuthorised

object

description

required

Allowed value: The initiating principal holds no authority that covers this operation, account, asset or bound

error

required

Allowed value: ERR-NotAuthorised

Example

{
  "description": "The initiating principal holds no authority that covers this operation, account, asset or bound",
  "error": "ERR-NotAuthorised"
}

Headers

Retry-After

integer

On ERR-DecisionUnavailable (503): seconds to wait before retrying with the same client key (DEC-27 (g)).

The asset registry.

Authorizations

Responses

200

Examplegenerated

4XX

Example

5XX

Example

Headers

Example^generated