API Documentation: Get Listing Asset (Coin/Token)

Overview

This endpoint allow user to view all assets listed on Xellar. These assets can later be selected when adding assets to a portfolio. Asset need to be filtered based on network.

HTTP Method: GET
Endpoint: /api/v1/assets/network/{network}

Request Path Parameters

network (required): available values for network : ethereum, solana, bitcoin, tron

Request Query Parameters

page (optional): The page number to retrieve. Type: number.
limit (optional): The maximum number of results to return. Type: number.
search (optional): Filters assets based on the asset's name. Type: string.

Example Request Query

/api/v1/assets/network/ethereum?page=1&limit=10&search=usd

Request

Request Headers

X-CLIENT-ID: (required): Client ID which was generated when register in Xellar TSS API Service Dashboard.
X-SIGNATURE: (required): Calculated signature, please refer to Authorization section.
X-TIMESTAMP: (required): Request timestamp in RFC3339 format.

Example Request Syntax

curl -X GET -H "Content-Type: application/json" -H "x-client-id: $YOUR_CLIENT_ID" -H "x-client-secret: $YOUR_CLIENT_SECRET" <BASE_URL>/api/v1/assets/network/{network}

Response

The response will include a JSON object with the following properties:

status (number): The HTTP status code of the response (e.g., 200 for success).
message (string): A message providing additional information about the operation.
data (object): An object containing the request information.
data.page (number): Indicate the current page.
data.limit (number): Indicate max data shown.
data.totalResults (number): Indicate total existing data based on query.
data.totalPages (number): Indicate total page.
data.data (array): List of assets.
data.data.id (string): Asset identifier.
data.data.symbol (string): Asset symbol.
data.data.name (string): Asset name.
data.data.network (string): Asset netwwork.
data.data.wrapped (boolean): If true, asset is native-wrapped asset.
data.data.isNative (boolean): If true, asset is native coin on particular network.
data.data.logo (strng): Asset logo.
data.data.contractAddress (strng): Token Contract address, value exist only on non-native asset.
data.data.decimalPlace (strng): Decimal of asset, value exist only on non-native asset.

Example Response

{
    "status": 200,
    "message": "success get asset by network",
    "data": {
        "page": 10,
        "limit": 5,
        "totalResults": 7992,
        "totalPages": 1599,
        "data": [
            {
                "id": "12405-santa-rosa",
                "symbol": "realt-s-12405-santa-rosa-dr-detroit-mi",
                "name": "RealT-12405SantaRosaDr,Detroit,MI48204",
                "network": "ethereum",
                "wrapped": false,
                "isNative": false,
                "logo": "https://raw.githubusercontent.com/Xellar-Protocol/xellar-assets/master/assets/12405-santa-rosa/logo.png",
                "contractAddress": "0x9d918ee39a356be8ef99734599c7e70160db4db6",
                "decimalPlace": 18                
            },
            {
                "id": "12ships",
                "symbol": "tshp",
                "name": "12Ships",
                "network": "ethereum",
                "wrapped": false,
                "isNative": false,
                "logo": "https://raw.githubusercontent.com/Xellar-Protocol/xellar-assets/master/assets/12ships/logo.png",
                "contractAddress": "0x525794473f7ab5715c81d06d10f52d11cc052804",
                "decimalPlace": 18                
            },
            {
                "id": "14066-santa-rosa",
                "symbol": "realt-s-14066-santa-rosa-dr-detroit-mi",
                "name": "RealT-14066SantaRosaDr,Detroit,MI48238",
                "network": "ethereum",
                "wrapped": false,
                "isNative": false,
                "logo": "https://raw.githubusercontent.com/Xellar-Protocol/xellar-assets/master/assets/14066-santa-rosa/logo.png",
                "contractAddress": "0xe887dc4fcb5240c0c080aeab8870421d3ebd0b28",
                "decimalPlace": 18                
            },
            {
                "id": "1617-s-avers",
                "symbol": "realt-s-1617-s.avers-ave-chicago-il",
                "name": "RealT-1617SAversAve,Chicago,IL60623",
                "network": "ethereum",
                "wrapped": false,
                "isNative": false,
                "logo": "https://raw.githubusercontent.com/Xellar-Protocol/xellar-assets/master/assets/1617-s-avers/logo.png",
                "contractAddress": "0xf4657ab08681214bcb1893aa8e9c7613459250ec",
                "decimalPlace": 18                
            },
            {
                "id": "1815-s-avers",
                "symbol": "realt-s-1815-s.avers-ave-chicago-il",
                "name": "RealT-1815SAversAve,Chicago,IL60623",
                "network": "ethereum",
                "wrapped": false,
                "isNative": false,
                "logo": "https://raw.githubusercontent.com/Xellar-Protocol/xellar-assets/master/assets/1815-s-avers/logo.png",
                "contractAddress": "0x8fcb39a25e639c8fbd28e8a018227d6570e02352",
                "decimalPlace": 18                
            }
        ]
    }
}

Callback Add Asset to Portfolio