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 Orders API

The orders API from Immutable — 14 operation(s) for orders.

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

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

This API exposes 19 operations across 14 paths, and defines 62 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.

19 operations 14 paths 62 schemas 12 GET7 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 Orders 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 19

Across 14 paths, the API surfaces 19 operations — 12 GET, 7 POST. Each is listed below with its method, path, parameters, and response codes.

Orders 19
POST
/v1/chains/{chain_name}/orders/cancel
Cancel one or more orders
CancelOrders 1 param body → 200400401404429500501
GET
/v1/chains/{chain_name}/orders/listings
List all listings
ListListings 13 params → 200400404500
POST
/v1/chains/{chain_name}/orders/listings
Create a listing
CreateListing 1 param body → 201400404500503504
GET
/v1/chains/{chain_name}/orders/bids
List all bids
ListBids 12 params → 200400404500
POST
/v1/chains/{chain_name}/orders/bids
Create a bid
CreateBid 1 param body → 201400404500501503504
GET
/v1/chains/{chain_name}/orders/collection-bids
List all collection bids
ListCollectionBids 10 params → 200400404500
POST
/v1/chains/{chain_name}/orders/collection-bids
Create a collection bid
CreateCollectionBid 1 param body → 201400404500501503504
GET
/v1/chains/{chain_name}/orders/trait-bids
List all trait bids
ListTraitBids 10 params → 200400404500
POST
/v1/chains/{chain_name}/orders/trait-bids
Create a trait bid
CreateTraitBid 1 param body → 201400404500501503504
GET
/v1/chains/{chain_name}/orders/metadata-bids
List all metadata bids
ListMetadataBids 10 params → 200400404500
POST
/v1/chains/{chain_name}/orders/metadata-bids
Create a metadata bid
CreateMetadataBid 1 param body → 201400404500501503504
GET
/v1/chains/{chain_name}/orders/trait-bids/{trait_bid_id}
Get a single trait bid by ID
GetTraitBid 2 params → 200400404500
GET
/v1/chains/{chain_name}/orders/metadata-bids/{metadata_bid_id}
Get a single metadata bid by ID
GetMetadataBid 2 params → 200400404500
GET
/v1/chains/{chain_name}/orders/listings/{listing_id}
Get a single listing by ID
GetListing 2 params → 200400404500
GET
/v1/chains/{chain_name}/orders/bids/{bid_id}
Get a single bid by ID
GetBid 2 params → 200400404500
GET
/v1/chains/{chain_name}/orders/collection-bids/{collection_bid_id}
Get a single collection bid by ID
GetCollectionBid 2 params → 200400404500
POST
/v1/chains/{chain_name}/orders/fulfillment-data
Retrieve fulfillment data for orders
fulfillment_data 1 param body → 200400404500503504
GET
/v1/chains/{chain_name}/trades
List all trades
ListTrades 8 params → 200400404500
GET
/v1/chains/{chain_name}/trades/{trade_id}
Get a single trade by ID
GetTrade 2 params → 200400404500

Schemas 62

The contract defines 62 schemas that model the data the API accepts and returns. The most detailed are Order (20 properties), Trade (13 properties), CreateMetadataBidRequestBody (12 properties), CreateTraitBidRequestBody (11 properties). Each schema is shown below with its type and property counts.

CreateTraitBidRequestBody
object
11 properties 11 required
ActiveOrderStatus
object
1 property 1 required
APIError504
FulfillableOrder
object
3 properties 2 required
Trade
object
13 properties 13 required
MetadataFieldFilter
object
A field-level filter used to match NFTs for a metadata bid. The fieldname is either a top-level metadata field (name, image, description, animationurl, externa…
2 properties 2 required
CancelOrdersResult
object
1 property 1 required
Order
object
20 properties 17 required
APIError501
APIError401
ListingResult
object
1 property 1 required
OrderStatus
The Order status
MetadataBidResult
object
1 property 1 required
FailedOrderCancellation
object
2 properties 2 required
ListListingsResult
object
2 properties 2 required
TraitBidResult
object
1 property 1 required
AssetCollectionItem
CancelOrdersRequestBody
object
3 properties 3 required
ListTradeResult
object
2 properties 2 required
ERC1155CollectionItem
object
3 properties 3 required
ERC721CollectionItem
object
3 properties 3 required
Fee
object
3 properties 3 required
ERC20Item
object
3 properties 3 required
APIError400
OrderStatusName
string
The Order status
FillStatus
object
The ratio of the order that has been filled, an order that has been fully filled will have the same numerator and denominator values.
2 properties 2 required
APIError404
ChainName
string
The name of chain
ListCollectionBidsResult
object
2 properties 2 required
Chain
object
The chain details
2 properties 2 required
CreateMetadataBidRequestBody
object
Request body for creating a metadata bid. Exactly one of metadataid or metadatacriteria must be provided.
12 properties 10 required
FilledOrderStatus
object
1 property 1 required
ListTraitBidsResult
object
2 properties 2 required
Page
object
Pagination properties
2 properties 2 required
TradeResult
object
1 property 1 required
BasicAPIError
object
3 properties 3 required
ListBidsResult
object
2 properties 2 required
Item
ERC721Item
object
3 properties 3 required
APIError429
InactiveOrderStatus
object
3 properties 3 required
APIError500
CancelledOrderStatus
object
3 properties 3 required
UnfulfillableOrder
object
3 properties 2 required
PendingOrderStatus
object
3 properties 3 required
ExpiredOrderStatus
object
1 property 1 required
APIError503
PageCursor
string
Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
CancelOrdersResultData
object
3 properties 3 required
CollectionBidResult
object
1 property 1 required
ProtocolData
object
5 properties 5 required
NativeItem
object
2 properties 2 required
TradeBlockchainMetadata
objectnull
The metadata related to the transaction in which the activity occurred
4 properties 4 required
PageSize
integer
Maximum number of items to return
ERC1155Item
object
4 properties 4 required
FulfillmentDataRequest
object
4 properties 3 required
ListMetadataBidsResult
object
2 properties 2 required
BidResult
object
1 property 1 required
CreateListingRequestBody
object
10 properties 10 required
CreateCollectionBidRequestBody
object
10 properties 10 required
TraitFilter
object
A trait filter used to match NFTs by metadata attribute
2 properties 2 required
CreateBidRequestBody
object
10 properties 10 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

immutable-orders-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 API
Immutable Metadata Search API
Immutable nft owners API
Immutable Passport API
Immutable passport profile API
Where this information came from

This is an independent, third-party profile of Immutable Orders 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.