Get wallet NFT positions

curl --request GET \
  --url https://api.zerion.io/v1/wallets/{address}/nft-positions/ \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://api.zerion.io/v1/wallets/{address}/nft-positions/"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://api.zerion.io/v1/wallets/{address}/nft-positions/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.zerion.io/v1/wallets/{address}/nft-positions/"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Basic <encoded-value>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "links": {
    "self": "https://api.zerion.io/v1/wallets/0x42b9df65b219b3dd36ff330a4dd8f327a6ada990/nft-positions/"
  },
  "data": [
    {
      "type": "nft_positions",
      "id": "0x42b9df65b219b3dd36ff330a4dd8f327a6ada990:ethereum:22:0x909899c5dbb5002610dd8543b6f638be56e3b17e:57896044618658097711785492504343953928676686534345912800509039648547174119787",
      "attributes": {
        "changed_at": "2023-02-28T19:24:39Z",
        "amount": "1",
        "price": 0.043615722,
        "value": 123,
        "nft_info": {
          "contract_address": "0x74ee68a33f6c9f113e22b3b77418b75f85d07d22",
          "token_id": "10",
          "name": "#10 De·genesis",
          "interface": "erc1155",
          "flags": {
            "is_spam": true
          },
          "content": {
            "preview": {
              "url": "https://token-icons.s3.amazonaws.com/0x1494ca1f11d487c2bbe4543e90080aeba4ba3c2b.png",
              "content_type": "image/png"
            },
            "detail": {
              "url": "https://token-icons.s3.amazonaws.com/0x1494ca1f11d487c2bbe4543e90080aeba4ba3c2b.png",
              "content_type": "image/png"
            },
            "audio": {
              "url": "https://token-icons.s3.amazonaws.com/0x1494ca1f11d487c2bbe4543e90080aeba4ba3c2b.png",
              "content_type": "image/png"
            },
            "video": {
              "url": "https://token-icons.s3.amazonaws.com/0x1494ca1f11d487c2bbe4543e90080aeba4ba3c2b.png",
              "content_type": "image/png"
            }
          }
        },
        "collection_info": {
          "name": "<string>",
          "description": "<string>",
          "content": {
            "icon": {
              "url": "https://token-icons.s3.amazonaws.com/0x0391d2021f89dc339f60fff84546ea23e337750f.png"
            },
            "banner": {
              "url": "https://token-icons.s3.amazonaws.com/0x1494ca1f11d487c2bbe4543e90080aeba4ba3c2b.png",
              "content_type": "image/png"
            }
          }
        }
      },
      "relationships": {
        "chain": {
          "links": {
            "related": "https://api.zerion.io/v1/chains/polygon"
          },
          "data": {
            "type": "chains",
            "id": "polygon"
          }
        },
        "nft_collection": {
          "data": {
            "type": "nft_collections",
            "id": 14
          }
        },
        "nft": {
          "data": {
            "type": "nfts",
            "id": "<string>"
          }
        }
      },
      "included": [
        {
          "type": "nfts",
          "id": "<string>",
          "attributes": {
            "contract_address": "0x74ee68a33f6c9f113e22b3b77418b75f85d07d22",
            "token_id": "10",
            "interface": "erc1155",
            "metadata": {
              "name": "<string>",
              "description": "<string>",
              "tags": [
                "<string>"
              ],
              "content": {
                "preview": {
                  "url": "https://token-icons.s3.amazonaws.com/0x1494ca1f11d487c2bbe4543e90080aeba4ba3c2b.png",
                  "content_type": "image/png"
                },
                "detail": {
                  "url": "https://token-icons.s3.amazonaws.com/0x1494ca1f11d487c2bbe4543e90080aeba4ba3c2b.png",
                  "content_type": "image/png"
                },
                "audio": {
                  "url": "https://token-icons.s3.amazonaws.com/0x1494ca1f11d487c2bbe4543e90080aeba4ba3c2b.png",
                  "content_type": "image/png"
                },
                "video": {
                  "url": "https://token-icons.s3.amazonaws.com/0x1494ca1f11d487c2bbe4543e90080aeba4ba3c2b.png",
                  "content_type": "image/png"
                }
              },
              "attributes": [
                {
                  "key": "Rarity",
                  "value": "common"
                }
              ]
            },
            "market_data": {
              "prices": {
                "floor": 123
              },
              "last_sale": {
                "price": 31,
                "quantity": {
                  "int": "12345678",
                  "decimals": 5,
                  "float": 123.45678,
                  "numeric": "123.45678"
                }
              }
            },
            "external_links": [
              {
                "url": "https://www.indexcoop.com",
                "type": "website",
                "name": "Website"
              }
            ],
            "flags": {
              "is_spam": true
            }
          },
          "relationships": {
            "chain": {
              "links": {
                "related": "https://api.zerion.io/v1/chains/polygon"
              },
              "data": {
                "type": "chains",
                "id": "polygon"
              }
            },
            "nft_collection": {
              "data": {
                "type": "nft_collections",
                "id": 14
              }
            }
          }
        }
      ]
    }
  ]
}

{
  "links": {
    "self": "https://api.zerion.io/v1/wallets/0x42b9df65b219b3dd36ff330a4dd8f327a6ada990/nft-positions/"
  },
  "data": []
}

{
  "errors": [
    {
      "title": "Parameter is malformed",
      "detail": "Some validation errors will be described here"
    }
  ]
}

{
  "errors": [
    {
      "title": "Unauthorized Error",
      "detail": "The API key is invalid, please, make sure that you are using a valid key"
    }
  ]
}

{
  "errors": [
    {
      "title": "Too many requests",
      "detail": "Your request had been throttled"
    }
  ]
}

wallets

Get wallet NFT positions

This endpoint returns a list of the NFT positions held by a specific wallet.

This endpoint supports testnets. To get data for testnets use X-Env header.

If the wallet address has not been previously added, this endpoint may return a 202 status code. This indicates that the wallet’s positions are not yet available, but will be in the near future. In this case, the client should periodically request this endpoint until a 200 status code is returned.

NOTE: It is important to stop retrying after a reasonable period of time. If a 200 status code is not returned within 2 minutes, it is likely that an unexpected error has occurred and the client should stop polling.

NOTE: This endpoint provides support for filters, sorting, and pagination parameters. Ensure that the length of the request URL falls within a safe range for your platform. Typically, a length of 2000 characters is a safe limit for most combinations of client and server software.

NOTE: Consider all IDs as abstract strings, without making any assumptions about their format or relying on such assumptions. There is a non-zero probability that IDs may change in the future, and this should not result in any breaking changes.

GET

wallets

{address}

nft-positions

Get wallet NFT positions

curl --request GET \
  --url https://api.zerion.io/v1/wallets/{address}/nft-positions/ \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://api.zerion.io/v1/wallets/{address}/nft-positions/"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://api.zerion.io/v1/wallets/{address}/nft-positions/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.zerion.io/v1/wallets/{address}/nft-positions/"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Basic <encoded-value>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "links": {
    "self": "https://api.zerion.io/v1/wallets/0x42b9df65b219b3dd36ff330a4dd8f327a6ada990/nft-positions/"
  },
  "data": [
    {
      "type": "nft_positions",
      "id": "0x42b9df65b219b3dd36ff330a4dd8f327a6ada990:ethereum:22:0x909899c5dbb5002610dd8543b6f638be56e3b17e:57896044618658097711785492504343953928676686534345912800509039648547174119787",
      "attributes": {
        "changed_at": "2023-02-28T19:24:39Z",
        "amount": "1",
        "price": 0.043615722,
        "value": 123,
        "nft_info": {
          "contract_address": "0x74ee68a33f6c9f113e22b3b77418b75f85d07d22",
          "token_id": "10",
          "name": "#10 De·genesis",
          "interface": "erc1155",
          "flags": {
            "is_spam": true
          },
          "content": {
            "preview": {
              "url": "https://token-icons.s3.amazonaws.com/0x1494ca1f11d487c2bbe4543e90080aeba4ba3c2b.png",
              "content_type": "image/png"
            },
            "detail": {
              "url": "https://token-icons.s3.amazonaws.com/0x1494ca1f11d487c2bbe4543e90080aeba4ba3c2b.png",
              "content_type": "image/png"
            },
            "audio": {
              "url": "https://token-icons.s3.amazonaws.com/0x1494ca1f11d487c2bbe4543e90080aeba4ba3c2b.png",
              "content_type": "image/png"
            },
            "video": {
              "url": "https://token-icons.s3.amazonaws.com/0x1494ca1f11d487c2bbe4543e90080aeba4ba3c2b.png",
              "content_type": "image/png"
            }
          }
        },
        "collection_info": {
          "name": "<string>",
          "description": "<string>",
          "content": {
            "icon": {
              "url": "https://token-icons.s3.amazonaws.com/0x0391d2021f89dc339f60fff84546ea23e337750f.png"
            },
            "banner": {
              "url": "https://token-icons.s3.amazonaws.com/0x1494ca1f11d487c2bbe4543e90080aeba4ba3c2b.png",
              "content_type": "image/png"
            }
          }
        }
      },
      "relationships": {
        "chain": {
          "links": {
            "related": "https://api.zerion.io/v1/chains/polygon"
          },
          "data": {
            "type": "chains",
            "id": "polygon"
          }
        },
        "nft_collection": {
          "data": {
            "type": "nft_collections",
            "id": 14
          }
        },
        "nft": {
          "data": {
            "type": "nfts",
            "id": "<string>"
          }
        }
      },
      "included": [
        {
          "type": "nfts",
          "id": "<string>",
          "attributes": {
            "contract_address": "0x74ee68a33f6c9f113e22b3b77418b75f85d07d22",
            "token_id": "10",
            "interface": "erc1155",
            "metadata": {
              "name": "<string>",
              "description": "<string>",
              "tags": [
                "<string>"
              ],
              "content": {
                "preview": {
                  "url": "https://token-icons.s3.amazonaws.com/0x1494ca1f11d487c2bbe4543e90080aeba4ba3c2b.png",
                  "content_type": "image/png"
                },
                "detail": {
                  "url": "https://token-icons.s3.amazonaws.com/0x1494ca1f11d487c2bbe4543e90080aeba4ba3c2b.png",
                  "content_type": "image/png"
                },
                "audio": {
                  "url": "https://token-icons.s3.amazonaws.com/0x1494ca1f11d487c2bbe4543e90080aeba4ba3c2b.png",
                  "content_type": "image/png"
                },
                "video": {
                  "url": "https://token-icons.s3.amazonaws.com/0x1494ca1f11d487c2bbe4543e90080aeba4ba3c2b.png",
                  "content_type": "image/png"
                }
              },
              "attributes": [
                {
                  "key": "Rarity",
                  "value": "common"
                }
              ]
            },
            "market_data": {
              "prices": {
                "floor": 123
              },
              "last_sale": {
                "price": 31,
                "quantity": {
                  "int": "12345678",
                  "decimals": 5,
                  "float": 123.45678,
                  "numeric": "123.45678"
                }
              }
            },
            "external_links": [
              {
                "url": "https://www.indexcoop.com",
                "type": "website",
                "name": "Website"
              }
            ],
            "flags": {
              "is_spam": true
            }
          },
          "relationships": {
            "chain": {
              "links": {
                "related": "https://api.zerion.io/v1/chains/polygon"
              },
              "data": {
                "type": "chains",
                "id": "polygon"
              }
            },
            "nft_collection": {
              "data": {
                "type": "nft_collections",
                "id": 14
              }
            }
          }
        }
      ]
    }
  ]
}

{
  "links": {
    "self": "https://api.zerion.io/v1/wallets/0x42b9df65b219b3dd36ff330a4dd8f327a6ada990/nft-positions/"
  },
  "data": []
}

{
  "errors": [
    {
      "title": "Parameter is malformed",
      "detail": "Some validation errors will be described here"
    }
  ]
}

{
  "errors": [
    {
      "title": "Unauthorized Error",
      "detail": "The API key is invalid, please, make sure that you are using a valid key"
    }
  ]
}

{
  "errors": [
    {
      "title": "Too many requests",
      "detail": "Your request had been throttled"
    }
  ]
}

Authorizations

Authorization

string

header

required

To test endpoints here, paste your API key from the dashboard into the username field and leave the password empty.

Headers

X-Env

enum<string>

Custom header that allows you to get data for testnets.

Available options:

testnet

Path Parameters

address

required

The web3 wallet address. Must be a valid EVM or Solana address. Returns 400 if the address is not tracked by Zerion. A wallet address, which can be either an EVM or Solana address

Pattern: ^0x[a-fA-F0-9]{40}$

Example:

"0x42b9df65b219b3dd36ff330a4dd8f327a6ada990"

Query Parameters

filter[chain_ids]

string[]

Keep only positions from the specified chains (comma-separated list). Available chains IDs can be found in chains endpoint.

Maximum array length: 25

Example:

["ethereum", "polygon"]

filter[collections_ids]

integer<int64>[]

Keep only positions from collections with specified IDs (comma-separated list). The IDs are returned inside the 'collection' field of each NFT.

sort

enum<string>

The order of NFTs in the result.

Available options:

created_at,

-created_at,

floor_price,

-floor_price

Example:

"-floor_price"

include

enum<string>[]

Array of related resources to be included to the response (comma-separated list). This parameter corresponds to the JSON API schema.

Available options:

nfts,

nft_collections,

wallet_nft_collections

currency

enum<string>

default:usd

Denominated currency value of returned prices

Available options:

eth,

btc,

usd,

eur,

krw,

rub,

gbp,

aud,

cad,

inr,

jpy,

nzd,

try,

zar,

cny,

chf

page

object

Pagination parameters

Show child attributes

Response

Response for requested list of NFT positions.

links

object

required

Show child attributes

data

object[]

required

Show child attributes

Get wallet transactions Get wallet NFT collections

⌘I