Get asset

GET 
/api/v2/asset/:assetId

Get a single asset using its ID. Use the assets list query to get an asset's ID

Request

Path Parameters

assetId stringrequired

Asset ID to get data for.

Responses

200

A successful response.

application/json

Schema

Schema

asset object

Asset information that is returned.

details object

Definition of the external source for this asset.

builtinAsset object

Vega built-in asset.

maxFaucetAmountMint string

Maximum amount that can be requested by a party through the built-in asset faucet at a time.

decimals uint64

Number of decimal / precision handled by this asset.

erc20 object

Ethereum ERC20 asset.

chainId string

Chain ID the asset originated from.

contractAddress string

Address of the contract for the token, on the ethereum network.

lifetimeLimit string

Lifetime limits deposit per address note: this is a temporary measure that can be changed by governance.

withdrawThreshold string

Maximum you can withdraw instantly. All withdrawals over the threshold will be delayed by the withdrawal delay. There’s no limit on the size of a withdrawal note: this is a temporary measure that can be changed by governance.

name string

Name of the asset (e.g: Great British Pound).

quantum string

Minimum economically meaningful amount in the asset.

symbol string

Symbol of the asset (e.g: GBP).

id string

Internal identifier of the asset.

status - STATUS_UNSPECIFIED: Default value, always invalid - STATUS_PROPOSED: Asset is proposed and under vote - STATUS_REJECTED: Asset has been rejected from governance - STATUS_PENDING_LISTING: Asset is pending listing from the bridge - STATUS_ENABLED: Asset is fully usable in the network (string)

Possible values: [STATUS_UNSPECIFIED, STATUS_PROPOSED, STATUS_REJECTED, STATUS_PENDING_LISTING, STATUS_ENABLED]

Default value: STATUS_UNSPECIFIED

Status of the asset.

Example (from schema)

{
  "asset": {
    "details": {
      "builtinAsset": {
        "maxFaucetAmountMint": "string"
      },
      "decimals": "string",
      "erc20": {
        "chainId": "string",
        "contractAddress": "string",
        "lifetimeLimit": "string",
        "withdrawThreshold": "string"
      },
      "name": "string",
      "quantum": "string",
      "symbol": "string"
    },
    "id": "string",
    "status": "STATUS_UNSPECIFIED"
  }
}

500

An internal server error

application/json

Schema

Schema

code int32
details object[]
Array [
@type string
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:
• If no scheme is provided, https is assumed.
• An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
• Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.
Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.
]
message string

Example (from schema)

{
  "code": 0,
  "details": [
    {
      "@type": "string"
    }
  ],
  "message": "string"
}

default

An unexpected error response.

application/json

Schema

Schema

code int32
details object[]
Array [
@type string
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:
• If no scheme is provided, https is assumed.
• An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
• Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.
Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.
]
message string

Example (from schema)

{
  "code": 0,
  "details": [
    {
      "@type": "string"
    }
  ],
  "message": "string"
}

Loading...