📡API Endpoints

API Status

This endpoint retrieves the API endpoint status.

API Status

get

Header parameters

x-api-keystringRequired

API key needed to access the endpoint

Example: your-api-key

Responses

200

Successful response

application/json

msgstringOptionalExample: Welcome to Chainlyze API V2

get

/p/ping

HTTPcURLJavaScriptPython

GET /v2/p/ping HTTP/1.1
Host: api.chainlyze.ceylabs.io
x-api-key: your-api-key
Accept: */*

200

Successful response

{
  "msg": "Welcome to Chainlyze API V2"
}

---

Supported Chains

This endpoint retrieves the list of supported crypto networks.

List chains

get

Header parameters

x-api-keystringRequired

API key needed to access the endpoint

Example: your-api-key

Responses

200

Successful response with list of chains

application/json

idstringOptionalExample: 30000000-0000-0000-0000-000000000001

namestringOptionalExample: Ethereum

short_namestringOptionalExample: ETH

native_tokenstringOptionalExample: ethereum

evm_chain_idintegerOptionalExample: 1

is_testnetbooleanOptionalExample: false

is_supportedbooleanOptionalExample: true

coingecko_idstringOptionalExample: ethereum

explorerstringOptionalExample: https://etherscan.io

get

/p/chain/list

HTTPcURLJavaScriptPython

GET /v2/p/chain/list HTTP/1.1
Host: api.chainlyze.ceylabs.io
x-api-key: your-api-key
Accept: */*

200

Successful response with list of chains

[
  {
    "id": "30000000-0000-0000-0000-000000000001",
    "name": "Ethereum",
    "short_name": "ETH",
    "native_token": "ethereum",
    "evm_chain_id": 1,
    "is_testnet": false,
    "is_supported": true,
    "coingecko_id": "ethereum",
    "explorer": "https://etherscan.io"
  }
]

---

Token Balances

This endpoint retrieves the wallet token balances

Get wallet balances

get

Query parameters

addressstringRequired

The wallet address to retrieve data for.

Example: 0x1234567890abcdef1234567890abcdef12345678

page[size]integerOptional

The number of results to return per page.

Example: 50

page[index]integerOptional

The page number to retrieve. Starts from 0.

Example: 0

Header parameters

x-api-keystringRequired

API key needed to access the endpoint

Example: your-api-key

Responses

200

Successful response with wallet balances

application/json

namestringOptionalExample: Chainlink

symbolstringOptionalExample: LINK

balancestringOptionalExample: 10.00000000

pricenumber · floatOptionalExample: 7.5

iconstringOptionalExample: https://cdn.chainlyze.io/logos/chainlink-link-logo.png

chain_idstringOptionalExample: ethereum

get

/p/balance/token/list

HTTPcURLJavaScriptPython

GET /v2/p/balance/token/list?address=0x1234567890abcdef1234567890abcdef12345678 HTTP/1.1
Host: api.chainlyze.ceylabs.io
x-api-key: your-api-key
Accept: */*

200

Successful response with wallet balances

[
  {
    "name": "Chainlink",
    "symbol": "LINK",
    "balance": "10.00000000",
    "price": 7.5,
    "icon": "https://cdn.chainlyze.io/logos/chainlink-link-logo.png",
    "chain_id": "ethereum",
    "changes": {
      "absolute": 0.5,
      "percent": 7.15
    }
  }
]

---

DeFi Portfolio Positions

This endpoint retrieves the DeFi position of a specific wallet

Get position balances

get

Query parameters

addressstringRequired

The wallet address to retrieve data for.

Example: 0x1234567890abcdef1234567890abcdef12345678

page[size]integerOptional

The number of results to return per page.

Example: 50

page[index]integerOptional

The page number to retrieve. Starts from 0.

Example: 0

Header parameters

x-api-keystringRequired

API key needed to access the endpoint

Example: your-api-key

Responses

200

Successful response with position balances

application/json

protocolstringOptionalExample: Uniswap V3

namestringOptionalExample: Uniswap V3 ETH/WETH Pool

position_typestringOptionalExample: deposit

amountstringOptionalExample: 0.12345

pricenumber · floatOptionalExample: 3355.123

iconstringOptionalExample: https://cdn.chainlyze.io/0x1234567890abcdef1234567890abcdef12345678.png

chain_idstringOptionalExample: ethereum

get

/p/balance/defi-position/list

HTTPcURLJavaScriptPython

GET /v2/p/balance/defi-position/list?address=0x1234567890abcdef1234567890abcdef12345678 HTTP/1.1
Host: api.chainlyze.ceylabs.io
x-api-key: your-api-key
Accept: */*

200

Successful response with position balances

[
  {
    "protocol": "Uniswap V3",
    "name": "Uniswap V3 ETH/WETH Pool",
    "position_type": "deposit",
    "amount": "0.12345",
    "price": 3355.123,
    "icon": "https://cdn.chainlyze.io/0x1234567890abcdef1234567890abcdef12345678.png",
    "chain_id": "ethereum"
  }
]

---

Wallet Transactions

This endpoints retrieves the transaction history of a specific wallet

List transactions

get

Query parameters

addressstringRequired

The wallet address to retrieve data for.

Example: 0x1234567890abcdef1234567890abcdef12345678

cursor[limit]integerOptional

The maximum number of results to return in the response.

Example: 10

cursor[hash]stringOptional

The cursor hash to retrieve the next page of results.

Example: 2abc3def4ghi5jkl6mno7pqr8stu9vwx0yzab

Header parameters

x-api-keystringRequired

API key needed to access the endpoint

Example: your-api-key

Responses

200

Successful response with transaction data

application/json

get

/p/transaction/list

HTTPcURLJavaScriptPython

GET /v2/p/transaction/list?address=0x1234567890abcdef1234567890abcdef12345678 HTTP/1.1
Host: api.chainlyze.ceylabs.io
x-api-key: your-api-key
Accept: */*

200

Successful response with transaction data

{
  "cursor": {
    "hash": "0xb1c2d3e4f5678901abcdef2345678901abcdef2345678901abcdef2345678901b",
    "limit": 10
  },
  "transactions": [
    {
      "timestamp": "2024-07-31T13:01:27Z",
      "txId": "0x1a2b3c4d5e6f7890abcdef1234567890abcdef1234567890abcdef1234567890a",
      "chain": "ethereum",
      "method": "receive",
      "trash": false,
      "from": "0x1234567890abcdef1234567890abcdef12345678",
      "to": "0xabcdef1234567890abcdef1234567890abcdef12",
      "transfers": [
        {
          "quantity": "1000000.00000000",
          "direction": "in",
          "symbol": "USDT",
          "price": 1,
          "type": "ERC20",
          "contract_address": "0xabcdef1234567890abcdef1234567890abcdef12"
        }
      ]
    }
  ]
}