Get NFT Collection Cache Status

Use to check the status of an NFT collection cache request.

GET /v1/{chainName}/nft/request/collection_cache/{collectionContract}/status

Try it

cURL

cURL

curl --request GET \
  --url https://api.covalenthq.com/v1/{chainName}/nft/request/collection_cache/{collectionContract}/status/ \
  --header 'Authorization: Bearer <token>'

200

{
  "updated_at": "2023-11-07T05:31:56Z",
  "chain_id": 123,
  "chain_name": "<string>",
  "items": [
    {
      "requested_collection_address": "<string>",
      "requested_collection_name": "<string>",
      "token_total_supply_identified": 123,
      "cached_metadata_count": 123,
      "cached_asset_count": 123,
      "cached_thumbnail_count": 123,
      "last_scraped_at": "2023-11-07T05:31:56Z",
      "requested_collection_queued": true
    }
  ]
}

Credit Cost

0 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.

collectionContract · string · required

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

Response

200 - application/json

Successful response

updated_at · string<date-time>

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

chain_id · integer

The requested chain ID eg: 1.

chain_name · string

The requested chain name eg: eth-mainnet.

items · object[]

List of response items.

Show child attributes

items. requested_collection_address · string

The requested NFT collection contract address.

items. requested_collection_name · string

The requested NFT collection name.

items. token_total_supply_identified · integer<int64>

The number of NFTs identified making up the total supply for the requested collection.

items. cached_metadata_count · integer<int64>

The number of NFTs where the metadata (e.g. name, description, attributes) has been cached for the requested collection.

items. cached_asset_count · integer<int64>

The number of NFTs where the asset (e.g. image, video, audio) has been cached for the requested collection.

items. cached_thumbnail_count · integer<int64>

The number of NFTs where a set of thumbnails (e.g. different image sizes, open graph image, thumbhash) have been created and cached for the requested collection.

items. last_scraped_at · string<date-time>

The timestamp of any last cache event (metadata, asset or thumbnail) done for any NFTs in the requested collection.

items. requested_collection_queued · boolean

Boolean to indicate if the cache request is in the queue or completed (i.e. false).