GET
/
v1
/
{chainName}
/
address
/
{walletAddress}
/
collection
/
{collectionContract}
import { GoldRushClient } from "@covalenthq/client-sdk";

const ApiServices = async () => {
    const client = new GoldRushClient("YOUR_API_KEY");
    const resp = await client.NftService.checkOwnershipInNft({chainName: "chainName", walletAddress: "walletAddress"});
    console.log(resp.data);
};

ApiServices();
{
  "updated_at": "2023-11-07T05:31:56Z",
  "address": "<string>",
  "collection": "<string>",
  "is_spam": true,
  "items": [
    {
      "contract_name": "<string>",
      "contract_ticker_symbol": "<string>",
      "contract_address": "<string>",
      "token_id": "<string>",
      "supports_erc": [
        "<string>"
      ],
      "last_transfered_at": "2023-11-07T05:31:56Z",
      "balance": "<string>",
      "balance_24h": "<string>",
      "type": "<string>",
      "nft_data": {
        "token_id": "<string>",
        "token_url": "<string>",
        "original_owner": "<string>",
        "current_owner": "<string>",
        "external_data": {
          "name": "<string>",
          "description": "<string>",
          "asset_url": "<string>",
          "asset_file_extension": "<string>",
          "asset_mime_type": "<string>",
          "asset_size_bytes": "<string>",
          "image": "<string>",
          "image_256": "<string>",
          "image_512": "<string>",
          "image_1024": "<string>",
          "animation_url": "<string>",
          "external_url": "<string>",
          "attributes": [
            {
              "trait_type": "<string>",
              "value": "<string>"
            }
          ],
          "thumbnails": {
            "image_256": "<string>",
            "image_512": "<string>",
            "image_1024": "<string>",
            "image_opengraph_url": "<string>",
            "thumbhash": "<string>"
          },
          "image_preview": "<string>",
          "asset_properties": {
            "asset_width": 123,
            "asset_height": 123,
            "dominant_color": "<string>"
          }
        },
        "asset_cached": true,
        "image_cached": true
      }
    }
  ]
}

Credit Cost

1 per call

Processing

Batch

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form: Bearer <token>, where <token> is your GoldRush API Key.

Path Parameters

​
chainName
string
required

The chain name eg: eth-mainnet.

​
walletAddress
string
required

The requested address. Passing in an ENS, RNS, Lens Handle, or an Unstoppable Domain resolves automatically.

​
collectionContract
string
required

The requested collection address.

Query Parameters

​
traits-filter
string

Filters NFTs based on a specific trait. If this filter is used, the API will return all NFTs with the specified trait. Must be used with "values-filter", is case-sensitive, and requires proper URL encoding.

​
values-filter
string

Filters NFTs based on a specific trait value. If this filter is used, the API will return all NFTs with the specified trait value. Must be used with "traits-filter", is case-sensitive, and requires proper URL encoding.

Response

200 - application/json
Successful response
​
updated_at
string

The timestamp when the response was generated. Useful to show data staleness to users.

​
address
string

The requested address.

​
collection
string

The requested collection.

​
is_spam
boolean

Denotes whether the token is suspected spam. Supported on all Foundational Chains.

​
items
object[]

List of response items.