How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Immutable Metadata API

NFT Metadata Endpoints

Immutable Metadata API is one of 17 APIs that Immutable publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Metadata. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 6 operations across 6 paths, and defines 38 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://api.sandbox.immutable.com.

6 operations 6 paths 38 schemas 4 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.immutable.com
Authentication
HTTP Bearer, HTTP Bearer, API Key, HTTP Bearer
Resource Areas
1

Authentication & Security 4

Immutable Metadata API declares 4 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuthWithClient). It accepts HTTP bearer tokens (JWT) (BearerAuth). An API key is passed in the header as x-immutable-api-key (ImmutableApiKey). It accepts HTTP bearer tokens (JWT) (OktaBearerAuth).

Paths & Operations 6

Across 6 paths, the API surfaces 6 operations — 4 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

metadata 6

NFT Metadata Endpoints

GET
/v1/chains/{chain_name}/collections/{contract_address}/metadata/{metadata_id}
Get metadata by ID
GetMetadata 3 params → 200400404500
GET
/v1/chains/{chain_name}/collections/{contract_address}/metadata
Get a list of metadata from the given contract
ListMetadata 5 params → 200400404500
GET
/v1/chains/{chain_name}/metadata
Get a list of metadata from the given chain
ListMetadataForChain 4 params → 200400404500
POST
/v1/chains/{chain_name}/collections/{contract_address}/metadata/refresh-metadata
Refresh stacked metadata
RefreshMetadataByID 2 params body → 202400401403404429500
POST
/v1/chains/{chain_name}/collections/{contract_address}/nfts/refresh-metadata
Refresh NFT metadata
RefreshNFTMetadataByTokenID 2 params body → 202400401403404429500
GET
/v1/chains/{chain_name}/stacks
List NFT stack bundles by stackid. Response will include Market, Listings & Stack Count information for each stack
ListStacks 2 params → 200400401403404429500

Schemas 38

The contract defines 38 schemas that model the data the API accepts and returns. The most detailed are Stack (13 properties), Metadata (12 properties), NFTMetadataRequest (7 properties), LastTrade (6 properties). Each schema is shown below with its type and property counts.

MarketPriceFees
object
3 properties 3 required
ConvertedPrices
objectnull
A mapping of converted prices for major currencies such as ETH, USD. All converted prices are fee-inclusive.
MarketPriceNativeToken
object
2 properties 2 required
PageCursor
string
Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
RefreshNFTMetadataByTokenIDRequest
object
1 property 1 required
MarketPriceDetails
object
Market Price details
5 properties 5 required
NFTMetadataAttribute
object
3 properties 2 required
Market
object
Market data
3 properties 3 required
Bid
object
6 properties 6 required
MetadataRefreshRateLimitResult
object
4 properties 4 required
APIError403
PageSize
integer
Maximum number of items to return
StackBundle
object
Stack bundle includes stacks, markets and listings
5 properties 5 required
APIError400
MarketPriceERC20Token
object
4 properties 4 required
APIError429
ListMetadataResult
object
2 properties 2 required
LastTrade
objectnull
Most recent trade
6 properties 6 required
Page
object
Pagination properties
2 properties 2 required
APIError404
APIError500
Address
string
An Ethereum address
MarketplaceContractType
string
The contract type for a collection
Chain
object
The chain details
2 properties 2 required
RefreshMetadataByIDRequest
object
Request body for refreshing metadata by id. Total size of this list should not exceed 228 KiB
1 property 1 required
Listing
object
6 properties 6 required
GetMetadataResult
object
Single metadata
1 property 1 required
ChainName
string
The name of chain
RefreshMetadataByTokenID
BasicAPIError
object
3 properties 3 required
Metadata
object
12 properties 12 required
APIError401
RefreshMetadataByID
RefreshableNFTAttributes
7 required
MetadataID
string
Metadata id in UUIDv4 format
Stack
object
Stack
13 properties 13 required
PaymentAmount
string
The token amount value. This value is provided in the smallest unit of the token (e.g. wei for ETH)
NFTMetadataRequest
object
The NFT metadata. Total size of this object should not exceed 16 KiB
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

immutable-metadata-api-openapi.yml Raw ↑

Other APIs Immutable publishes across the network.

Immutable Passport Authentication
Immutable Activities API
Immutable Chains API
Immutable Collections API
Immutable Crafting API
Immutable Data API
Immutable Ingest API
Immutable Metadata Search API
Immutable nft owners API
Immutable Nfts API
Immutable Orders API
Immutable Passport API
Where this information came from

This is an independent, third-party profile of Immutable Metadata API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.