Skip to main content
Version: v2

Unity Orderbook Reference

This page guides you through integrating the Orderbook package into your Unity game using the Immutable Unity SDK.

Information includes method descriptions, parameters and return types.
sdk referencesdk reference
đź’ˇWHO IS THIS FOR?
Developers building a game in Unity.

PrepareListing​

Gets required transactions and messages for signing prior to creating a listing.

Method parameters

PrepareListingRequestprepareListingRequestREQUIRED

Request object for preparing a listing containing details about the listing to be created:

See PrepareListingRequest for more information.

Returns

PrepareListing200Response

A response object for the prepare listing endpoint containing properties:

See PrepareListing200Response for more information.

CreateListing​

Creates a listing.

Method parameters

CreateListingRequestcreateListingRequestREQUIRED

Request object for creating a listing containing properties:

See CreateListingRequest for more information.

Returns

CreateListing200Response

A response object for the create listing endpoint containing properties:

See CreateListing200Response for further information.

FulfillOrder​

Gets unsigned transactions that can be submitted to fulfil an open order. If the approval transaction exists it must be signed and submitted to the chain before the fulfilment transaction can be submitted or it will be reverted.

Method parameters

FulfillOrderRequestfulfillOrderRequestREQUIRED

Request object for fulfilling an order containing properties:

  • ListingId of type string - the listing ID to fulfil
  • TakerAddress of type string - the address of the account fulfilling the order
  • TakerFees of type List<FulfillOrderRequestTakerFeesInner> - taker ecosystem fees to be paid.
  • AmountToFill of type string - amount of the order to fill, defaults to sell item amount (only applies to ERC1155 orders) (optional)

See FulfillOrderRequest for more information.

Returns

FulfillOrder200Response

A response object for the fulfill order endpoint containing properties:

See FulfillOrder200Response for more information.

PrepareOrderCancellations​

Prepares cancellations for one or more orders.

Cancelling orders is a gasless alternative to on-chain cancellation exposed with CancelOrdersOnChain. For the orderbook to authenticate the cancellation, the creator of the orders must sign an EIP712 message containing the orderIds.

Method parameters

PrepareOrderCancellationsRequestprepareOrderCancellationsRequestREQUIRED

Request object for preparing order cancellations containing properties:

  • OrderIds of type List<string> - the ID's of the orders to attempt to cancel

See PrepareOrderCancellationsRequest for more information.

Returns

PrepareOrderCancellations200Response

A response object for the prepare order cancellations endpoint containing properties:

  • SignableAction of type SignableAction - the signable action to cancel the orders

See PrepareOrderCancellations200Response for further information.

CancelOrders​

Cancels one or more orders.

Cancelling orders is a gasless alternative to on-chain cancellation exposed with CancelOrdersOnChain. Orders cancelled this way cannot be fulfilled and will be removed from the orderbook. If there is pending fulfillment data outstanding for the order, its cancellation will be pending until the fulfillment window has passed. PrepareOrderCancellations can be used to get the signable action that is signed to get the signature required for this call.

Method parameters

CancelOrdersRequestcancelOrdersRequestREQUIRED

Request object for cancelling orders containing properties:

  • OrderIds of type List<string> - the order IDs to attempt to cancel
  • AccountAddress of type string - the address of the account cancelling the orders
  • Signature of type string - the signature obtained by signing the message obtained from PrepareOrderCancellations

See CancelOrdersRequest for more information.

Returns

CancelOrders200Response

A response object for the cancel orders endpoint containing properties:

See CancelOrders200Response for further information.

CancelOrdersOnChain​

Cancels one or more orders on the blockchain.

Get an unsigned order cancellation transaction. Orders can only be cancelled by the account that created them. All of the orders must be from the same seaport contract. If trying to cancel orders from multiple seaport contracts, group the orderIds by seaport contract and call this method for each group.

Method parameters

CancelOrdersOnChainRequestcancelOrdersOnChainRequestREQUIRED

Request object for cancelling orders on the blockchain containing properties:

  • OrderIds of type List<string> - the order IDs to cancel
  • AccountAddress of type string - the address of the account cancelling the order

See CancelOrdersOnChainRequest for more information.

Returns

CancelOrdersOnChain200Response

A response object for the cancel orders on chain endpoint containing properties:

See CancelOrdersOnChain200Response for further information.

TokenBalance​

Retrieves the token balance for a specified wallet and contract address.

Method parameters

stringwalletAddressREQUIRED

The wallet address to query for the token balance.

stringcontractAddressREQUIRED

The contract address of the token.

Returns

TokenBalance200Response

A response object for the token balance endpoint containing properties:

  • Quantity of type string - the quantity of the given token that the user has in their wallet.

See TokenBalance200Response for further information.

IMX Whitepaper • IMX Tokenomics • Block Explorer • Careers • Contact Us