Class KadoAPI

Constructors

constructor

Methods

getConversionRate getOrderStatus getQuote getSupportedChains getSupportedCurrencies

Constructors

constructor

Methods

Static getConversionRate

  • getConversionRate(args): Promise<{
        error: string;
        success: false;
    } | {
        conversionRate: number;
        success: true;
    }>

  • Retrieves the conversion rate between two currencies.

    Parameters

    Returns Promise<{
        error: string;
        success: false;
    } | {
        conversionRate: number;
        success: true;
    }>

    A Promise resolving to an object containing the conversion rate on success, or an error message on failure.

Static getOrderStatus

  • getOrderStatus(orderId): Promise<{
        error: string;
        success: false;
    } | {
        status: OrderStatusResponse;
        success: true;
    }>

  • Retrieves the status of an order based on the order ID.

    Parameters

    • orderId: string

      The unique identifier of the order.

    Returns Promise<{
        error: string;
        success: false;
    } | {
        status: OrderStatusResponse;
        success: true;
    }>

    A Promise resolving to either an object containing the order status response (OrderStatusResponse) on success, or an error message on failure.

Static getQuote

  • getQuote(args): Promise<{
        error: string;
        success: false;
    } | {
        quote: KadoResponseQuote;
        request: KadoRequestQuoteArgs;
        success: true;
    }>

  • Requests a quote for a specified transaction.

    Parameters

    Returns Promise<{
        error: string;
        success: false;
    } | {
        quote: KadoResponseQuote;
        request: KadoRequestQuoteArgs;
        success: true;
    }>

    A Promise resolving to either an object containing the response quote (ResponseQuote) on success, or an error message on failure.

Static getSupportedChains

  • getSupportedChains(): Promise<{
        error: string;
        success: false;
    } | {
        chains: KadoAPIChainResponse[];
        success: true;
    }>

  • Fetches a list of supported blockchain chains from the Kado API.

    Returns Promise<{
        error: string;
        success: false;
    } | {
        chains: KadoAPIChainResponse[];
        success: true;
    }>

    A Promise resolving to either an object containing a list of chain responses (KadoAPIChainResponse[]) on success, or an error message on failure.

Static getSupportedCurrencies

  • getSupportedCurrencies(): Promise<{
        error: string;
        success: false;
    } | {
        currencies: Currency[];
        success: true;
    }>

  • Fetches a list of supported currencies from the Kado API.

    Returns Promise<{
        error: string;
        success: false;
    } | {
        currencies: Currency[];
        success: true;
    }>

    A Promise resolving to either an object containing a list of currencies (Currency[]) on success, or an error message on failure.

Settings

Member Visibility

Theme

On This Page

constructorgetConversionRategetOrderStatusgetQuotegetSupportedChainsgetSupportedCurrencies