Change Updates

Do not miss any API Documentation changes, ever again

Subscribe to the API Documentation changelog to be up to date on recent changes.

RSS
API Documentation

Changelog

Last update:
Compare

It is now mandatory to specify the source of orders when request signing.

2 structure changes including:
2 Modifications
Modified 2
POST /open/v1/{network_id}/offers/sign
  • Body
  • application/json content type Modified
    • source property Added
POST /open/v1/{network_id}/orders/sign
  • Body
  • application/json content type Modified
    • source property Added

Changed data type from object to array.

1 structure change including:
1 Modification
Modified 1 Breaking
POST /open/v1/{network_id}/orders/sign
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • Full types went from object to array[object]
          Breaking
      • total property Added
2 structure changes including:
1 Addition
1 Modification
Modified 1
GET /open/v1/{network_id}/orders/{order_hash}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
Added 1
GET /open/v1/{network_id}/market_statistics

Only one offer can be cancelled at a time.

1 structure change including:
1 Modification
Modified 1 Breaking
POST /open/v1/{network_id}/offers/cancel
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • Full types went from array[object] to object
          Breaking
1 structure change including:
1 Addition
Added 1
POST /open/v1/{network_id}/contracts/{contract}/tokens/{token_id}/refresh
1 structure change including:
1 Modification
Modified 1
GET /open/v1/{network_id}/orders
  • Query
  • currency query parameter Added
2 structure changes including:
2 Modifications
Modified 2 Breaking
POST /open/v1/{network_id}/offers/cancel
  • Body
  • application/json content type Modified
    • order_hashes property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • signature, order_hash, offerer properties Added
POST /open/v1/{network_id}/orders/cancel
  • Body
  • application/json content type Modified
    • order_hashes property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • signature, order_hash, offerer properties Added

boolean is not officially supported for GET, so it's changed to integer, 0 for false and 1 for true.

2 structure changes including:
2 Modifications
Modified 2 Breaking
GET /open/v1/{network_id}/orders
  • Query
  • only_dew query parameter Modified
    • Full types went from boolean to integer
      Breaking
POST /open/v1/{network_id}/market_activities/query
  • Body
  • application/json content type Modified
    • types property Modified
      • Full types went from array[integer] | null to array[integer]
        Breaking

We are going to release the bidding feature and related APIs endpoints (offers).

The request format is pretty much the same with orders API, but some parameters have different value requirements.

Cancelling offers doesn't require any on-chain transaction.

5 structure changes including:
5 Additions
Added 5
GET /open/v1/{network_id}/offers
GET /open/v1/{network_id}/offers/{order_hash}
POST /open/v1/{network_id}/offers/add
POST /open/v1/{network_id}/offers/cancel
POST /open/v1/{network_id}/offers/sign

For /market_activities/query and /contracts/query, the request should be POST instead of GET .

4 structure changes including:
2 Breaking changes
2 Additions
2 Removals
Removed 2 Breaking
GET /open/v1/{network_id}/market_activities/query
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /open/v1/{network_id}/wallet/{wallet}/contracts/query
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 2
POST /open/v1/{network_id}/market_activities/query
POST /open/v1/{network_id}/wallet/{wallet}/contracts/query

Use /orders/{order_hash} instead.

1 structure change including:
1 Modification
Modified 1 Breaking
GET /open/v1/{network_id}/orders
  • Query
  • contract query parameter Modified
    • Query parameter is now required
      Breaking
  • order_hash query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking

For a collection object, a market_fees array object will always be returned inside the market_fee_info. Use it together with the royalty_fees when creating orders.

2 structure changes including:
2 Modifications
Modified 2
GET /open/v1/{network_id}/contracts/{address}/detail
  • Response
  • 200 response Modified
    • data property Modified
GET /open/v1/{network_id}/wallet/{wallet}/contracts/query
  • Response
  • 200 response Modified
    • data property Modified
2 structure changes including:
2 Additions
Added 2
GET /open/v1/{network_id}/orders/{order_hash}
GET /open/v1/{network_id}/wallet/{wallet}/contracts/query
2 structure changes including:
2 Modifications
Modified 2
GET /open/v1/{network_id}/orders
  • Response
  • 200 response Modified
    • data property Modified
  • Query
  • only_dew query parameter Added
POST /open/v1/{network_id}/orders/add
  • Response
  • 200 response Modified
    • data property Modified
1 structure change including:
1 Addition
Added 1
GET /open/v1/{network_id}/market_activities/query
3 structure changes including:
3 Modifications
Modified 3
POST /open/v1/{network_id}/orders/add
  • Body
  • content type Modified
    • parameters property Modified
POST /open/v1/{network_id}/orders/cancel
  • Response
  • 200 response Modified
    • data property Modified
POST /open/v1/{network_id}/orders/sign
  • Response
  • 200 response Modified
    • data property Modified
2 structure changes including:
2 Modifications
Modified 2
GET /open/v1/{network_id}/orders
  • Response
  • 200 response Modified
    • data property Modified
POST /open/v1/{network_id}/orders/add
  • Response
  • 200 response Modified
    • data property Modified
1 structure change including:
1 Addition
Added 1
GET /open/v1/{network_id}/wallet/{wallet}/tokens
1 structure change including:
1 Modification
Modified 1
GET /open/v1/{network_id}/contracts/{address}/detail
  • Response
  • 200 response Modified
    • data property Modified
1.0.0
15 structure changes including:
9 Breaking changes
6 Additions
9 Removals
Removed 9 Breaking
GET /api/v0/chains/{chain_id}/contracts/{slug_or_address}
GET /api/v0/chains/{chain_id}/contracts/{slug_or_address}/nfts
GET /api/v0/chains/{chain_id}/contracts/{slug_or_address}/nfts/{token_id}
GET /api/v0/chains/{chain_id}/contracts/{slug_or_address}/nfts/{token_id}/orders
GET /api/v0/chains/{chain_id}/orders/{order_hash}
GET /api/v0/chains/{chain_id}/orders/{order_hash}/signature
GET /api/v0/chains/{chain_id}/wallets/{wallet}/nfts
GET /api/v0/chains/{chain_id}/wallets/{wallet}/nfts/{token_id}
POST /api/v0/chains/{chain_id}/orders
Added 6
GET /open/v1/{network_id}/contracts/{address}/detail
GET /open/v1/{network_id}/contracts/{address}/{token_id}
GET /open/v1/{network_id}/orders
POST /open/v1/{network_id}/orders/add
POST /open/v1/{network_id}/orders/cancel
POST /open/v1/{network_id}/orders/sign