API changelog

This page is to provide information on:

• API changelog
  • Backwards compatible changes (non-breaking):
  • Upcoming breaking changes
  • Changelog

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 change	Description of change

Changelog

Date	Non-breaking changes	Breaking changes
12 Dec 2022		Developer Hub Release of Immutable Developer Hub The Create Project API requires your email to be verified and you are fully onboarded via the Developer Hub Onboarding requires sign-up to Developer Hub to create projects
3 Nov 2022	Exchange on and off-ramp APIs createExchange - create an on-ramp or an off-ramp request getExchange - Get exchange transaction details getExchangeSignableTransfer - get the object for an exchange on or off-ramp transfer request createExchangeTransfer - Initiate the off-ramp request getExchanges - Gets a list of exchanges based on the request NFT primary sale card checkout APIs registerNftPrimarySalesContract - executes NFT primary sales contract registration createNftPrimary - create NFT primary sale transaction getNftPrimaryTransaction - Get NFT primary sale transaction by id getNftPrimaryTransactions - Get a list of NFT primary sale transactions getCurrenciesNFTCheckoutPrimary - Get currencies with limits