Skip to main content

API changelog

This page is to provide information on:

Currently, we use resource versioning (URI-based), i.e. /v1/<endpoint>. While we aim to ensure that breaking changes (non-backwards compatible changes) are versioned, there are occasions where it is necessary for us to introduce a breaking change to an existing endpoint. This will be communicated to you in advance, and information about this will also be made available on this page.

Backwards compatible changes (non-breaking):

  • Adding new API resources.
  • Adding new optional request parameters to existing API methods.
  • Adding new properties to existing API responses.
  • Changing the order of properties in existing API responses.
  • Changing the length or format of opaque strings, such as object IDs, error messages, and other human-readable strings. This includes adding or removing fixed prefixes.

Upcoming breaking changes

Anticipated date of changeDescription of change

Changelog

DateNon-breaking changesBreaking changes
5 Dec 2023Orderbook
  • Create a Listing,List all Listings,Get a Listing,Get Order Fulfillment Data- Response body
    • Order object schema now includes a type field; the only value currently supported is LISTING
    • Order object schema now includes an order_hash field representing the on-chain identifier of the order on its corresponding protocol
    • A new item type ERC1155 has been documented in preparation for supporting ERC-1155 contracts
Orderbook

IMX Whitepaper IMX Tokenomics Block Explorer Careers Contact Us