Interface ConvertApiInterface

ConvertApi - interface ConvertApi

interface ConvertApiInterface {
    acceptTheOfferedQuote(
        requestParameters: AcceptTheOfferedQuoteRequest,
    ): Promise<RestApiResponse<AcceptTheOfferedQuoteResponse>>;
    listAllConvertPairs(
        requestParameters?: DerivativesTradingUsdsFuturesRestAPI.ListAllConvertPairsRequest,
    ): Promise<
        RestApiResponse<
            DerivativesTradingUsdsFuturesRestAPI.ListAllConvertPairsResponse,
        >,
    >;
    orderStatus(
        requestParameters?: DerivativesTradingUsdsFuturesRestAPI.OrderStatusRequest,
    ): Promise<
        RestApiResponse<
            DerivativesTradingUsdsFuturesRestAPI.OrderStatusResponse,
        >,
    >;
    sendQuoteRequest(
        requestParameters: DerivativesTradingUsdsFuturesRestAPI.SendQuoteRequestRequest,
    ): Promise<
        RestApiResponse<
            DerivativesTradingUsdsFuturesRestAPI.SendQuoteRequestResponse,
        >,
    >;
}

Implemented by

ConvertApi

Index

Methods

acceptTheOfferedQuote listAllConvertPairs orderStatus sendQuoteRequest

Methods

acceptTheOfferedQuote

acceptTheOfferedQuote(
requestParameters: AcceptTheOfferedQuoteRequest,
): Promise<RestApiResponse<AcceptTheOfferedQuoteResponse>>
Accept the offered quote by quote ID.

Weight: 200(IP)
Parameters
- requestParameters: AcceptTheOfferedQuoteRequest
  Request parameters.
Returns Promise<RestApiResponse<AcceptTheOfferedQuoteResponse>>
Throws
Memberof
ConvertApiInterface
- Defined in clients/derivatives-trading-usds-futures/src/rest-api/modules/convert-api.ts:226

listAllConvertPairs

listAllConvertPairs(
    requestParameters?: DerivativesTradingUsdsFuturesRestAPI.ListAllConvertPairsRequest,
): Promise<
    RestApiResponse<
        DerivativesTradingUsdsFuturesRestAPI.ListAllConvertPairsResponse,
    >,
>
Query for all convertible token pairs and the tokens’ respective upper/lower limits

User needs to supply either or both of the input parameter If not defined for both fromAsset and toAsset, only partial token pairs will be returned Asset BNFCR is only available to convert for MICA region users.

Weight: 20(IP)
Parameters
- OptionalrequestParameters: DerivativesTradingUsdsFuturesRestAPI.ListAllConvertPairsRequest
  Request parameters.
Returns Promise<
    RestApiResponse<
        DerivativesTradingUsdsFuturesRestAPI.ListAllConvertPairsResponse,
    >,
>
Throws
Memberof
ConvertApiInterface
- Defined in clients/derivatives-trading-usds-futures/src/rest-api/modules/convert-api.ts:244

orderStatus

orderStatus(
    requestParameters?: DerivativesTradingUsdsFuturesRestAPI.OrderStatusRequest,
): Promise<
    RestApiResponse<
        DerivativesTradingUsdsFuturesRestAPI.OrderStatusResponse,
    >,
>
Query order status by order ID.

Weight: 50(IP)
Parameters
- OptionalrequestParameters: DerivativesTradingUsdsFuturesRestAPI.OrderStatusRequest
  Request parameters.
Returns Promise<
    RestApiResponse<
        DerivativesTradingUsdsFuturesRestAPI.OrderStatusResponse,
    >,
>
Throws
Memberof
ConvertApiInterface
- Defined in clients/derivatives-trading-usds-futures/src/rest-api/modules/convert-api.ts:258

sendQuoteRequest

sendQuoteRequest(
    requestParameters: DerivativesTradingUsdsFuturesRestAPI.SendQuoteRequestRequest,
): Promise<
    RestApiResponse<
        DerivativesTradingUsdsFuturesRestAPI.SendQuoteRequestResponse,
    >,
>
Request a quote for the requested token pairs

Either fromAmount or toAmount should be sent quoteId will be returned only if you have enough funds to convert

Weight: 50(IP)
Parameters
- requestParameters: DerivativesTradingUsdsFuturesRestAPI.SendQuoteRequestRequest
  Request parameters.
Returns Promise<
    RestApiResponse<
        DerivativesTradingUsdsFuturesRestAPI.SendQuoteRequestResponse,
    >,
>
Throws
Memberof
ConvertApiInterface
- Defined in clients/derivatives-trading-usds-futures/src/rest-api/modules/convert-api.ts:275

Interface ConvertApiInterface

Implemented by

Index

Methods

Methods

acceptTheOfferedQuote

Parameters

Returns Promise<RestApiResponse<AcceptTheOfferedQuoteResponse>>

Throws

Memberof

listAllConvertPairs

Parameters

Returns Promise<
    RestApiResponse<
        DerivativesTradingUsdsFuturesRestAPI.ListAllConvertPairsResponse,
    >,
>

Throws

Memberof

orderStatus

Parameters

Returns Promise<
    RestApiResponse<
        DerivativesTradingUsdsFuturesRestAPI.OrderStatusResponse,
    >,
>

Throws

Memberof

sendQuoteRequest

Parameters

Returns Promise<
    RestApiResponse<
        DerivativesTradingUsdsFuturesRestAPI.SendQuoteRequestResponse,
    >,
>

Throws

Memberof

Settings

On This Page

Interface ConvertApiInterface

Implemented by

Index

Methods

Methods

acceptTheOfferedQuote

Parameters

Returns Promise<RestApiResponse<AcceptTheOfferedQuoteResponse>>

Throws

Memberof

listAllConvertPairs

Parameters

Returns Promise< RestApiResponse< DerivativesTradingUsdsFuturesRestAPI.ListAllConvertPairsResponse, >,>

Throws

Memberof

orderStatus

Parameters

Returns Promise< RestApiResponse< DerivativesTradingUsdsFuturesRestAPI.OrderStatusResponse, >,>

Throws

Memberof

sendQuoteRequest

Parameters

Returns Promise< RestApiResponse< DerivativesTradingUsdsFuturesRestAPI.SendQuoteRequestResponse, >,>

Throws

Memberof

Settings

On This Page

Returns Promise<
RestApiResponse<
DerivativesTradingUsdsFuturesRestAPI.ListAllConvertPairsResponse,
>,
>

Returns Promise<
RestApiResponse<
DerivativesTradingUsdsFuturesRestAPI.OrderStatusResponse,
>,
>

Returns Promise<
RestApiResponse<
DerivativesTradingUsdsFuturesRestAPI.SendQuoteRequestResponse,
>,
>