Ctrl+K

Update an existing asset with vendor mappings

put/api/assetpricing/v1/internal/assets

Updates an existing asset record and its vendor asset mappings. The asset is identified by its symbol. If the asset does not exist, a 404 Not Found error will be returned. Existing vendor mappings will be replaced with the new mappings provided in the request.

Request Body

symbol string required
The symbol of the asset
Min length: >= 1 characters
Example: BTC
display_name string required
Human readable display name for the asset
Min length: >= 1 characters
Example: Bitcoin
type string required
The type of the asset
Allowed values: FIAT COIN TOKEN NFT
Example: COIN
contract_address string
The smart contract address of the asset if it is a token
Example: 1.0392900530792776e+47
metadata dictionary<string, object>
Additional metadata for the asset
Example: {"decimals":8,"network":"mainnet"}
object
Additional metadata for the asset
Example: {"decimals":8,"network":"mainnet"}
entity_status string required
The entity status indicating if the asset is active or inactive
Allowed values: ACTIVE INACTIVE
Example: ACTIVE
symbol_mappings dictionary<string, array>
Per-vendor list of their asset IDs/symbols matching this BitGo symbol
Example: {"lukka":["BTC","BITCOIN"],"kaiko":["btc"]}
array[string]
Per-vendor list of their asset IDs/symbols matching this BitGo symbol
Example: {"lukka":["BTC","BITCOIN"],"kaiko":["btc"]}

200 Response

id string required
The unique identifier of the asset
Example: 550e8400-e29b-41d4-a716-446655440000
symbol string required
The symbol of the asset
Example: BTC
display_name string required
Human readable display name for the asset
Example: Bitcoin
type string required
The type of the asset
Allowed values: FIAT COIN TOKEN NFT
Example: COIN
contract_address string
The smart contract address of the asset if it is a token
Example: 1.0392900530792776e+47
metadata dictionary<string, object>
Additional metadata for the asset
object
Additional metadata for the asset
entity_status string required
The entity status indicating if the asset is active or inactive
Allowed values: ACTIVE INACTIVE
Example: ACTIVE
created_at string required
When the asset was created
Example: 2024-01-15T10:30:00.000Z
modified_at string required
When the asset was last modified
Example: 2024-01-15T10:30:00.000Z
symbol_mappings dictionary<string, array>
Per-vendor list of their asset IDs/symbols matching this BitGo symbol
Example: {"lukka":["BTC","BITCOIN"],"kaiko":["btc"]}
array[string]
Per-vendor list of their asset IDs/symbols matching this BitGo symbol
Example: {"lukka":["BTC","BITCOIN"],"kaiko":["btc"]}

400 Response

string

404 Response

string

409 Response

string