Unreal Orderbook Reference
Information includes method descriptions, parameters and return types.
PrepareListing​
Gets required transactions and messages for signing prior to creating a listing.
Method parameters
Request object for preparing a listing containing details about the listing to be created:
Buyof type APIPrepareListingRequestBuyMakerAddressof typeFStringOrderExpiryof typeTOptional<FDateTime>(optional)Sellof type APIPrepareListingRequestSell
See APIPrepareListingRequest for more information.
Returns
A response object for the prepare listing endpoint containing properties:
Actionsof type TArray<APIAction>OrderComponentsof type APIOrderComponentsOrderHashof typeFString
See APIPrepareListing200Response for more information.
CreateListing​
Creates a listing.
Method parameters
Request object containing parameters for creating a listing:
MakerFeesof type TArray<APIFeeValue>OrderComponentsof type APIOrderComponentsOrderHashof typeFStringOrderSignatureof typeFString
See APICreateListingRequest for more information.
Returns
A response object for the create listing endpoint containing properties:
Resultof type APIOrder
See APICreateListing200Response 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
Request object containing parameters for fulfilling an order:
ListingIdof typeFString- the listing ID to fulfilTakerAddressof typeFString- the address of the account fulfilling the orderTakerFeesof type TArray<APIFulfillOrderRequestTakerFeesInner> - taker ecosystem fees to be paid.AmountToFillof typeTOptional<FString>- amount of the order to fill, defaults to sell item amount (only applies to ERC1155 orders)
See APIFulfillOrderRequest for more information.
Returns
A response object for the fulfill order endpoint containing properties:
Actionsof type TArray<APITransactionAction>Expirationof typeTOptional<FString>Orderof type APIOrder
See APIFulfillOrder200Response 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
Request object containing parameters for preparing order cancellations:
OrderIdsof typeTArray<FString>- the ID's of the orders to attempt to cancel
See APIPrepareOrderCancellationsRequest for more information.
Returns
A response object for the prepare order cancellations endpoint containing properties:
SignableActionof type APISignableAction - the signable action to cancel the orders
See APIPrepareOrderCancellations200Response 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
Request object containing parameters for cancelling orders:
OrderIdsof typeTArray<FString>- the order IDs to attempt to cancelAccountAddressof typeFString- the address of the account cancelling the ordersSignatureof typeFString- the signature obtained by signing the message obtained fromPrepareOrderCancellations
See APICancelOrdersRequest for more information.
Returns
A response object for the cancel orders endpoint containing properties:
Resultof type APICancelOrders200ResponseResult - the result of the off-chain cancellation request
See APICancelOrders200Response 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
Request object containing parameters for cancelling orders on the blockchain:
OrderIdsof typeTArray<FString>- the order IDs to cancelAccountAddressof typeFString- the address of the account cancelling the order
See APICancelOrdersOnChainRequest for more information.
Returns
A response object for the cancel orders on chain endpoint containing properties:
CancellationActionof type APITransactionAction - the unsigned cancel order action
See APICancelOrdersOnChain200Response for further information.
TokenBalance​
Retrieves the token balance for a specified wallet and contract address.
Method parameters
The wallet address to query for the token balance.
The contract address of the token.
Returns
A response object for the token balance endpoint containing properties:
Quantityof typeFString- the quantity of the given token that the user has in their wallet.
See APITokenBalance200Response for further information.