Function: withdrawTokenBid()

function withdrawTokenBid<ThrowOnError>(options: OmitKeys<RequestOptions<ThrowOnError>, "body" | "url"> & WithdrawTokenBidData & Pick<RequestOptions<ThrowOnError>, "headers">): RequestResult<TokenTransaction, ErrorResponse, ThrowOnError>

Defined in: packages/api/src/client/sdk.gen.ts:212

Withdraw a previously placed bid on an token.
Allows users to withdraw a bid they have previously placed using the /bid endpoint.
This transaction cancels the active bid, releasing any locked funds.

Type Parameters

• ThrowOnError extends boolean = false

Parameters

options

OmitKeys<RequestOptions<ThrowOnError>, "body" | "url"> & WithdrawTokenBidData & Pick<RequestOptions<ThrowOnError>, "headers">

Returns

RequestResult<TokenTransaction, ErrorResponse, ThrowOnError>