/** * Bluefin API * Bluefin API * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import type { Configuration } from './configuration.js'; import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; import type { RequestArgs } from './base.js'; import { BaseAPI } from './base.js'; /** * * @export * @interface Account */ export interface Account { /** * The (optional) group ID of the account. Accounts belonging to the same group cannot trade against each other. * @type {string} * @memberof Account */ 'groupId'?: string; /** * * @type {TradingFees} * @memberof Account */ 'tradingFees': TradingFees; /** * If the user can trade. * @type {boolean} * @memberof Account */ 'canTrade': boolean; /** * If the current user can deposit to the account. * @type {boolean} * @memberof Account */ 'canDeposit': boolean; /** * If the current user can withdraw from the account. * @type {boolean} * @memberof Account */ 'canWithdraw': boolean; /** * Total effective balance in USD (e9 format). * @type {string} * @memberof Account */ 'crossEffectiveBalanceE9': string; /** * The sum of initial margin required across all cross positions (e9 format). * @type {string} * @memberof Account */ 'crossMarginRequiredE9': string; /** * The sum of initial margin required across all open orders (e9 format). * @type {string} * @memberof Account */ 'totalOrderMarginRequiredE9': string; /** * The amount of margin available to open new positions and orders (e9 format). * @type {string} * @memberof Account */ 'marginAvailableE9': string; /** * The sum of maintenance margin required across all cross positions (e9 format). * @type {string} * @memberof Account */ 'crossMaintenanceMarginRequiredE9': string; /** * The amount of margin available before liquidation (e9 format). * @type {string} * @memberof Account */ 'crossMaintenanceMarginAvailableE9': string; /** * The ratio of the maintenance margin required to the account value (e9 format). * @type {string} * @memberof Account */ 'crossMaintenanceMarginRatioE9': string; /** * The leverage of the account (e9 format). * @type {string} * @memberof Account */ 'crossLeverageE9': string; /** * Total unrealized profit (e9 format). * @type {string} * @memberof Account */ 'totalUnrealizedPnlE9': string; /** * Unrealized profit of cross positions (e9 format). * @type {string} * @memberof Account */ 'crossUnrealizedPnlE9': string; /** * An implicitly negative number that sums only the losses of all cross positions. * @type {string} * @memberof Account */ 'crossUnrealizedLossE9': string; /** * The total value of the cross account, combining the cross effective balance and unrealized PnL across all cross positions, and subtracting any pending funding payments on any cross position. * @type {string} * @memberof Account */ 'crossAccountValueE9': string; /** * The total value of the account, combining the total effective balance and unrealized PnL across all positions, and subtracting any pending funding payments on any position. * @type {string} * @memberof Account */ 'totalAccountValueE9': string; /** * Last update time in milliseconds since Unix epoch. * @type {number} * @memberof Account */ 'updatedAtMillis': number; /** * * @type {Array} * @memberof Account */ 'assets': Array; /** * * @type {Array} * @memberof Account */ 'positions': Array; /** * Deprecated: Replaced with authorizedWallets. * @type {Array} * @memberof Account * @deprecated */ 'authorizedAccounts': Array; /** * The address of the account. * @type {string} * @memberof Account */ 'accountAddress': string; /** * The wallets that are authorized to trade on behalf of the current account. * @type {Array} * @memberof Account */ 'authorizedWallets': Array; } /** * Aggregated details about a trade in the account. * @export * @interface AccountAggregatedTradeUpdate */ export interface AccountAggregatedTradeUpdate { /** * * @type {Trade} * @memberof AccountAggregatedTradeUpdate */ 'trade': Trade; } /** * * @export * @interface AccountAuthorizationRequest */ export interface AccountAuthorizationRequest { /** * * @type {AccountAuthorizationRequestSignedFields} * @memberof AccountAuthorizationRequest */ 'signedFields': AccountAuthorizationRequestSignedFields; /** * The signature of the request, encoded from the signedFields * @type {string} * @memberof AccountAuthorizationRequest */ 'signature': string; /** * The (optional) alias of the account that is being authorized or deauthorized * @type {string} * @memberof AccountAuthorizationRequest */ 'alias'?: string; } /** * * @export * @interface AccountAuthorizationRequestSignedFields */ export interface AccountAuthorizationRequestSignedFields { /** * The account address of the parent account that is authorizing/deauthorizing this account * @type {string} * @memberof AccountAuthorizationRequestSignedFields */ 'accountAddress': string; /** * The address of the account that should be authorized/deauthorized * @type {string} * @memberof AccountAuthorizationRequestSignedFields */ 'authorizedAccountAddress': string; /** * The random generated salt. Should always be a number * @type {string} * @memberof AccountAuthorizationRequestSignedFields */ 'salt': string; /** * the ID of the internal datastore for the target network * @type {string} * @memberof AccountAuthorizationRequestSignedFields */ 'idsId': string; /** * The timestamp when the request was signed * @type {number} * @memberof AccountAuthorizationRequestSignedFields */ 'signedAtMillis': number; } /** * Details about a failure during an account command execution. * @export * @interface AccountCommandFailureUpdate */ export interface AccountCommandFailureUpdate { /** * The reason for the failure. * @type {string} * @memberof AccountCommandFailureUpdate */ 'reason': string; /** * * @type {CommandFailureReasonCode} * @memberof AccountCommandFailureUpdate */ 'reasonCode'?: CommandFailureReasonCode; /** * The type of command that failed. * @type {string} * @memberof AccountCommandFailureUpdate */ 'failedCommandType': string; /** * * @type {FailedCommandType} * @memberof AccountCommandFailureUpdate */ 'failedCommandTypeCode'?: FailedCommandType; /** * The timestamp when the command failed in milliseconds. * @type {number} * @memberof AccountCommandFailureUpdate */ 'failedAtMillis': number; } /** * Represents the type of account data stream. * @export * @enum {string} */ export declare const AccountDataStream: { readonly AccountOrderUpdate: "AccountOrderUpdate"; readonly AccountTradeUpdate: "AccountTradeUpdate"; readonly AccountAggregatedTradeUpdate: "AccountAggregatedTradeUpdate"; readonly AccountPositionUpdate: "AccountPositionUpdate"; readonly AccountUpdate: "AccountUpdate"; readonly AccountTransactionUpdate: "AccountTransactionUpdate"; readonly AccountCommandFailureUpdate: "AccountCommandFailureUpdate"; }; export type AccountDataStream = typeof AccountDataStream[keyof typeof AccountDataStream]; /** * The reason for the account-related event. * @export * @enum {string} */ export declare const AccountEventReason: { readonly Deposit: "Deposit"; readonly Withdraw: "Withdraw"; readonly OrderCreated: "OrderCreated"; readonly OrderMatched: "OrderMatched"; readonly OrderCancelled: "OrderCancelled"; readonly OrdersForMarketCancelled: "OrdersForMarketCancelled"; readonly LeverageUpdated: "LeverageUpdated"; readonly IsolatedMarginUpdated: "IsolatedMarginUpdated"; readonly FundingRatePayment: "FundingRatePayment"; readonly AccountGroupUpdated: "AccountGroupUpdated"; readonly Unspecified: "Unspecified"; }; export type AccountEventReason = typeof AccountEventReason[keyof typeof AccountEventReason]; /** * The type of account-related event. * @export * @enum {string} */ export declare const AccountEventType: { readonly AccountUpdate: "AccountUpdate"; readonly AccountTradeUpdate: "AccountTradeUpdate"; readonly AccountAggregatedTradeUpdate: "AccountAggregatedTradeUpdate"; readonly AccountOrderUpdate: "AccountOrderUpdate"; readonly AccountPositionUpdate: "AccountPositionUpdate"; readonly AccountTransactionUpdate: "AccountTransactionUpdate"; readonly AccountCommandFailureUpdate: "AccountCommandFailureUpdate"; }; export type AccountEventType = typeof AccountEventType[keyof typeof AccountEventType]; /** * * @export * @interface AccountFundingRateHistory */ export interface AccountFundingRateHistory { /** * * @type {Array} * @memberof AccountFundingRateHistory */ 'data': Array; } /** * * @export * @interface AccountFundingRateHistoryData */ export interface AccountFundingRateHistoryData { /** * Payment amount in e9 format. * @type {string} * @memberof AccountFundingRateHistoryData */ 'paymentAmountE9': string; /** * * @type {PositionSide} * @memberof AccountFundingRateHistoryData */ 'positionSide': PositionSide; /** * Funding rate value (e9 format). * @type {string} * @memberof AccountFundingRateHistoryData */ 'rateE9': string; /** * Market address. * @type {string} * @memberof AccountFundingRateHistoryData */ 'symbol': string; /** * Execution timestamp in milliseconds since Unix epoch. * @type {number} * @memberof AccountFundingRateHistoryData */ 'executedAtMillis': number; /** * Computed timestamp in milliseconds since Unix epoch. * @type {number} * @memberof AccountFundingRateHistoryData */ 'computedAtMillis': number; } /** * * @export * @interface AccountGroupIdPatch */ export interface AccountGroupIdPatch { /** * The address of the account to update. * @type {string} * @memberof AccountGroupIdPatch */ 'accountAddress': string; /** * The new group to assign the account to. If not set, the account will be removed from it\'s group. * @type {string} * @memberof AccountGroupIdPatch */ 'groupId'?: string; } /** * * @export * @interface AccountMarketPreference */ export interface AccountMarketPreference { /** * * @type {MarginType} * @memberof AccountMarketPreference */ 'marginType'?: MarginType; /** * User set leverage (e.g., 10x). * @type {number} * @memberof AccountMarketPreference */ 'setLeverage'?: number; } /** * @type AccountOrderUpdate * A message containing order update information. * @export */ export type AccountOrderUpdate = ActiveOrderUpdate | OrderCancellationUpdate; /** * * @export * @interface AccountPositionLeverageUpdateRequest */ export interface AccountPositionLeverageUpdateRequest { /** * * @type {AccountPositionLeverageUpdateRequestSignedFields} * @memberof AccountPositionLeverageUpdateRequest */ 'signedFields': AccountPositionLeverageUpdateRequestSignedFields; /** * The signature of the request, encoded from the signedFields * @type {string} * @memberof AccountPositionLeverageUpdateRequest */ 'signature': string; } /** * * @export * @interface AccountPositionLeverageUpdateRequestSignedFields */ export interface AccountPositionLeverageUpdateRequestSignedFields { /** * The Account Address from which to update leverage * @type {string} * @memberof AccountPositionLeverageUpdateRequestSignedFields */ 'accountAddress': string; /** * Symbol of the perpetual of the positions for which to update the leverage * @type {string} * @memberof AccountPositionLeverageUpdateRequestSignedFields */ 'symbol': string; /** * The leverage to set for the account positions (Must be a number in base e9) * @type {string} * @memberof AccountPositionLeverageUpdateRequestSignedFields */ 'leverageE9': string; /** * The random generated SALT. Should always be a number * @type {string} * @memberof AccountPositionLeverageUpdateRequestSignedFields */ 'salt': string; /** * the ID of the internal datastore for the target network * @type {string} * @memberof AccountPositionLeverageUpdateRequestSignedFields */ 'idsId': string; /** * The timestamp in millis at which the request was signed * @type {number} * @memberof AccountPositionLeverageUpdateRequestSignedFields */ 'signedAtMillis': number; } /** * Details about an account position update. * @export * @interface AccountPositionUpdate */ export interface AccountPositionUpdate { /** * The symbol of the market. * @type {string} * @memberof AccountPositionUpdate */ 'symbol': string; /** * The average entry price for the position. * @type {string} * @memberof AccountPositionUpdate */ 'avgEntryPriceE9': string; /** * The leverage applied to the position. * @type {string} * @memberof AccountPositionUpdate */ 'clientSetLeverageE9': string; /** * The liquidation price of the position. * @type {string} * @memberof AccountPositionUpdate */ 'liquidationPriceE9': string; /** * The current mark price of the position. * @type {string} * @memberof AccountPositionUpdate */ 'markPriceE9': string; /** * The notional value of the position. * @type {string} * @memberof AccountPositionUpdate */ 'notionalValueE9': string; /** * The size of the position. * @type {string} * @memberof AccountPositionUpdate */ 'sizeE9': string; /** * The unrealized profit and loss for the position. * @type {string} * @memberof AccountPositionUpdate */ 'unrealizedPnlE9': string; /** * * @type {PositionSide} * @memberof AccountPositionUpdate */ 'side': PositionSide; /** * The margin required for the position. * @type {string} * @memberof AccountPositionUpdate */ 'marginRequiredE9': string; /** * The maintenance margin required for the position. * @type {string} * @memberof AccountPositionUpdate */ 'maintenanceMarginE9': string; /** * Indicates if the position is isolated. * @type {boolean} * @memberof AccountPositionUpdate */ 'isIsolated': boolean; /** * The isolated margin applied to the position. * @type {string} * @memberof AccountPositionUpdate */ 'isolatedMarginE9': string; /** * The last update time for the position in milliseconds. * @type {number} * @memberof AccountPositionUpdate */ 'updatedAtMillis': number; } /** * * @export * @interface AccountPreference */ export interface AccountPreference { [key: string]: any; /** * User preferred language. * @type {string} * @memberof AccountPreference */ 'language'?: string; /** * User preferred theme. * @type {string} * @memberof AccountPreference */ 'theme'?: string; /** * * @type {Array} * @memberof AccountPreference */ 'market'?: Array; } /** * Account stream message for account-related events. The payload depends on the event type. * @export * @interface AccountStreamMessage */ export interface AccountStreamMessage { /** * * @type {AccountEventType} * @memberof AccountStreamMessage */ 'event': AccountEventType; /** * * @type {AccountEventReason} * @memberof AccountStreamMessage */ 'reason': AccountEventReason; /** * * @type {AccountStreamMessagePayload} * @memberof AccountStreamMessage */ 'payload': AccountStreamMessagePayload; } /** * @type AccountStreamMessagePayload * The payload of the message, which varies based on the event type. * @export */ export type AccountStreamMessagePayload = AccountAggregatedTradeUpdate | AccountCommandFailureUpdate | AccountOrderUpdate | AccountPositionUpdate | AccountTradeUpdate | AccountTransactionUpdate | AccountUpdate; /** * Subscription message for account data streams. * @export * @interface AccountSubscriptionMessage */ export interface AccountSubscriptionMessage { /** * The authentication token for the account. * @type {string} * @memberof AccountSubscriptionMessage */ 'authToken'?: string; /** * * @type {SubscriptionType} * @memberof AccountSubscriptionMessage */ 'method': SubscriptionType; /** * List of account data streams to subscribe or unsubscribe from. * @type {Array} * @memberof AccountSubscriptionMessage */ 'dataStreams': Array; } /** * Details about a trade in the account. * @export * @interface AccountTradeUpdate */ export interface AccountTradeUpdate { /** * * @type {Trade} * @memberof AccountTradeUpdate */ 'trade': Trade; } /** * Details about a transaction in the account. * @export * @interface AccountTransactionUpdate */ export interface AccountTransactionUpdate { /** * The symbol of the market. * @type {string} * @memberof AccountTransactionUpdate */ 'symbol'?: string; /** * * @type {TransactionType} * @memberof AccountTransactionUpdate */ 'transactionType': TransactionType; /** * The amount of the transaction in scientific notation with 9 decimal places. * @type {string} * @memberof AccountTransactionUpdate */ 'amountE9': string; /** * The symbol of the asset. * @type {string} * @memberof AccountTransactionUpdate */ 'assetSymbol'?: string; /** * The trade ID associated with the transaction. * @type {string} * @memberof AccountTransactionUpdate */ 'tradeId'?: string; /** * The timestamp when the transaction was executed in milliseconds. * @type {number} * @memberof AccountTransactionUpdate */ 'executedAtMillis': number; } /** * Account information for the data stream. * @export * @interface AccountUpdate */ export interface AccountUpdate { /** * The optional group ID of the account. * @type {string} * @memberof AccountUpdate */ 'groupId'?: string; /** * * @type {TradingFees} * @memberof AccountUpdate */ 'tradingFees'?: TradingFees; /** * If the user can trade. * @type {boolean} * @memberof AccountUpdate */ 'canTrade': boolean; /** * If the current user can deposit to the account. * @type {boolean} * @memberof AccountUpdate */ 'canDeposit': boolean; /** * If the current user can withdraw from the account. * @type {boolean} * @memberof AccountUpdate */ 'canWithdraw': boolean; /** * Total effective balance in USD (e9 format). * @type {string} * @memberof AccountUpdate */ 'crossEffectiveBalanceE9': string; /** * The sum of initial margin required across all cross positions (e9 format). * @type {string} * @memberof AccountUpdate */ 'crossMarginRequiredE9': string; /** * The sum of initial margin required across all open orders (e9 format). * @type {string} * @memberof AccountUpdate */ 'totalOrderMarginRequiredE9': string; /** * The amount of margin available to open new positions and orders (e9 format). * @type {string} * @memberof AccountUpdate */ 'marginAvailableE9': string; /** * The sum of maintenance margin required across all cross positions (e9 format). * @type {string} * @memberof AccountUpdate */ 'crossMaintenanceMarginRequiredE9': string; /** * The amount of margin available before liquidation (e9 format). * @type {string} * @memberof AccountUpdate */ 'crossMaintenanceMarginAvailableE9': string; /** * The ratio of the maintenance margin required to the account value (e9 format). * @type {string} * @memberof AccountUpdate */ 'crossMaintenanceMarginRatioE9': string; /** * The leverage of the account (e9 format). * @type {string} * @memberof AccountUpdate */ 'crossLeverageE9': string; /** * Total unrealized profit (e9 format). * @type {string} * @memberof AccountUpdate */ 'totalUnrealizedPnlE9': string; /** * Unrealized profit of cross positions (e9 format). * @type {string} * @memberof AccountUpdate */ 'crossUnrealizedPnlE9': string; /** * An implicitly negative number that sums only the losses of all cross positions. * @type {string} * @memberof AccountUpdate */ 'crossUnrealizedLossE9': string; /** * The total value of the cross account, combining the cross effective balance and unrealized PnL across all cross positions, and subtracting any pending funding payments on any cross position. * @type {string} * @memberof AccountUpdate */ 'crossAccountValueE9': string; /** * The total value of the account, combining the total effective balance and unrealized PnL across all positions, and subtracting any pending funding payments on any position. * @type {string} * @memberof AccountUpdate */ 'totalAccountValueE9': string; /** * Last update time in milliseconds since Unix epoch. * @type {number} * @memberof AccountUpdate */ 'updatedAtMillis': number; /** * * @type {Array} * @memberof AccountUpdate */ 'assets': Array; /** * Deprecated: Replaced with authorizedWallets. * @type {Array} * @memberof AccountUpdate * @deprecated */ 'authorizedAccounts': Array; /** * The wallets that are authorized to trade on behalf of the current account. * @type {Array} * @memberof AccountUpdate */ 'authorizedWallets': Array; } /** * * @export * @interface AccountValueHistory */ export interface AccountValueHistory { /** * Latest account value (e9 format). * @type {string} * @memberof AccountValueHistory */ 'latestValueE9': string; /** * Change in value from the first to the last value in the interval (e9 format). * @type {string} * @memberof AccountValueHistory */ 'valueChangeE9': string; /** * Percentage change in value from the first to the last value in the interval (e9 format). * @type {string} * @memberof AccountValueHistory */ 'valueChangePercentageE9': string; /** * Latest unrealized PnL value (e9 format). * @type {string} * @memberof AccountValueHistory */ 'latestUnrealizedPnlE9': string; /** * Change in unrealized PnL from the first to the last value in the interval (e9 format). * @type {string} * @memberof AccountValueHistory */ 'unrealizedPnlChangeE9': string; /** * Percentage change in unrealized PnL from the first to the last value in the interval (e9 format). * @type {string} * @memberof AccountValueHistory */ 'unrealizedPnlChangePercentageE9': string; /** * Latest accumulated PnL value (e9 format). This is the cumulative sum of all period PnLs. * @type {string} * @memberof AccountValueHistory */ 'latestAccumulatedPnlE9': string; /** * Change in accumulated PnL from the first to the last value in the interval (e9 format). * @type {string} * @memberof AccountValueHistory */ 'accumulatedPnlChangeE9': string; /** * Percentage change in accumulated PnL from the first to the last value in the interval (e9 format). * @type {string} * @memberof AccountValueHistory */ 'accumulatedPnlChangePercentageE9': string; /** * * @type {Array} * @memberof AccountValueHistory */ 'values': Array; } /** * * @export * @interface AccountValueHistoryData */ export interface AccountValueHistoryData { /** * Timestamp in milliseconds since Unix epoch. * @type {number} * @memberof AccountValueHistoryData */ 'timestampMillis': number; /** * Unrealized PnL at this timestamp (e9 format). * @type {string} * @memberof AccountValueHistoryData */ 'unrealizedPnlE9': string; /** * Account value at this timestamp (e9 format). * @type {string} * @memberof AccountValueHistoryData */ 'valueE9': string; /** * Accumulated PnL at this timestamp (e9 format). This is the cumulative sum of all period PnLs up to this point. * @type {string} * @memberof AccountValueHistoryData */ 'accumulatedPnlE9': string; } /** * Information about an order update. * @export * @interface ActiveOrderUpdate */ export interface ActiveOrderUpdate { /** * The unique hash of the order. * @type {string} * @memberof ActiveOrderUpdate */ 'orderHash': string; /** * The client-provided order ID. * @type {string} * @memberof ActiveOrderUpdate */ 'clientOrderId'?: string; /** * The symbol of the market. * @type {string} * @memberof ActiveOrderUpdate */ 'symbol': string; /** * The address of the account. * @type {string} * @memberof ActiveOrderUpdate */ 'accountAddress': string; /** * The price of the order in scientific notation with 9 decimal places. * @type {string} * @memberof ActiveOrderUpdate */ 'priceE9': string; /** * The quantity of the order in scientific notation with 9 decimal places. * @type {string} * @memberof ActiveOrderUpdate */ 'quantityE9': string; /** * The filled quantity of the order in scientific notation with 9 decimal places. * @type {string} * @memberof ActiveOrderUpdate */ 'filledQuantityE9': string; /** * * @type {TradeSide} * @memberof ActiveOrderUpdate */ 'side': TradeSide; /** * The leverage of the order in scientific notation with 9 decimal places. * @type {string} * @memberof ActiveOrderUpdate */ 'leverageE9': string; /** * Indicates if the order is isolated. * @type {boolean} * @memberof ActiveOrderUpdate */ 'isIsolated': boolean; /** * A unique salt for the order. * @type {string} * @memberof ActiveOrderUpdate */ 'salt': string; /** * The expiration timestamp of the order in milliseconds. * @type {number} * @memberof ActiveOrderUpdate */ 'expiresAtMillis': number; /** * The signing timestamp of the order in milliseconds. * @type {number} * @memberof ActiveOrderUpdate */ 'signedAtMillis': number; /** * The address of the signer of the order request. * @type {string} * @memberof ActiveOrderUpdate */ 'signerAddress': string; /** * * @type {OrderType} * @memberof ActiveOrderUpdate */ 'type': OrderType; /** * Indicates if the order is reduce-only. * @type {boolean} * @memberof ActiveOrderUpdate */ 'reduceOnly': boolean; /** * Indicates if the order is post-only. * @type {boolean} * @memberof ActiveOrderUpdate */ 'postOnly': boolean; /** * * @type {OrderTimeInForce} * @memberof ActiveOrderUpdate */ 'timeInForce': OrderTimeInForce; /** * The trigger price for stop-limit or stop-market orders. * @type {string} * @memberof ActiveOrderUpdate */ 'triggerPriceE9'?: string; /** * * @type {OrderStatus} * @memberof ActiveOrderUpdate */ 'status': OrderStatus; /** * * @type {SelfTradePreventionType} * @memberof ActiveOrderUpdate */ 'selfTradePreventionType': SelfTradePreventionType; /** * The timestamp when the order was placed, in milliseconds. * @type {number} * @memberof ActiveOrderUpdate */ 'createdAtMillis': number; /** * The timestamp of the last update of the order in milliseconds. * @type {number} * @memberof ActiveOrderUpdate */ 'updatedAtMillis': number; /** * * @type {ClientType} * @memberof ActiveOrderUpdate */ 'client'?: ClientType; } /** * * @export * @interface AdjustIsolatedMarginRequest */ export interface AdjustIsolatedMarginRequest { /** * * @type {AdjustIsolatedMarginRequestSignedFields} * @memberof AdjustIsolatedMarginRequest */ 'signedFields': AdjustIsolatedMarginRequestSignedFields; /** * The signature of the request, encoded from the signedFields * @type {string} * @memberof AdjustIsolatedMarginRequest */ 'signature': string; } /** * * @export * @interface AdjustIsolatedMarginRequestSignedFields */ export interface AdjustIsolatedMarginRequestSignedFields { /** * the ID of the internal datastore for the target network * @type {string} * @memberof AdjustIsolatedMarginRequestSignedFields */ 'idsId': string; /** * The account address of the account for which to adjust margin * @type {string} * @memberof AdjustIsolatedMarginRequestSignedFields */ 'accountAddress': string; /** * The symbol of the isolated position for which to adjust margin * @type {string} * @memberof AdjustIsolatedMarginRequestSignedFields */ 'symbol': string; /** * * @type {AdjustMarginOperation} * @memberof AdjustIsolatedMarginRequestSignedFields */ 'operation': AdjustMarginOperation; /** * The quantity of margin to adjust for the isolated position * @type {string} * @memberof AdjustIsolatedMarginRequestSignedFields */ 'quantityE9': string; /** * The random generated SALT. Should always be a number * @type {string} * @memberof AdjustIsolatedMarginRequestSignedFields */ 'salt': string; /** * The timestamp in millis at which the request was signed * @type {number} * @memberof AdjustIsolatedMarginRequestSignedFields */ 'signedAtMillis': number; } /** * The operation to perform on the margin * @export * @enum {string} */ export declare const AdjustMarginOperation: { readonly Add: "ADD"; readonly Subtract: "SUBTRACT"; }; export type AdjustMarginOperation = typeof AdjustMarginOperation[keyof typeof AdjustMarginOperation]; /** * * @export * @interface AffiliateIntervalOverview */ export interface AffiliateIntervalOverview { /** * The user\'s wallet address * @type {string} * @memberof AffiliateIntervalOverview */ 'userAddress': string; /** * Name of the affiliate * @type {string} * @memberof AffiliateIntervalOverview */ 'name'?: string; /** * The interval number for the affiliate\'s earnings data * @type {number} * @memberof AffiliateIntervalOverview */ 'intervalNumber': number; /** * Start date of the interval in seconds * @type {number} * @memberof AffiliateIntervalOverview */ 'intervalStartDate': number; /** * End date of the interval in seconds * @type {number} * @memberof AffiliateIntervalOverview */ 'intervalEndDate': number; /** * Status of the interval * @type {string} * @memberof AffiliateIntervalOverview */ 'status': AffiliateIntervalOverviewStatusEnum; /** * Date when the user was referred * @type {string} * @memberof AffiliateIntervalOverview */ 'referredSince': string; /** * Referee earnings from perps trading (e9 format) * @type {string} * @memberof AffiliateIntervalOverview */ 'perpsRefereeEarningsE9': string; /** * Referee earnings from spot LP (e9 format) * @type {string} * @memberof AffiliateIntervalOverview */ 'spotLPRefereeEarningsE9': string; /** * Referee earnings from lending (e9 format) * @type {string} * @memberof AffiliateIntervalOverview */ 'lendingRefereeEarningsE9': string; /** * Referee earnings from ember (e9 format) * @type {string} * @memberof AffiliateIntervalOverview */ 'emberRefereeEarningsE9': string; /** * Referral earnings from perps trading (e9 format) * @type {string} * @memberof AffiliateIntervalOverview */ 'perpsReferralEarningsE9': string; /** * Referral earnings from spot LP (e9 format) * @type {string} * @memberof AffiliateIntervalOverview */ 'spotLPReferralEarningsE9': string; /** * Referral earnings from lending (e9 format) * @type {string} * @memberof AffiliateIntervalOverview */ 'lendingReferralEarningsE9': string; /** * Total earnings from ember (e9 format) * @type {string} * @memberof AffiliateIntervalOverview */ 'emberTotalEarningsE9': string; /** * Total earnings from perps trading (e9 format) * @type {string} * @memberof AffiliateIntervalOverview */ 'perpsTotalEarningsE9': string; /** * Total earnings from spot LP (e9 format) * @type {string} * @memberof AffiliateIntervalOverview */ 'spotLPTotalEarningsE9': string; /** * Total earnings from lending (e9 format) * @type {string} * @memberof AffiliateIntervalOverview */ 'lendingTotalEarningsE9': string; /** * Total earnings from referrals (e9 format) * @type {string} * @memberof AffiliateIntervalOverview */ 'totalReferralEarningsE9': string; /** * Total earnings from referee activities (e9 format) * @type {string} * @memberof AffiliateIntervalOverview */ 'totalRefereeEarningsE9': string; /** * Total earnings combining referrals and referee activities (e9 format) * @type {string} * @memberof AffiliateIntervalOverview */ 'totalEarningsE9': string; } export declare const AffiliateIntervalOverviewStatusEnum: { readonly Active: "ACTIVE"; readonly NotStarted: "NOT_STARTED"; readonly Finalized: "FINALIZED"; readonly Cooldown: "COOLDOWN"; }; export type AffiliateIntervalOverviewStatusEnum = typeof AffiliateIntervalOverviewStatusEnum[keyof typeof AffiliateIntervalOverviewStatusEnum]; /** * * @export * @interface AffiliateLeaderDashboard */ export interface AffiliateLeaderDashboard { /** * The user\'s wallet address * @type {string} * @memberof AffiliateLeaderDashboard */ 'userAddress': string; /** * Name of the affiliate * @type {string} * @memberof AffiliateLeaderDashboard */ 'name'?: string; /** * The parent affiliate\'s wallet address * @type {string} * @memberof AffiliateLeaderDashboard */ 'parentAddress': string; /** * Name of the parent affiliate * @type {string} * @memberof AffiliateLeaderDashboard */ 'parentName'?: string; /** * Ranking in perps trading category * @type {number} * @memberof AffiliateLeaderDashboard */ 'perpsRank': number; /** * Ranking in spot trading category * @type {number} * @memberof AffiliateLeaderDashboard */ 'spotRank': number; /** * Ranking in lending category * @type {number} * @memberof AffiliateLeaderDashboard */ 'lendingRank': number; /** * Ranking in ember category * @type {number} * @memberof AffiliateLeaderDashboard */ 'emberRank': number; /** * Total earnings from perps trading (e9 format) * @type {string} * @memberof AffiliateLeaderDashboard */ 'perpsTotalEarningsE9': string; /** * Total earnings from spot trading (e9 format) * @type {string} * @memberof AffiliateLeaderDashboard */ 'spotTotalEarningsE9': string; /** * Total earnings from lending (e9 format) * @type {string} * @memberof AffiliateLeaderDashboard */ 'lendingTotalEarningsE9': string; } /** * * @export * @interface AffiliateMetadata */ export interface AffiliateMetadata { /** * The user\'s wallet address * @type {string} * @memberof AffiliateMetadata */ 'userAddress': string; /** * The referral code of the parent affiliate * @type {string} * @memberof AffiliateMetadata */ 'parentReferralCode'?: string | null; /** * The user\'s referral code if approved as an affiliate * @type {string} * @memberof AffiliateMetadata */ 'referralCode'?: string | null; /** * The name of the affiliate * @type {string} * @memberof AffiliateMetadata */ 'name'?: string; /** * The name of the parent affiliate * @type {string} * @memberof AffiliateMetadata */ 'parentName'?: string | null; /** * * @type {FeeConfigs} * @memberof AffiliateMetadata */ 'fees'?: FeeConfigs; /** * Status of the affiliate application * @type {string} * @memberof AffiliateMetadata */ 'status'?: AffiliateMetadataStatusEnum | null; /** * Indicates whether the user has traded or not * @type {boolean} * @memberof AffiliateMetadata */ 'hasTraded': boolean; /** * Tier of the affiliate * @type {string} * @memberof AffiliateMetadata */ 'tier'?: AffiliateMetadataTierEnum; /** * Indicates whether the affiliate is an ember affiliate * @type {boolean} * @memberof AffiliateMetadata */ 'isEmber'?: boolean; } export declare const AffiliateMetadataStatusEnum: { readonly Pending: "PENDING"; readonly Approved: "APPROVED"; readonly Rejected: "REJECTED"; }; export type AffiliateMetadataStatusEnum = typeof AffiliateMetadataStatusEnum[keyof typeof AffiliateMetadataStatusEnum]; export declare const AffiliateMetadataTierEnum: { readonly S: "S"; readonly A: "A"; readonly N: "N"; readonly U: "U"; }; export type AffiliateMetadataTierEnum = typeof AffiliateMetadataTierEnum[keyof typeof AffiliateMetadataTierEnum]; /** * * @export * @interface AffiliateOnboardResponse */ export interface AffiliateOnboardResponse { /** * Status of the application * @type {string} * @memberof AffiliateOnboardResponse */ 'status': AffiliateOnboardResponseStatusEnum; /** * Response message including rejection reason if application was rejected * @type {string} * @memberof AffiliateOnboardResponse */ 'message': string; } export declare const AffiliateOnboardResponseStatusEnum: { readonly Approved: "APPROVED"; readonly Rejected: "REJECTED"; readonly Pending: "PENDING"; }; export type AffiliateOnboardResponseStatusEnum = typeof AffiliateOnboardResponseStatusEnum[keyof typeof AffiliateOnboardResponseStatusEnum]; /** * * @export * @interface AffiliateOverview */ export interface AffiliateOverview { /** * The user\'s wallet address * @type {string} * @memberof AffiliateOverview */ 'userAddress': string; /** * Name of the affiliate * @type {string} * @memberof AffiliateOverview */ 'name'?: string; /** * Referee earnings from perps trading (e9 format) * @type {string} * @memberof AffiliateOverview */ 'perpsRefereeEarningsE9': string; /** * Referee earnings from spot LP (e9 format) * @type {string} * @memberof AffiliateOverview */ 'spotLPRefereeEarningsE9': string; /** * Referee earnings from lending (e9 format) * @type {string} * @memberof AffiliateOverview */ 'lendingRefereeEarningsE9': string; /** * Referee earnings from ember (e9 format) * @type {string} * @memberof AffiliateOverview */ 'emberRefereeEarningsE9': string; /** * Referral earnings from perps trading (e9 format) * @type {string} * @memberof AffiliateOverview */ 'perpsReferralEarningsE9': string; /** * Referral earnings from spot LP (e9 format) * @type {string} * @memberof AffiliateOverview */ 'spotLPReferralEarningsE9': string; /** * Referral earnings from lending (e9 format) * @type {string} * @memberof AffiliateOverview */ 'lendingReferralEarningsE9': string; /** * Total earnings from perps trading (e9 format) * @type {string} * @memberof AffiliateOverview */ 'perpsTotalEarningsE9': string; /** * Total earnings from spot LP (e9 format) * @type {string} * @memberof AffiliateOverview */ 'spotLPTotalEarningsE9': string; /** * Total earnings from lending (e9 format) * @type {string} * @memberof AffiliateOverview */ 'lendingTotalEarningsE9': string; /** * Total earnings from ember (e9 format) * @type {string} * @memberof AffiliateOverview */ 'emberTotalEarningsE9': string; /** * Total earnings from referrals (e9 format) * @type {string} * @memberof AffiliateOverview */ 'totalReferralEarningsE9': string; /** * Total earnings from referee activities (e9 format) * @type {string} * @memberof AffiliateOverview */ 'totalRefereeEarningsE9': string; /** * Total earnings combining referrals and referee activities (e9 format) * @type {string} * @memberof AffiliateOverview */ 'totalEarningsE9': string; } /** * * @export * @interface AffiliateSummary */ export interface AffiliateSummary { /** * The user\'s wallet address * @type {string} * @memberof AffiliateSummary */ 'userAddress': string; /** * Total number of referees * @type {number} * @memberof AffiliateSummary */ 'totalReferredUsers': number; /** * Total earnings in e9 format * @type {string} * @memberof AffiliateSummary */ 'totalEarningsE9': string; /** * Ranking in perps trading category * @type {number} * @memberof AffiliateSummary */ 'perpsRanking': number; /** * Ranking in spot trading category * @type {number} * @memberof AffiliateSummary */ 'spotRanking': number; /** * Ranking in lending category * @type {number} * @memberof AffiliateSummary */ 'lendRanking': number; /** * Ranking in ember category * @type {number} * @memberof AffiliateSummary */ 'emberRanking': number; /** * Total earnings from ember (e9 format) * @type {string} * @memberof AffiliateSummary */ 'totalEmberEarningsE9': string; /** * Total earnings from spot (e9 format) * @type {string} * @memberof AffiliateSummary */ 'totalSpotEarningsE9': string; /** * Total earnings from perps (e9 format) * @type {string} * @memberof AffiliateSummary */ 'totalPerpsEarningsE9': string; } /** * Details about an asset in the account. * @export * @interface Asset */ export interface Asset { /** * The symbol of the asset. * @type {string} * @memberof Asset */ 'symbol': string; /** * The quantity of the asset. * @type {string} * @memberof Asset */ 'quantityE9': string; /** * The effective balance of the asset. * @type {string} * @memberof Asset */ 'effectiveBalanceE9': string; /** * The maximum quantity that can be withdrawn. * @type {string} * @memberof Asset */ 'maxWithdrawQuantityE9': string; /** * The timestamp of the last update in milliseconds. * @type {number} * @memberof Asset */ 'updatedAtMillis': number; } /** * * @export * @interface AssetConfig */ export interface AssetConfig { /** * The bank address of the asset. * @type {string} * @memberof AssetConfig */ 'assetType': string; /** * Asset symbol. * @type {string} * @memberof AssetConfig */ 'symbol': string; /** * Default precision for rendering this asset. * @type {number} * @memberof AssetConfig */ 'decimals': number; /** * Weight applied to asset to use as margin in Multi-Assets mode. * @type {string} * @memberof AssetConfig */ 'weight': string; /** * Indicates if the asset can be used as margin in Multi-Assets mode. * @type {boolean} * @memberof AssetConfig */ 'marginAvailable': boolean; } /** * * @export * @interface AuthorizedWallet */ export interface AuthorizedWallet { /** * The address of the authorized wallet. * @type {string} * @memberof AuthorizedWallet */ 'address': string; /** * The alias of the authorized wallet. * @type {string} * @memberof AuthorizedWallet */ 'alias'?: string; /** * The timestamp in milliseconds when the wallet was authorized. * @type {number} * @memberof AuthorizedWallet */ 'authorizedAtMillis': number; } /** * * @export * @interface BalanceResponse */ export interface BalanceResponse { /** * User\'s wallet address. * @type {string} * @memberof BalanceResponse */ 'userAddress': string; /** * Lifetime Vera Points total. * @type {string} * @memberof BalanceResponse */ 'totalPoints': string; /** * Current status tier. * @type {string} * @memberof BalanceResponse */ 'currentTier': BalanceResponseCurrentTierEnum; /** * User\'s rank by lifetime points (1-based). * @type {number} * @memberof BalanceResponse */ 'rank': number; /** * Next tier above current; null if Diamond. * @type {string} * @memberof BalanceResponse */ 'nextTier': BalanceResponseNextTierEnum | null; /** * Points required for next tier; null if Diamond. * @type {string} * @memberof BalanceResponse */ 'nextTierThreshold': string | null; } export declare const BalanceResponseCurrentTierEnum: { readonly None: "NONE"; readonly Silver: "SILVER"; readonly Gold: "GOLD"; readonly Platinum: "PLATINUM"; readonly Diamond: "DIAMOND"; }; export type BalanceResponseCurrentTierEnum = typeof BalanceResponseCurrentTierEnum[keyof typeof BalanceResponseCurrentTierEnum]; export declare const BalanceResponseNextTierEnum: { readonly Silver: "SILVER"; readonly Gold: "GOLD"; readonly Platinum: "PLATINUM"; readonly Diamond: "DIAMOND"; }; export type BalanceResponseNextTierEnum = typeof BalanceResponseNextTierEnum[keyof typeof BalanceResponseNextTierEnum]; /** * * @export * @interface CampaignMetadata */ export interface CampaignMetadata { /** * * @type {string} * @memberof CampaignMetadata */ 'Status': CampaignMetadataStatusEnum; /** * Name of the campaign. * @type {string} * @memberof CampaignMetadata */ 'CampaignName': string; /** * Name of the parent campaign. * @type {string} * @memberof CampaignMetadata */ 'ParentCampaignName': string; /** * Time in seconds for campaign start date. * @type {number} * @memberof CampaignMetadata */ 'StartDate': number; /** * Time in seconds for campaign end date. * @type {number} * @memberof CampaignMetadata */ 'EndDate': number; } export declare const CampaignMetadataStatusEnum: { readonly Active: "ACTIVE"; readonly Inactive: "INACTIVE"; }; export type CampaignMetadataStatusEnum = typeof CampaignMetadataStatusEnum[keyof typeof CampaignMetadataStatusEnum]; /** * Cancelling Orders for a specific symbol. If order hashes are not specified, all orders are canceled for this symbol * @export * @interface CancelOrdersRequest */ export interface CancelOrdersRequest { /** * The symbol of the perpetual for which to cancel orders. * @type {string} * @memberof CancelOrdersRequest */ 'symbol': string; /** * List of order hashes of the orders to be cancelled. All orders must belong to accountAddress. Max 10 order hashes * @type {Array} * @memberof CancelOrdersRequest */ 'orderHashes'?: Array; } /** * Response to a request to cancel orders. * @export * @interface CancelOrdersResponse */ export interface CancelOrdersResponse { /** * The order hashes of the cancelled orders. * @type {Array} * @memberof CancelOrdersResponse */ 'orderHashes': Array; } /** * * @export * @enum {string} */ export declare const CandlePriceType: { readonly Last: "Last"; readonly Market: "Market"; readonly Oracle: "Oracle"; readonly Mark: "Mark"; readonly Unspecified: "UNSPECIFIED"; }; export type CandlePriceType = typeof CandlePriceType[keyof typeof CandlePriceType]; /** * Represents a candlestick for a specific market and interval. * @export * @interface CandlestickUpdate */ export interface CandlestickUpdate { /** * The symbol of the market for this candlestick. * @type {string} * @memberof CandlestickUpdate */ 'symbol': string; /** * The start time of the candlestick in milliseconds since epoch. * @type {number} * @memberof CandlestickUpdate */ 'startTime': number; /** * The end time of the candlestick in milliseconds since epoch. * @type {number} * @memberof CandlestickUpdate */ 'endTime': number; /** * The interval of the candlestick (e.g., 1m, 5m, 1h). * @type {string} * @memberof CandlestickUpdate */ 'interval': string; /** * The opening price of the candlestick. * @type {string} * @memberof CandlestickUpdate */ 'openPriceE9': string; /** * The closing price of the candlestick. * @type {string} * @memberof CandlestickUpdate */ 'closePriceE9': string; /** * The highest price during the candlestick interval. * @type {string} * @memberof CandlestickUpdate */ 'highPriceE9': string; /** * The lowest price during the candlestick interval. * @type {string} * @memberof CandlestickUpdate */ 'lowPriceE9': string; /** * The total trading volume during the candlestick interval. * @type {string} * @memberof CandlestickUpdate */ 'volumeE9': string; /** * The total quote volume traded during the candlestick interval. * @type {string} * @memberof CandlestickUpdate */ 'quoteVolumeE9': string; /** * The number of trades that occurred during the candlestick interval. * @type {number} * @memberof CandlestickUpdate */ 'numTrades': number; } /** * * @export * @interface ClaimSignatureItem */ export interface ClaimSignatureItem { /** * Type of reward for this claim signature. * @type {string} * @memberof ClaimSignatureItem */ 'rewardType': ClaimSignatureItemRewardTypeEnum; /** * * @type {SigPayload} * @memberof ClaimSignatureItem */ 'sigPayload': SigPayload; /** * Signature for the claim. * @type {string} * @memberof ClaimSignatureItem */ 'signature': string; } export declare const ClaimSignatureItemRewardTypeEnum: { readonly Blue: "Blue"; readonly Sui: "Sui"; readonly Wal: "Wal"; readonly Cash: "Cash"; }; export type ClaimSignatureItemRewardTypeEnum = typeof ClaimSignatureItemRewardTypeEnum[keyof typeof ClaimSignatureItemRewardTypeEnum]; /** * * @export * @interface ClientCredentialsRequest */ export interface ClientCredentialsRequest { /** * * @type {string} * @memberof ClientCredentialsRequest */ 'client_id': string; /** * * @type {string} * @memberof ClientCredentialsRequest */ 'client_secret': string; /** * * @type {string} * @memberof ClientCredentialsRequest */ 'grant_type': ClientCredentialsRequestGrantTypeEnum; } export declare const ClientCredentialsRequestGrantTypeEnum: { readonly ClientCredentials: "client_credentials"; }; export type ClientCredentialsRequestGrantTypeEnum = typeof ClientCredentialsRequestGrantTypeEnum[keyof typeof ClientCredentialsRequestGrantTypeEnum]; /** * * @export * @interface ClientCredentialsResponse */ export interface ClientCredentialsResponse { /** * * @type {string} * @memberof ClientCredentialsResponse */ 'access_token': string; /** * * @type {string} * @memberof ClientCredentialsResponse */ 'token_type': string; /** * Token validity in seconds * @type {number} * @memberof ClientCredentialsResponse */ 'expires_in': number; } /** * The client application that initiated the request. * @export * @enum {string} */ export declare const ClientType: { readonly Web: "WEB"; readonly Vera: "VERA"; }; export type ClientType = typeof ClientType[keyof typeof ClientType]; /** * * @export * @enum {string} */ export declare const CommandFailureReasonCode: { readonly Unspecified: "UNSPECIFIED"; readonly UnknownAddress: "UNKNOWN_ADDRESS"; readonly UnknownSymbol: "UNKNOWN_SYMBOL"; readonly NoPosition: "NO_POSITION"; readonly InsufficientBalance: "INSUFFICIENT_BALANCE"; readonly DuplicateCommandHash: "DUPLICATE_COMMAND_HASH"; readonly InvalidLeverage: "INVALID_LEVERAGE"; readonly UnknownMarket: "UNKNOWN_MARKET"; readonly WithdrawZero: "WITHDRAW_ZERO"; readonly Unexpected: "UNEXPECTED"; }; export type CommandFailureReasonCode = typeof CommandFailureReasonCode[keyof typeof CommandFailureReasonCode]; /** * * @export * @interface ContractConfig */ export interface ContractConfig { /** * * @type {string} * @memberof ContractConfig */ 'AdminCap'?: string; /** * * @type {string} * @memberof ContractConfig */ 'Package'?: string; /** * * @type {string} * @memberof ContractConfig */ 'UpgradeCap'?: string; /** * * @type {{ [key: string]: RewardsPoolEntry | undefined; }} * @memberof ContractConfig */ 'RewardsPool'?: { [key: string]: RewardsPoolEntry | undefined; }; } /** * Contract configuration for the exchange. * @export * @interface ContractsConfig */ export interface ContractsConfig { /** * External Data Store Address * @type {string} * @memberof ContractsConfig */ 'edsId': string; /** * External Data Store Address * @type {string} * @memberof ContractsConfig */ 'idsId': string; /** * Network environment * @type {string} * @memberof ContractsConfig */ 'network': ContractsConfigNetworkEnum; /** * Base contract address * @type {string} * @memberof ContractsConfig */ 'baseContractAddress': string; /** * Current contract address * @type {string} * @memberof ContractsConfig */ 'currentContractAddress': string; /** * * @type {Operators} * @memberof ContractsConfig */ 'operators': Operators; } export declare const ContractsConfigNetworkEnum: { readonly Mainnet: "mainnet"; readonly Testnet: "testnet"; readonly Devnet: "devnet"; }; export type ContractsConfigNetworkEnum = typeof ContractsConfigNetworkEnum[keyof typeof ContractsConfigNetworkEnum]; /** * * @export * @interface CountryResponse */ export interface CountryResponse { /** * The country code in ISO 3166-1 alpha-2 format. * @type {string} * @memberof CountryResponse */ 'country': string; /** * Indicates if the country is blocked. * @type {boolean} * @memberof CountryResponse */ 'isBlockedCountry': boolean; } /** * * @export * @interface CreateOrderRequest */ export interface CreateOrderRequest { /** * * @type {CreateOrderRequestSignedFields} * @memberof CreateOrderRequest */ 'signedFields': CreateOrderRequestSignedFields; /** * The signature of the request, encoded from the signedFields * @type {string} * @memberof CreateOrderRequest */ 'signature': string; /** * The client-defined unique identifier of this order used for lookup. This should always be unique; however, the server will not gurantee this or impose any checks. * @type {string} * @memberof CreateOrderRequest */ 'clientOrderId'?: string; /** * * @type {OrderType} * @memberof CreateOrderRequest */ 'type': OrderType; /** * Is this order to only reduce a position? Default false * @type {boolean} * @memberof CreateOrderRequest */ 'reduceOnly': boolean; /** * If set to TRUE, the order can only be a maker order * @type {boolean} * @memberof CreateOrderRequest */ 'postOnly'?: boolean; /** * Omit or set to null for market orders; otherwise, choose a valid time-in-force value. GTT: Good Til Time IOC: Immediate Or Cancel FOK: Fill Or Kill * @type {OrderTimeInForce} * @memberof CreateOrderRequest */ 'timeInForce'?: OrderTimeInForce; /** * Trigger price in base e9 for stop orders. This should always be a number * @type {string} * @memberof CreateOrderRequest */ 'triggerPriceE9'?: string; /** * * @type {SelfTradePreventionType} * @memberof CreateOrderRequest */ 'selfTradePreventionType'?: SelfTradePreventionType; /** * * @type {OrderTwapConfig} * @memberof CreateOrderRequest */ 'twapConfig'?: OrderTwapConfig; } /** * * @export * @interface CreateOrderRequestSignedFields */ export interface CreateOrderRequestSignedFields { /** * The symbol of the perpetual for which to create the order * @type {string} * @memberof CreateOrderRequestSignedFields */ 'symbol': string; /** * The account address of the order. May be an account user is authorized for. * @type {string} * @memberof CreateOrderRequestSignedFields */ 'accountAddress': string; /** * The price in base e9 of the asset to be traded. Should always be a number * @type {string} * @memberof CreateOrderRequestSignedFields */ 'priceE9': string; /** * The quantity in base e9 of the asset to be traded. Should always be a number * @type {string} * @memberof CreateOrderRequestSignedFields */ 'quantityE9': string; /** * * @type {OrderSide} * @memberof CreateOrderRequestSignedFields */ 'side': OrderSide; /** * The leverage in base e9 of the order to be traded. Should always be a number * @type {string} * @memberof CreateOrderRequestSignedFields */ 'leverageE9': string; /** * Is this order isolated or cross margin. Note market must be set to the same mode. * @type {boolean} * @memberof CreateOrderRequestSignedFields */ 'isIsolated': boolean; /** * The random generated SALT. Should always be a number * @type {string} * @memberof CreateOrderRequestSignedFields */ 'salt': string; /** * the ID of the internal datastore for the target network * @type {string} * @memberof CreateOrderRequestSignedFields */ 'idsId': string; /** * The timestamp in millis at which order will expire. * @type {number} * @memberof CreateOrderRequestSignedFields */ 'expiresAtMillis': number; /** * The timestamp in millis at which the request was signed * @type {number} * @memberof CreateOrderRequestSignedFields */ 'signedAtMillis': number; } /** * * @export * @interface CreateOrderResponse */ export interface CreateOrderResponse { /** * The unique identifier of this order, to be used as a lookup key * @type {string} * @memberof CreateOrderResponse */ 'orderHash': string; } /** * * @export * @interface EpochConfigs */ export interface EpochConfigs { /** * The name of the campaign. * @type {string} * @memberof EpochConfigs */ 'campaignName': string; /** * Duration of the epoch in seconds. * @type {number} * @memberof EpochConfigs */ 'epochDuration': number; /** * Allocation of Sui token rewards in the epoch (e9 format). * @type {string} * @memberof EpochConfigs */ 'suiRewardsAllocationE9': string; /** * Allocation of Blue token rewards in the epoch (e9 format). * @type {string} * @memberof EpochConfigs */ 'blueRewardsAllocationE9': string; /** * Allocation of wal token rewards in the epoch (e9 format) * @type {string} * @memberof EpochConfigs */ 'walRewardsAllocationE9': string; /** * Interval number for the epoch. * @type {number} * @memberof EpochConfigs */ 'intervalNumber': number; /** * Epoch number for the epoch. * @type {number} * @memberof EpochConfigs */ 'epochNumber': number; /** * Object to add custom configurations for campaigns. * @type {{ [key: string]: any | undefined; }} * @memberof EpochConfigs */ 'config': { [key: string]: any | undefined; }; } /** * * @export * @interface EpochConfigsResponse */ export interface EpochConfigsResponse { /** * The maximum interval number available. * @type {number} * @memberof EpochConfigsResponse */ 'maxIntervalNumber': number; /** * The current interval number being queried. * @type {number} * @memberof EpochConfigsResponse */ 'intervalNumber': number; /** * List of epoch configs for different campaigns. * @type {Array} * @memberof EpochConfigsResponse */ 'data': Array; } /** * * @export * @interface EpochMetadata */ export interface EpochMetadata { /** * * @type {string} * @memberof EpochMetadata */ 'Status': EpochMetadataStatusEnum; /** * Name of the campaign. * @type {string} * @memberof EpochMetadata */ 'CampaignName': string; /** * Epoch Id of the epoch. * @type {number} * @memberof EpochMetadata */ 'EpochId': number; /** * Epoch number for the queried epoch. * @type {number} * @memberof EpochMetadata */ 'EpochNumber': number; /** * Time in seconds for campaign start date. * @type {number} * @memberof EpochMetadata */ 'StartDate': number; /** * Time in seconds for campaign end date. * @type {number} * @memberof EpochMetadata */ 'EndDate': number; } export declare const EpochMetadataStatusEnum: { readonly Active: "ACTIVE"; readonly NotStarted: "NOT_STARTED"; readonly Finalized: "FINALIZED"; readonly Cooldown: "COOLDOWN"; }; export type EpochMetadataStatusEnum = typeof EpochMetadataStatusEnum[keyof typeof EpochMetadataStatusEnum]; /** * * @export * @interface ExchangeInfoResponse */ export interface ExchangeInfoResponse { /** * List of assets available on the exchange. * @type {Array} * @memberof ExchangeInfoResponse */ 'assets': Array; /** * * @type {ContractsConfig} * @memberof ExchangeInfoResponse */ 'contractsConfig'?: ContractsConfig; /** * List of markets available on the exchange. * @type {Array} * @memberof ExchangeInfoResponse */ 'markets': Array; /** * Current gas fee set for subsidized trades (e9 format) * @type {string} * @memberof ExchangeInfoResponse */ 'tradingGasFeeE9': string; /** * Server time in milliseconds. * @type {number} * @memberof ExchangeInfoResponse */ 'serverTimeAtMillis': number; /** * Timezone of the exchange. * @type {string} * @memberof ExchangeInfoResponse */ 'timezone': string; } /** * * @export * @enum {string} */ export declare const FailedCommandType: { readonly PositionIsolatedMarginUpdate: "POSITION_ISOLATED_MARGIN_UPDATE"; readonly PositionLeverageUpdate: "POSITION_LEVERAGE_UPDATE"; readonly Withdraw: "WITHDRAW"; }; export type FailedCommandType = typeof FailedCommandType[keyof typeof FailedCommandType]; /** * Map of various fee-related configurations * @export * @interface FeeConfigs */ export interface FeeConfigs { /** * Earnings from referral perps fees * @type {string} * @memberof FeeConfigs */ 'referralPerpsFee'?: string; /** * Earnings from subaffiliate perps * @type {string} * @memberof FeeConfigs */ 'subaffiliatePerpsEarnings'?: string; /** * Earnings from spot LP fees * @type {string} * @memberof FeeConfigs */ 'spotLPFee'?: string; /** * Earnings from referral spot LP fees * @type {string} * @memberof FeeConfigs */ 'referralSpotLPFee'?: string; /** * Earnings from referral lending rewards * @type {string} * @memberof FeeConfigs */ 'referralLendingRewards'?: string; /** * Cashback from perps fees * @type {string} * @memberof FeeConfigs */ 'perpsFeeCashback'?: string; /** * Revenue share percentage for perps * @type {string} * @memberof FeeConfigs */ 'perpsRevShare'?: string; /** * Ember refferal share for an affiliate * @type {string} * @memberof FeeConfigs */ 'emberRefferalShare'?: string; /** * Ember revenue share for an affiliate * @type {string} * @memberof FeeConfigs */ 'emberRevShare'?: string; } /** * * @export * @interface FundingRateEntry */ export interface FundingRateEntry { /** * The market symbol. * @type {string} * @memberof FundingRateEntry */ 'symbol': string; /** * Timestamp of the funding time in milliseconds. * @type {number} * @memberof FundingRateEntry */ 'fundingTimeAtMillis': number; /** * Funding rate for the market address. * @type {string} * @memberof FundingRateEntry */ 'fundingRateE9': string; } /** * Time interval for the value history. * @export * @enum {string} */ export declare const GetAccountValueHistoryParamsInterval: { readonly _24h: "24h"; readonly _7d: "7d"; readonly _30d: "30d"; readonly _90d: "90d"; readonly All: "all"; }; export type GetAccountValueHistoryParamsInterval = typeof GetAccountValueHistoryParamsInterval[keyof typeof GetAccountValueHistoryParamsInterval]; /** * * @export * @interface GetAffiliateIntervalOverview200Response */ export interface GetAffiliateIntervalOverview200Response { /** * * @type {Array} * @memberof GetAffiliateIntervalOverview200Response */ 'data'?: Array; /** * Total number of records * @type {number} * @memberof GetAffiliateIntervalOverview200Response */ 'total'?: number; /** * The page size for pagination * @type {number} * @memberof GetAffiliateIntervalOverview200Response */ 'limit'?: number; /** * The page number for pagination * @type {number} * @memberof GetAffiliateIntervalOverview200Response */ 'page'?: number; } /** * * @export * @interface GetAffiliateLeaderDashboard200Response */ export interface GetAffiliateLeaderDashboard200Response { /** * * @type {Array} * @memberof GetAffiliateLeaderDashboard200Response */ 'data'?: Array; /** * Total number of records * @type {number} * @memberof GetAffiliateLeaderDashboard200Response */ 'total'?: number; /** * The page size for pagination * @type {number} * @memberof GetAffiliateLeaderDashboard200Response */ 'limit'?: number; /** * The page number for pagination * @type {number} * @memberof GetAffiliateLeaderDashboard200Response */ 'page'?: number; } /** * * @export * @interface GetAffiliateOverview200Response */ export interface GetAffiliateOverview200Response { /** * * @type {Array} * @memberof GetAffiliateOverview200Response */ 'data'?: Array; /** * Total number of records * @type {number} * @memberof GetAffiliateOverview200Response */ 'total'?: number; /** * The page size for pagination * @type {number} * @memberof GetAffiliateOverview200Response */ 'limit'?: number; /** * The page number for pagination * @type {number} * @memberof GetAffiliateOverview200Response */ 'page'?: number; } /** * * @export * @interface IntervalMetadata */ export interface IntervalMetadata { /** * * @type {string} * @memberof IntervalMetadata */ 'Status': IntervalMetadataStatusEnum; /** * Time in seconds for interval start date. * @type {number} * @memberof IntervalMetadata */ 'StartDate': number; /** * Time in seconds for interval end date. * @type {number} * @memberof IntervalMetadata */ 'EndDate': number; /** * Interval Id of the interval. * @type {number} * @memberof IntervalMetadata */ 'IntervalId': number; /** * Type of the interval. * @type {string} * @memberof IntervalMetadata */ 'IntervalType': string; } export declare const IntervalMetadataStatusEnum: { readonly Active: "ACTIVE"; readonly NotStarted: "NOT_STARTED"; readonly Finalized: "FINALIZED"; readonly Cooldown: "COOLDOWN"; }; export type IntervalMetadataStatusEnum = typeof IntervalMetadataStatusEnum[keyof typeof IntervalMetadataStatusEnum]; /** * * @export * @interface IntervalRewards */ export interface IntervalRewards { /** * User address for the rewards earned data. * @type {string} * @memberof IntervalRewards */ 'UserAddress': string; /** * * @type {string} * @memberof IntervalRewards */ 'Status': IntervalRewardsStatusEnum; /** * Total Blue token rewards earned in the interval (e9 format). * @type {string} * @memberof IntervalRewards */ 'BlueRewardsE9': string; /** * Total Sui token rewards earned in the interval (e9 format). * @type {string} * @memberof IntervalRewards */ 'SuiRewardsE9': string; /** * Total wal rewards earned in the interval (e9 format). * @type {string} * @memberof IntervalRewards */ 'WalRewardsE9': string; /** * Interval Id of the interval for the rewards earned data. * @type {number} * @memberof IntervalRewards */ 'IntervalNumber': number; } export declare const IntervalRewardsStatusEnum: { readonly Active: "ACTIVE"; readonly NotStarted: "NOT_STARTED"; readonly Finalized: "FINALIZED"; readonly Cooldown: "COOLDOWN"; }; export type IntervalRewardsStatusEnum = typeof IntervalRewardsStatusEnum[keyof typeof IntervalRewardsStatusEnum]; /** * Base64 encoded ISS details with index. * @export * @interface IssBase64Details */ export interface IssBase64Details { /** * Base64 encoded ISS details value. * @type {string} * @memberof IssBase64Details */ 'value': string; /** * Index modulo 4 for the ISS details. * @type {number} * @memberof IssBase64Details */ 'indexMod4': number; } /** * * @export * @enum {string} */ export declare const KlineInterval: { readonly _1m: "1m"; readonly _3m: "3m"; readonly _5m: "5m"; readonly _15m: "15m"; readonly _30m: "30m"; readonly _1h: "1h"; readonly _2h: "2h"; readonly _4h: "4h"; readonly _6h: "6h"; readonly _8h: "8h"; readonly _12h: "12h"; readonly _1d: "1d"; readonly _1w: "1w"; readonly _1Mo: "1Mo"; readonly Unspecified: "UNSPECIFIED"; }; export type KlineInterval = typeof KlineInterval[keyof typeof KlineInterval]; /** * * @export * @interface LeaderboardEntry */ export interface LeaderboardEntry { /** * Rank of the trader in the leaderboard. * @type {number} * @memberof LeaderboardEntry */ 'rank': number; /** * The address of the account. * @type {string} * @memberof LeaderboardEntry */ 'accountAddress': string; /** * Total account value of the trader in e9 format. * @type {string} * @memberof LeaderboardEntry */ 'accountValueE9': string; /** * Total profit and loss of the trader in e9 format. * @type {string} * @memberof LeaderboardEntry */ 'pnlE9': string; /** * Total trading volume of the trader in e9 format. * @type {string} * @memberof LeaderboardEntry */ 'volumeE9': string; } /** * * @export * @interface LeaderboardEntry1 */ export interface LeaderboardEntry1 { /** * Rank by lifetime points (1-based). * @type {number} * @memberof LeaderboardEntry1 */ 'rank': number; /** * Wallet address (may be partially masked in response). * @type {string} * @memberof LeaderboardEntry1 */ 'userAddress': string; /** * Lifetime Vera Points total. * @type {string} * @memberof LeaderboardEntry1 */ 'totalPoints': string; /** * * @type {string} * @memberof LeaderboardEntry1 */ 'currentTier': LeaderboardEntry1CurrentTierEnum; } export declare const LeaderboardEntry1CurrentTierEnum: { readonly None: "NONE"; readonly Silver: "SILVER"; readonly Gold: "GOLD"; readonly Platinum: "PLATINUM"; readonly Diamond: "DIAMOND"; }; export type LeaderboardEntry1CurrentTierEnum = typeof LeaderboardEntry1CurrentTierEnum[keyof typeof LeaderboardEntry1CurrentTierEnum]; /** * * @export * @enum {string} */ export declare const LeaderboardInterval: { readonly LeaderboardIntervalN1d: "1d"; readonly LeaderboardIntervalN7d: "7d"; readonly LeaderboardIntervalN30d: "30d"; readonly LeaderboardIntervalALLTIME: "ALL_TIME"; readonly LeaderboardIntervalUNSPECIFIED: "UNSPECIFIED"; }; export type LeaderboardInterval = typeof LeaderboardInterval[keyof typeof LeaderboardInterval]; /** * * @export * @interface LeaderboardResponse */ export interface LeaderboardResponse { /** * * @type {Array} * @memberof LeaderboardResponse */ 'data': Array; } /** * * @export * @interface LeaderboardResponse1 */ export interface LeaderboardResponse1 { /** * * @type {Array} * @memberof LeaderboardResponse1 */ 'entries': Array; /** * Total number of users (for pagination). * @type {number} * @memberof LeaderboardResponse1 */ 'total'?: number; } /** * User is expected to sign this payload and sends is signature in login api as header and payload itself in request body * @export * @interface LoginRequest */ export interface LoginRequest { /** * The address of the account. * @type {string} * @memberof LoginRequest */ 'accountAddress': string; /** * The timestamp in millis when the login was signed. * @type {number} * @memberof LoginRequest */ 'signedAtMillis': number; /** * The intended audience of the login request. * @type {string} * @memberof LoginRequest */ 'audience': string; } /** * * @export * @interface LoginResponse */ export interface LoginResponse { /** * * @type {string} * @memberof LoginResponse */ 'accessToken': string; /** * * @type {number} * @memberof LoginResponse */ 'accessTokenValidForSeconds': number; /** * * @type {string} * @memberof LoginResponse */ 'refreshToken': string; /** * * @type {number} * @memberof LoginResponse */ 'refreshTokenValidForSeconds': number; } /** * Margin type. * @export * @enum {string} */ export declare const MarginType: { readonly Cross: "CROSS"; readonly Isolated: "ISOLATED"; readonly Unspecified: "UNSPECIFIED"; }; export type MarginType = typeof MarginType[keyof typeof MarginType]; /** * * @export * @interface MarkAsClaimedRequest */ export interface MarkAsClaimedRequest { /** * The interval number * @type {number} * @memberof MarkAsClaimedRequest */ 'intervalNumber': number; /** * The campaign name * @type {string} * @memberof MarkAsClaimedRequest */ 'campaignName': MarkAsClaimedRequestCampaignNameEnum; /** * The transaction digest of the claim * @type {string} * @memberof MarkAsClaimedRequest */ 'txnDigest': string; } export declare const MarkAsClaimedRequestCampaignNameEnum: { readonly TradeAndEarn: "TRADE_AND_EARN"; readonly WalTradeAndEarn: "WAL_TRADE_AND_EARN"; readonly Affiliate: "AFFILIATE"; }; export type MarkAsClaimedRequestCampaignNameEnum = typeof MarkAsClaimedRequestCampaignNameEnum[keyof typeof MarkAsClaimedRequestCampaignNameEnum]; /** * * @export * @interface MarkAsClaimedResponse */ export interface MarkAsClaimedResponse { /** * Response message indicating if the claim was marked as claimed successfully * @type {string} * @memberof MarkAsClaimedResponse */ 'message': string; /** * Status of the claim * @type {string} * @memberof MarkAsClaimedResponse */ 'status': MarkAsClaimedResponseStatusEnum; } export declare const MarkAsClaimedResponseStatusEnum: { readonly Claimed: "CLAIMED"; readonly Claimable: "CLAIMABLE"; }; export type MarkAsClaimedResponseStatusEnum = typeof MarkAsClaimedResponseStatusEnum[keyof typeof MarkAsClaimedResponseStatusEnum]; /** * * @export * @interface MarkPriceUpdate */ export interface MarkPriceUpdate { /** * The symbol of the market. * @type {string} * @memberof MarkPriceUpdate */ 'symbol': string; /** * The price in scientific notation with 9 decimal places of precision. * @type {string} * @memberof MarkPriceUpdate */ 'priceE9': string; /** * * @type {string} * @memberof MarkPriceUpdate */ 'source': MarkPriceUpdateSourceEnum; /** * The timestamp of the price update. * @type {number} * @memberof MarkPriceUpdate */ 'updatedAtMillis': number; } export declare const MarkPriceUpdateSourceEnum: { readonly Mark: "Mark"; }; export type MarkPriceUpdateSourceEnum = typeof MarkPriceUpdateSourceEnum[keyof typeof MarkPriceUpdateSourceEnum]; /** * * @export * @interface Market */ export interface Market { /** * Symbol of the market. * @type {string} * @memberof Market */ 'symbol': string; /** * Market address. * @type {string} * @memberof Market */ 'marketAddress': string; /** * * @type {MarketStatus} * @memberof Market */ 'status': MarketStatus; /** * Base asset symbol. * @type {string} * @memberof Market */ 'baseAssetSymbol': string; /** * Base asset name. * @type {string} * @memberof Market */ 'baseAssetName': string; /** * Precision of the base asset. * @type {number} * @memberof Market */ 'baseAssetDecimals': number; /** * Step size for the quantity (e9 format). * @type {string} * @memberof Market */ 'stepSizeE9': string; /** * Price increment size (e9 format). * @type {string} * @memberof Market */ 'tickSizeE9': string; /** * Minimum order size (e9 format). * @type {string} * @memberof Market */ 'minOrderQuantityE9': string; /** * Maximum limit order size (e9 format). * @type {string} * @memberof Market */ 'maxLimitOrderQuantityE9': string; /** * Maximum market order size (e9 format). * @type {string} * @memberof Market */ 'maxMarketOrderQuantityE9': string; /** * Minimum order price (e9 format). * @type {string} * @memberof Market */ 'minOrderPriceE9': string; /** * Maximum order price (e9 format). * @type {string} * @memberof Market */ 'maxOrderPriceE9': string; /** * Maintenance margin ratio (MMR, e9 format). * @type {string} * @memberof Market */ 'maintenanceMarginRatioE9': string; /** * Initial margin ratio (IMR), e9 format). * @type {string} * @memberof Market */ 'initialMarginRatioE9': string; /** * Insurance pool ratio (e9 format). * @type {string} * @memberof Market */ 'insurancePoolRatioE9': string; /** * Default leverage (e9 format). * @type {string} * @memberof Market */ 'defaultLeverageE9': string; /** * Maximum notional value at current leverage. Index 0 is max notional value for leverage set to 1x, index 1 is for leverage 2x, etc... * @type {Array} * @memberof Market */ 'maxNotionalAtOpenE9': Array; /** * Minimum trade quantity allowed (e9 format). * @type {string} * @memberof Market */ 'minTradeQuantityE9': string; /** * Max trade quantity allowed (e9 format). * @type {string} * @memberof Market */ 'maxTradeQuantityE9': string; /** * Minimum trade price allowed (e9 format). * @type {string} * @memberof Market */ 'minTradePriceE9': string; /** * Maximum trade price allowed (e9 format). * @type {string} * @memberof Market */ 'maxTradePriceE9': string; /** * Maximum allowed funding rate (e9 format). * @type {string} * @memberof Market */ 'maxFundingRateE9': string; /** * Default maker fee (e9 format). * @type {string} * @memberof Market */ 'defaultMakerFeeE9': string; /** * Default taker fee (e9 format). * @type {string} * @memberof Market */ 'defaultTakerFeeE9': string; /** * Insurance pool address. * @type {string} * @memberof Market */ 'insurancePoolAddress': string; /** * Fee pool address. * @type {string} * @memberof Market */ 'feePoolAddress': string; /** * The time when trading will start/have started on the market. * @type {string} * @memberof Market */ 'tradingStartTimeAtMillis': string; /** * Maximum take bound for long positions (e9 format). * @type {string} * @memberof Market */ 'mtbLongE9': string; /** * Maximum take bound for short positions (e9 format). * @type {string} * @memberof Market */ 'mtbShortE9': string; /** * Delisting price (e9 format). * @type {string} * @memberof Market */ 'delistingPriceE9': string; /** * Indicates whether the market only allows isolated margin. * @type {boolean} * @memberof Market */ 'isolatedOnly': boolean; } /** * * @export * @enum {string} */ export declare const MarketDataStreamName: { readonly RecentTrade: "Recent_Trade"; readonly Ticker: "Ticker"; readonly TickerAll: "Ticker_All"; readonly DiffDepth10Ms: "Diff_Depth_10_ms"; readonly DiffDepth200Ms: "Diff_Depth_200_ms"; readonly DiffDepth500Ms: "Diff_Depth_500_ms"; readonly PartialDepth5: "Partial_Depth_5"; readonly PartialDepth10: "Partial_Depth_10"; readonly PartialDepth20: "Partial_Depth_20"; readonly OraclePrice: "Oracle_Price"; readonly MarkPrice: "Mark_Price"; readonly MarketPrice: "Market_Price"; readonly Candlestick1mLast: "Candlestick_1m_Last"; readonly Candlestick3mLast: "Candlestick_3m_Last"; readonly Candlestick5mLast: "Candlestick_5m_Last"; readonly Candlestick15mLast: "Candlestick_15m_Last"; readonly Candlestick30mLast: "Candlestick_30m_Last"; readonly Candlestick1hLast: "Candlestick_1h_Last"; readonly Candlestick2hLast: "Candlestick_2h_Last"; readonly Candlestick4hLast: "Candlestick_4h_Last"; readonly Candlestick6hLast: "Candlestick_6h_Last"; readonly Candlestick8hLast: "Candlestick_8h_Last"; readonly Candlestick12hLast: "Candlestick_12h_Last"; readonly Candlestick1dLast: "Candlestick_1d_Last"; readonly Candlestick1wLast: "Candlestick_1w_Last"; readonly Candlestick1MoLast: "Candlestick_1Mo_Last"; readonly Candlestick1mOracle: "Candlestick_1m_Oracle"; readonly Candlestick3mOracle: "Candlestick_3m_Oracle"; readonly Candlestick5mOracle: "Candlestick_5m_Oracle"; readonly Candlestick15mOracle: "Candlestick_15m_Oracle"; readonly Candlestick30mOracle: "Candlestick_30m_Oracle"; readonly Candlestick1hOracle: "Candlestick_1h_Oracle"; readonly Candlestick2hOracle: "Candlestick_2h_Oracle"; readonly Candlestick4hOracle: "Candlestick_4h_Oracle"; readonly Candlestick6hOracle: "Candlestick_6h_Oracle"; readonly Candlestick8hOracle: "Candlestick_8h_Oracle"; readonly Candlestick12hOracle: "Candlestick_12h_Oracle"; readonly Candlestick1dOracle: "Candlestick_1d_Oracle"; readonly Candlestick1wOracle: "Candlestick_1w_Oracle"; readonly Candlestick1MoOracle: "Candlestick_1Mo_Oracle"; readonly Candlestick1mMark: "Candlestick_1m_Mark"; readonly Candlestick3mMark: "Candlestick_3m_Mark"; readonly Candlestick5mMark: "Candlestick_5m_Mark"; readonly Candlestick15mMark: "Candlestick_15m_Mark"; readonly Candlestick30mMark: "Candlestick_30m_Mark"; readonly Candlestick1hMark: "Candlestick_1h_Mark"; readonly Candlestick2hMark: "Candlestick_2h_Mark"; readonly Candlestick4hMark: "Candlestick_4h_Mark"; readonly Candlestick6hMark: "Candlestick_6h_Mark"; readonly Candlestick8hMark: "Candlestick_8h_Mark"; readonly Candlestick12hMark: "Candlestick_12h_Mark"; readonly Candlestick1dMark: "Candlestick_1d_Mark"; readonly Candlestick1wMark: "Candlestick_1w_Mark"; readonly Candlestick1MoMark: "Candlestick_1Mo_Mark"; readonly Candlestick1mMarket: "Candlestick_1m_Market"; readonly Candlestick3mMarket: "Candlestick_3m_Market"; readonly Candlestick5mMarket: "Candlestick_5m_Market"; readonly Candlestick15mMarket: "Candlestick_15m_Market"; readonly Candlestick30mMarket: "Candlestick_30m_Market"; readonly Candlestick1hMarket: "Candlestick_1h_Market"; readonly Candlestick2hMarket: "Candlestick_2h_Market"; readonly Candlestick4hMarket: "Candlestick_4h_Market"; readonly Candlestick6hMarket: "Candlestick_6h_Market"; readonly Candlestick8hMarket: "Candlestick_8h_Market"; readonly Candlestick12hMarket: "Candlestick_12h_Market"; readonly Candlestick1dMarket: "Candlestick_1d_Market"; readonly Candlestick1wMarket: "Candlestick_1w_Market"; readonly Candlestick1MoMarket: "Candlestick_1Mo_Market"; }; export type MarketDataStreamName = typeof MarketDataStreamName[keyof typeof MarketDataStreamName]; /** * The type of event communicated in the WebSocket message. * @export * @enum {string} */ export declare const MarketEventType: { readonly RecentTradesUpdates: "RecentTradesUpdates"; readonly TickerUpdate: "TickerUpdate"; readonly TickerAllUpdate: "TickerAllUpdate"; readonly OraclePriceUpdate: "OraclePriceUpdate"; readonly MarkPriceUpdate: "MarkPriceUpdate"; readonly MarketPriceUpdate: "MarketPriceUpdate"; readonly CandlestickUpdate: "CandlestickUpdate"; readonly OrderbookDiffDepthUpdate: "OrderbookDiffDepthUpdate"; readonly OrderbookPartialDepthUpdate: "OrderbookPartialDepthUpdate"; }; export type MarketEventType = typeof MarketEventType[keyof typeof MarketEventType]; /** * * @export * @interface MarketPriceUpdate */ export interface MarketPriceUpdate { /** * The symbol of the market. * @type {string} * @memberof MarketPriceUpdate */ 'symbol': string; /** * The price in scientific notation with 9 decimal places of precision. * @type {string} * @memberof MarketPriceUpdate */ 'priceE9': string; /** * * @type {string} * @memberof MarketPriceUpdate */ 'source': MarketPriceUpdateSourceEnum; /** * The timestamp of the price update. * @type {number} * @memberof MarketPriceUpdate */ 'updatedAtMillis': number; } export declare const MarketPriceUpdateSourceEnum: { readonly Market: "Market"; }; export type MarketPriceUpdateSourceEnum = typeof MarketPriceUpdateSourceEnum[keyof typeof MarketPriceUpdateSourceEnum]; /** * * @export * @enum {string} */ export declare const MarketStatus: { readonly Active: "ACTIVE"; readonly Beta: "BETA"; readonly Maintenance: "MAINTENANCE"; readonly Delisted: "DELISTED"; readonly Unspecified: "UNSPECIFIED"; }; export type MarketStatus = typeof MarketStatus[keyof typeof MarketStatus]; /** * A market stream message containing an event type and a payload. The payload structure depends on the event type. * @export * @interface MarketStreamMessage */ export interface MarketStreamMessage { /** * * @type {MarketEventType} * @memberof MarketStreamMessage */ 'event': MarketEventType; /** * * @type {MarketStreamMessagePayload} * @memberof MarketStreamMessage */ 'payload': MarketStreamMessagePayload; } /** * @type MarketStreamMessagePayload * The payload of the message, which varies based on the event type. * @export */ export type MarketStreamMessagePayload = CandlestickUpdate | MarkPriceUpdate | MarketPriceUpdate | OraclePriceUpdate | OrderbookDiffDepthUpdate | OrderbookPartialDepthUpdate | RecentTradesUpdates | TickerAllUpdate | TickerUpdate; /** * Subscription message for market data streams. * @export * @interface MarketSubscriptionMessage */ export interface MarketSubscriptionMessage { /** * * @type {SubscriptionType} * @memberof MarketSubscriptionMessage */ 'method': SubscriptionType; /** * List of market data streams to subscribe or unsubscribe from. * @type {Array} * @memberof MarketSubscriptionMessage */ 'dataStreams': Array; } /** * Represents the type of market data stream and its parameters. * @export * @interface MarketSubscriptionStreams */ export interface MarketSubscriptionStreams { /** * The symbol of the market stream to subscribe to (Leave empty for TickerAll stream) * @type {string} * @memberof MarketSubscriptionStreams */ 'symbol': string; /** * * @type {Array} * @memberof MarketSubscriptionStreams */ 'streams': Array; } /** * * @export * @interface ModelError */ export interface ModelError { /** * A code representing the type of error. * @type {string} * @memberof ModelError */ 'errorCode'?: string; /** * A human-readable message describing the error. * @type {string} * @memberof ModelError */ 'message': string; /** * Additional structured details about the error. * @type {{ [key: string]: any | undefined; }} * @memberof ModelError */ 'details'?: { [key: string]: any | undefined; }; } /** * * @export * @interface OnboardAffiliateRequest */ export interface OnboardAffiliateRequest { /** * Referral code of the parent affiliate * @type {string} * @memberof OnboardAffiliateRequest */ 'parentReferralCode'?: string | null; /** * Name of the applicant * @type {string} * @memberof OnboardAffiliateRequest */ 'name': string; /** * Email address of the applicant * @type {string} * @memberof OnboardAffiliateRequest */ 'email': string; /** * * @type {OnboardAffiliateRequestSocialUserNames} * @memberof OnboardAffiliateRequest */ 'socialUserNames'?: OnboardAffiliateRequestSocialUserNames; } /** * Map of social media usernames * @export * @interface OnboardAffiliateRequestSocialUserNames */ export interface OnboardAffiliateRequestSocialUserNames { /** * Twitter username * @type {string} * @memberof OnboardAffiliateRequestSocialUserNames */ 'twitter'?: string; /** * Instagram username * @type {string} * @memberof OnboardAffiliateRequestSocialUserNames */ 'instagram'?: string; /** * YouTube channel name * @type {string} * @memberof OnboardAffiliateRequestSocialUserNames */ 'youtube'?: string; /** * TikTok username * @type {string} * @memberof OnboardAffiliateRequestSocialUserNames */ 'tiktok'?: string; } /** * * @export * @interface OnboardRefereeRequest */ export interface OnboardRefereeRequest { /** * Referral code of the parent affiliate * @type {string} * @memberof OnboardRefereeRequest */ 'code': string; } /** * * @export * @interface OpenIDConfigurationResponse */ export interface OpenIDConfigurationResponse { /** * * @type {string} * @memberof OpenIDConfigurationResponse */ 'issuer': string; /** * * @type {string} * @memberof OpenIDConfigurationResponse */ 'authorization_endpoint': string; /** * * @type {string} * @memberof OpenIDConfigurationResponse */ 'jwks_uri': string; /** * * @type {string} * @memberof OpenIDConfigurationResponse */ 'token_endpoint': string; /** * * @type {Array} * @memberof OpenIDConfigurationResponse */ 'response_types_supported': Array; /** * * @type {Array} * @memberof OpenIDConfigurationResponse */ 'id_token_signing_alg_values_supported': Array; /** * * @type {Array} * @memberof OpenIDConfigurationResponse */ 'subject_types_supported': Array; /** * * @type {Array} * @memberof OpenIDConfigurationResponse */ 'scopes_supported': Array; } /** * * @export * @interface OpenOrderResponse */ export interface OpenOrderResponse { /** * The Order Hash, which is the default way to uniquely identify an order in the system * @type {string} * @memberof OpenOrderResponse */ 'orderHash': string; /** * The Client Order ID, which is used a unique identifier for an order, provided by the client, in case of proprietary order management systems * @type {string} * @memberof OpenOrderResponse */ 'clientOrderId'?: string; /** * The market symbol * @type {string} * @memberof OpenOrderResponse */ 'symbol': string; /** * The account address of the order. May be an account user is authorized for. * @type {string} * @memberof OpenOrderResponse */ 'accountAddress': string; /** * The signer address of the order. May be an account user is authorized for. * @type {string} * @memberof OpenOrderResponse */ 'signerAddress': string; /** * The price in base e9 of the asset to be traded. Should always be a number * @type {string} * @memberof OpenOrderResponse */ 'priceE9': string; /** * The quantity in base e9 of the asset to be traded. Should always be a number * @type {string} * @memberof OpenOrderResponse */ 'quantityE9': string; /** * * @type {OrderSide} * @memberof OpenOrderResponse */ 'side': OrderSide; /** * The leverage in base e9 of the order to be traded. Should always be a number * @type {string} * @memberof OpenOrderResponse */ 'leverageE9': string; /** * Is this order isolated or cross margin. Note market must be set to the same mode. * @type {boolean} * @memberof OpenOrderResponse */ 'isIsolated': boolean; /** * The random generated SALT. Should always be a number * @type {string} * @memberof OpenOrderResponse */ 'salt': string; /** * Unix timestamp in millis at which order will expire. Defaults to 1 month for LIMIT orders if not provided * @type {number} * @memberof OpenOrderResponse */ 'expiresAtMillis': number; /** * The timestamp in millis at which the request was signed * @type {number} * @memberof OpenOrderResponse */ 'signedAtMillis': number; /** * * @type {OrderType} * @memberof OpenOrderResponse */ 'type': OrderType; /** * Is this order to only reduce a position? Default false * @type {boolean} * @memberof OpenOrderResponse */ 'reduceOnly': boolean; /** * If set to TRUE, the order can only be a maker order * @type {boolean} * @memberof OpenOrderResponse */ 'postOnly': boolean; /** * * @type {OrderTimeInForce} * @memberof OpenOrderResponse */ 'timeInForce': OrderTimeInForce; /** * Trigger price in base e9 for stop orders. This should always be a number * @type {string} * @memberof OpenOrderResponse */ 'triggerPriceE9'?: string; /** * The quantity in base e9 of the asset currently filled. This should always be a number * @type {string} * @memberof OpenOrderResponse */ 'filledQuantityE9': string; /** * * @type {OrderStatus} * @memberof OpenOrderResponse */ 'status': OrderStatus; /** * * @type {SelfTradePreventionType} * @memberof OpenOrderResponse */ 'selfTradePreventionType': SelfTradePreventionType; /** * * @type {OrderTwapConfig} * @memberof OpenOrderResponse */ 'twapConfig'?: OrderTwapConfig; /** * The timestamp in millis when the order was opened * @type {number} * @memberof OpenOrderResponse */ 'orderTimeAtMillis': number; /** * The timestamp in millis that this order was last updated (including status updates) * @type {number} * @memberof OpenOrderResponse */ 'updatedAtMillis': number; } /** * * @export * @interface Operators */ export interface Operators { /** * Admin operator address * @type {string} * @memberof Operators */ 'admin': string; /** * General operator address; AKA Guardian * @type {string} * @memberof Operators * @deprecated */ 'operator': string; /** * Sequencer operator address * @type {string} * @memberof Operators */ 'sequencer': string; /** * Funding operator address * @type {string} * @memberof Operators * @deprecated */ 'funding': string; /** * Fee operator address * @type {string} * @memberof Operators * @deprecated */ 'fee': string; } /** * * @export * @interface OraclePriceUpdate */ export interface OraclePriceUpdate { /** * The symbol of the market. * @type {string} * @memberof OraclePriceUpdate */ 'symbol': string; /** * The price in scientific notation with 9 decimal places of precision. * @type {string} * @memberof OraclePriceUpdate */ 'priceE9': string; /** * * @type {string} * @memberof OraclePriceUpdate */ 'source': OraclePriceUpdateSourceEnum; /** * The timestamp of the price update. * @type {number} * @memberof OraclePriceUpdate */ 'updatedAtMillis': number; } export declare const OraclePriceUpdateSourceEnum: { readonly Oracle: "Oracle"; }; export type OraclePriceUpdateSourceEnum = typeof OraclePriceUpdateSourceEnum[keyof typeof OraclePriceUpdateSourceEnum]; /** * The reason for an order cancellation. * @export * @enum {string} */ export declare const OrderCancelReason: { readonly Unspecified: "UNSPECIFIED"; readonly InsufficientMargin: "INSUFFICIENT_MARGIN"; readonly DuplicateOrder: "DUPLICATE_ORDER"; readonly PostOnlyWouldTrade: "POST_ONLY_WOULD_TRADE"; readonly InvalidSymbol: "INVALID_SYMBOL"; readonly SignedAtTooOld: "SIGNED_AT_TOO_OLD"; readonly OrderExpired: "ORDER_EXPIRED"; readonly InvalidLeverage: "INVALID_LEVERAGE"; readonly InvalidInput: "INVALID_INPUT"; readonly PriceOutOfBound: "PRICE_OUT_OF_BOUND"; readonly QuantityOutOfBound: "QUANTITY_OUT_OF_BOUND"; readonly PriceOutOfTickSize: "PRICE_OUT_OF_TICK_SIZE"; readonly QuantityOutOfStepSize: "QUANTITY_OUT_OF_STEP_SIZE"; readonly ReduceOnlyWouldOpen: "REDUCE_ONLY_WOULD_OPEN"; readonly TooManyOpenOrdersOnMarket: "TOO_MANY_OPEN_ORDERS_ON_MARKET"; readonly UserCancelled: "USER_CANCELLED"; readonly UserCancelledAllOnMarket: "USER_CANCELLED_ALL_ON_MARKET"; readonly SelfTradePrevention: "SELF_TRADE_PREVENTION"; readonly LeverageUpdate: "LEVERAGE_UPDATE"; readonly AccountNotFound: "ACCOUNT_NOT_FOUND"; readonly MarketNotTrading: "MARKET_NOT_TRADING"; readonly InsufficientLiquidity: "INSUFFICIENT_LIQUIDITY"; readonly PositionNotFound: "POSITION_NOT_FOUND"; readonly LiquidationOutOfOrder: "LIQUIDATION_OUT_OF_ORDER"; readonly AccountNotLiquidatable: "ACCOUNT_NOT_LIQUIDATABLE"; readonly OrderNotReducingPosition: "ORDER_NOT_REDUCING_POSITION"; readonly UserCancelledAllStandbyOnMarket: "USER_CANCELLED_ALL_STANDBY_ON_MARKET"; readonly PositionExceedsMaxOpenInterest: "POSITION_EXCEEDS_MAX_OPEN_INTEREST"; readonly AccountDeauthorized: "ACCOUNT_DEAUTHORIZED"; readonly TooManyMatches: "TOO_MANY_MATCHES"; readonly MarginCall: "MARGIN_CALL"; readonly InsufficientBalance: "INSUFFICIENT_BALANCE"; readonly TradeQuantityOutOfBound: "TRADE_QUANTITY_OUT_OF_BOUND"; readonly MarketTakeBoundBreached: "MARKET_TAKE_BOUND_BREACHED"; readonly OrdersExceedMaxOpenInterest: "ORDERS_EXCEED_MAX_OPEN_INTEREST"; }; export type OrderCancelReason = typeof OrderCancelReason[keyof typeof OrderCancelReason]; /** * The reason for failure to cancel an order. * @export * @enum {string} */ export declare const OrderCancellationFailureReason: { readonly OrderNotFound: "ORDER_NOT_FOUND"; readonly MarketNotFound: "MARKET_NOT_FOUND"; readonly AccountNotFound: "ACCOUNT_NOT_FOUND"; readonly NoOpenOrdersOnMarket: "NO_OPEN_ORDERS_ON_MARKET"; readonly NoFailure: "NO_FAILURE"; readonly Unspecified: "UNSPECIFIED"; }; export type OrderCancellationFailureReason = typeof OrderCancellationFailureReason[keyof typeof OrderCancellationFailureReason]; /** * Details of an order cancellation. * @export * @interface OrderCancellationUpdate */ export interface OrderCancellationUpdate { /** * The unique hash of the order. * @type {string} * @memberof OrderCancellationUpdate */ 'orderHash': string; /** * The client-provided order ID. * @type {string} * @memberof OrderCancellationUpdate */ 'clientOrderId'?: string; /** * The symbol of the market. * @type {string} * @memberof OrderCancellationUpdate */ 'symbol': string; /** * The address of the account. * @type {string} * @memberof OrderCancellationUpdate */ 'accountAddress': string; /** * The timestamp of the order creation in milliseconds. * @type {number} * @memberof OrderCancellationUpdate */ 'createdAtMillis': number; /** * * @type {OrderCancelReason} * @memberof OrderCancellationUpdate */ 'cancellationReason': OrderCancelReason; /** * * @type {OrderCancellationFailureReason} * @memberof OrderCancellationUpdate */ 'failureToCancelReason'?: OrderCancellationFailureReason; /** * The remaining quantity of the order. * @type {string} * @memberof OrderCancellationUpdate */ 'remainingQuantityE9': string; } /** * Side of the order * @export * @enum {string} */ export declare const OrderSide: { readonly Long: "LONG"; readonly Short: "SHORT"; readonly Unspecified: "UNSPECIFIED"; }; export type OrderSide = typeof OrderSide[keyof typeof OrderSide]; /** * The current status of the order. * @export * @enum {string} */ export declare const OrderStatus: { readonly Standby: "STANDBY"; readonly Open: "OPEN"; readonly PartiallyFilledOpen: "PARTIALLY_FILLED_OPEN"; readonly PartiallyFilledCanceled: "PARTIALLY_FILLED_CANCELED"; readonly Filled: "FILLED"; readonly Cancelled: "CANCELLED"; readonly Expired: "EXPIRED"; readonly PartiallyFilledExpired: "PARTIALLY_FILLED_EXPIRED"; readonly Unspecified: "UNSPECIFIED"; }; export type OrderStatus = typeof OrderStatus[keyof typeof OrderStatus]; /** * The time-in-force policy for the order. By default, all orders are GTT. UNSPECIFIED is set to default. GTT: Good Til Time IOC: Immediate Or Cancel FOK: Fill Or Kill * @export * @enum {string} */ export declare const OrderTimeInForce: { readonly Gtt: "GTT"; readonly Ioc: "IOC"; readonly Fok: "FOK"; readonly Unspecified: "UNSPECIFIED"; }; export type OrderTimeInForce = typeof OrderTimeInForce[keyof typeof OrderTimeInForce]; /** * Configuration for Time-Weighted Average Price orders * @export * @interface OrderTwapConfig */ export interface OrderTwapConfig { /** * Number of sub-orders to split the total quantity into * @type {string} * @memberof OrderTwapConfig */ 'subOrdersCount'?: string; /** * Total time in minutes over which to execute the TWAP order * @type {string} * @memberof OrderTwapConfig */ 'runningTimeInMinutes'?: string; } /** * The type of order. (BANKRUPTCY_LIQUIDATION is deprecated) * @export * @enum {string} */ export declare const OrderType: { readonly Limit: "LIMIT"; readonly Market: "MARKET"; readonly StopLimit: "STOP_LIMIT"; readonly StopMarket: "STOP_MARKET"; readonly Liquidation: "LIQUIDATION"; readonly StopLossMarket: "STOP_LOSS_MARKET"; readonly TakeProfitMarket: "TAKE_PROFIT_MARKET"; readonly StopLossLimit: "STOP_LOSS_LIMIT"; readonly TakeProfitLimit: "TAKE_PROFIT_LIMIT"; readonly BankruptcyLiquidation: "BANKRUPTCY_LIQUIDATION"; readonly TimeWeightedAveragePrice: "TIME_WEIGHTED_AVERAGE_PRICE"; readonly Adl: "ADL"; readonly Unspecified: "UNSPECIFIED"; }; export type OrderType = typeof OrderType[keyof typeof OrderType]; /** * * @export * @interface OrderbookDepthResponse */ export interface OrderbookDepthResponse { /** * Market symbol. * @type {string} * @memberof OrderbookDepthResponse */ 'symbol': string; /** * Count indicating the number of changes in orderbook state. * @type {number} * @memberof OrderbookDepthResponse */ 'lastUpdateId': number; /** * Timestamp at which the last change in orderbook state took place, in milliseconds. * @type {number} * @memberof OrderbookDepthResponse */ 'updatedAtMillis': number; /** * The time at which the orderbook server sent the response, in milliseconds. * @type {number} * @memberof OrderbookDepthResponse */ 'responseSentAtMillis': number; /** * The best bid price on orderbook at the moment (e9 format). * @type {string} * @memberof OrderbookDepthResponse */ 'bestBidPriceE9': string; /** * The best bid quantity on orderbook at the moment (e9 format). * @type {string} * @memberof OrderbookDepthResponse */ 'bestBidQuantityE9': string; /** * The best ask price on orderbook at the moment (e9 format). * @type {string} * @memberof OrderbookDepthResponse */ 'bestAskPriceE9': string; /** * The best ask quantity on orderbook at the moment (e9 format). * @type {string} * @memberof OrderbookDepthResponse */ 'bestAskQuantityE9': string; /** * Bids to be filled. Index 0 is price, index 1 is quantity at price bin. Prices are in e9 format. * @type {Array>} * @memberof OrderbookDepthResponse */ 'bidsE9': Array>; /** * Asks to be filled. Index 0 is price, index 1 is quantity at price bin. Prices are in e9 format. * @type {Array>} * @memberof OrderbookDepthResponse */ 'asksE9': Array>; } /** * * @export * @interface OrderbookDiffDepthUpdate */ export interface OrderbookDiffDepthUpdate { /** * The timestamp of the orderbook update. * @type {number} * @memberof OrderbookDiffDepthUpdate */ 'updatedAtMillis': number; /** * The symbol of the market for the orderbook update. * @type {string} * @memberof OrderbookDiffDepthUpdate */ 'symbol': string; /** * * @type {Array>} * @memberof OrderbookDiffDepthUpdate */ 'bidsE9': Array>; /** * * @type {Array>} * @memberof OrderbookDiffDepthUpdate */ 'asksE9': Array>; /** * The ID of the first update in this batch. * @type {number} * @memberof OrderbookDiffDepthUpdate */ 'firstUpdateId': number; /** * The ID of the last update in this batch. * @type {number} * @memberof OrderbookDiffDepthUpdate */ 'lastUpdateId': number; } /** * * @export * @interface OrderbookPartialDepthUpdate */ export interface OrderbookPartialDepthUpdate { /** * The timestamp of the partial depth update. * @type {number} * @memberof OrderbookPartialDepthUpdate */ 'updatedAtMillis': number; /** * The symbol of the market for the partial depth update. * @type {string} * @memberof OrderbookPartialDepthUpdate */ 'symbol': string; /** * * @type {Array>} * @memberof OrderbookPartialDepthUpdate */ 'bidsE9': Array>; /** * * @type {Array>} * @memberof OrderbookPartialDepthUpdate */ 'asksE9': Array>; /** * The unique identifier for the orderbook update. * @type {number} * @memberof OrderbookPartialDepthUpdate */ 'orderbookUpdateId': number; /** * The depth level of the orderbook snapshot. * @type {string} * @memberof OrderbookPartialDepthUpdate */ 'depthLevel': OrderbookPartialDepthUpdateDepthLevelEnum; } export declare const OrderbookPartialDepthUpdateDepthLevelEnum: { readonly _5: "5"; readonly _10: "10"; readonly _20: "20"; }; export type OrderbookPartialDepthUpdateDepthLevelEnum = typeof OrderbookPartialDepthUpdateDepthLevelEnum[keyof typeof OrderbookPartialDepthUpdateDepthLevelEnum]; /** * * @export * @interface Position */ export interface Position { /** * Market address. * @type {string} * @memberof Position */ 'symbol': string; /** * Average entry price determined by a simple average of all entry prices resulting in this position size (e9 format). * @type {string} * @memberof Position */ 'avgEntryPriceE9': string; /** * Isolated position leverage (e9 format). * @type {string} * @memberof Position */ 'clientSetLeverageE9': string; /** * Liquidation price (e9 format). * @type {string} * @memberof Position */ 'liquidationPriceE9': string; /** * Mark price (e9 format). * @type {string} * @memberof Position */ 'markPriceE9': string; /** * Notional value (e9 format). * @type {string} * @memberof Position */ 'notionalValueE9': string; /** * Position size (e9 format). * @type {string} * @memberof Position */ 'sizeE9': string; /** * Unrealized profit (e9 format). * @type {string} * @memberof Position */ 'unrealizedPnlE9': string; /** * * @type {PositionSide} * @memberof Position */ 'side': PositionSide; /** * Initial margin required with current mark price (e9 format). * @type {string} * @memberof Position */ 'marginRequiredE9': string; /** * Maintenance margin required with current mark price (e9 format). * @type {string} * @memberof Position */ 'maintenanceMarginE9': string; /** * If the position is isolated. * @type {boolean} * @memberof Position */ 'isIsolated': boolean; /** * Margin value present if margin type is isolated (e9 format). * @type {string} * @memberof Position */ 'isolatedMarginE9': string; /** * Last update time. * @type {number} * @memberof Position */ 'updatedAtMillis': number; /** * Total funding rate payment (e9 format). * @type {string} * @memberof Position */ 'fundingRatePaymentAllTimeE9': string; /** * Funding rate payment since last position change (e9 format). * @type {string} * @memberof Position */ 'fundingRatePaymentSinceChangeE9': string; /** * Funding rate payment since position opened (e9 format). * @type {string} * @memberof Position */ 'fundingRatePaymentSinceOpenedE9': string; } /** * The side of the position, either long or short * @export * @enum {string} */ export declare const PositionSide: { readonly Long: "LONG"; readonly Short: "SHORT"; readonly Unspecified: "UNSPECIFIED"; }; export type PositionSide = typeof PositionSide[keyof typeof PositionSide]; /** * The generated zero-knowledge proof points. * @export * @interface ProofPoints */ export interface ProofPoints { /** * Point A of the proof. * @type {Array} * @memberof ProofPoints */ 'a': Array; /** * Point B of the proof. * @type {Array>} * @memberof ProofPoints */ 'b': Array>; /** * Point C of the proof. * @type {Array} * @memberof ProofPoints */ 'c': Array; } /** * * @export * @interface RecentTradesUpdates */ export interface RecentTradesUpdates { /** * * @type {Array} * @memberof RecentTradesUpdates */ 'trades': Array; } /** * * @export * @interface RefereeOnboardResponse */ export interface RefereeOnboardResponse { /** * Response message indicating if the referral code exists * @type {string} * @memberof RefereeOnboardResponse */ 'message': string; } /** * * @export * @interface RefreshTokenRequest */ export interface RefreshTokenRequest { /** * * @type {string} * @memberof RefreshTokenRequest */ 'refreshToken': string; } /** * * @export * @interface RefreshTokenResponse */ export interface RefreshTokenResponse { /** * * @type {string} * @memberof RefreshTokenResponse */ 'accessToken': string; /** * * @type {number} * @memberof RefreshTokenResponse */ 'accessTokenValidForSeconds': number; /** * * @type {string} * @memberof RefreshTokenResponse */ 'refreshToken': string; /** * * @type {number} * @memberof RefreshTokenResponse */ 'refreshTokenValidForSeconds': number; } /** * * @export * @interface RewardsPoolEntry */ export interface RewardsPoolEntry { /** * * @type {string} * @memberof RewardsPoolEntry */ 'id'?: string; /** * * @type {string} * @memberof RewardsPoolEntry */ 'coin'?: string; } /** * * @export * @interface RewardsSummary */ export interface RewardsSummary { /** * User address for the rewards earned data. * @type {string} * @memberof RewardsSummary */ 'UserAddress': string; /** * Total Blue token rewards earned by the user (e9 format). * @type {string} * @memberof RewardsSummary */ 'BlueRewardsE9': string; /** * Total Sui token rewards earned by the user (e9 format). * @type {string} * @memberof RewardsSummary */ 'SuiRewardsE9': string; /** * Total wal rewards earned by the user (e9 format). * @type {string} * @memberof RewardsSummary */ 'WalRewardsE9': string; } /** * The strategy used to resolve self trades. TAKER: On a self trade, the taker order will be cancelled MAKER: On a self trade, the maker order will be cancelled BOTH: On a self trade, both the taker and the maker order will be cancelled UNSPECIFIED: set to default value * @export * @enum {string} */ export declare const SelfTradePreventionType: { readonly Taker: "TAKER"; readonly Maker: "MAKER"; readonly Both: "BOTH"; readonly Unspecified: "UNSPECIFIED"; }; export type SelfTradePreventionType = typeof SelfTradePreventionType[keyof typeof SelfTradePreventionType]; /** * * @export * @interface SessionResponse */ export interface SessionResponse { /** * User\'s wallet address. * @type {string} * @memberof SessionResponse */ 'userAddress': string; /** * UTC date of the recorded session. * @type {string} * @memberof SessionResponse */ 'sessionDate': string; } /** * * @export * @interface SigPayload */ export interface SigPayload { /** * Target address for the claim. * @type {string} * @memberof SigPayload */ 'target': string; /** * Receiver address for the claim. * @type {string} * @memberof SigPayload */ 'receiver': string; /** * Amount to be claimed. * @type {string} * @memberof SigPayload */ 'amount': string; /** * Expiry timestamp for the claim. * @type {string} * @memberof SigPayload */ 'expiry': string; /** * Nonce for the claim. * @type {string} * @memberof SigPayload */ 'nonce': string; /** * Type identifier for the claim. * @type {number} * @memberof SigPayload */ 'type': number; } /** * The order in which results should be sorted. * @export * @enum {string} */ export declare const SortOrder: { readonly Asc: "ASC"; readonly Desc: "DESC"; readonly Unspecified: "UNSPECIFIED"; }; export type SortOrder = typeof SortOrder[keyof typeof SortOrder]; /** * * @export * @interface SponsorTxRequest */ export interface SponsorTxRequest { /** * Base64 encoded transaction bytes to be sponsored. To create txBytes: 1. Create a TransactionBlock with move calls (e.g., deposit_to_asset_bank) 2. Serialize the TransactionBlock to bytes using BCS (Binary Canonical Serialization) 3. Encode the bytes to base64 string Reference implementation: https://github.com/fireflyprotocol/library-sui/blob/1412fff4d4fe7cf6b7ec04d700e777628c57c70a/src/classes/SuiBlocks.ts#L220 * @type {string} * @memberof SponsorTxRequest */ 'txBytes': string; } /** * * @export * @interface SponsorTxResponse */ export interface SponsorTxResponse { /** * Base64 encoded sponsored transaction bytes * @type {string} * @memberof SponsorTxResponse */ 'txBytes': string; /** * Transaction digest * @type {string} * @memberof SponsorTxResponse */ 'txDigest': string; /** * Transaction signature * @type {string} * @memberof SponsorTxResponse */ 'signature': string; /** * Transaction expiration time in milliseconds since Unix epoch * @type {number} * @memberof SponsorTxResponse */ 'expireAtTime': number; } /** * * @export * @interface StatsAllTimeResponse */ export interface StatsAllTimeResponse { /** * Timestamp in milliseconds when the statistics period starts. * @type {number} * @memberof StatsAllTimeResponse */ 'startTimeAtMillis': number; /** * Total value locked in the legacy exchange in e9 format. * @type {string} * @memberof StatsAllTimeResponse */ 'legacyTvlE9': string; /** * Total value locked in the exchange in e9 format. * @type {string} * @memberof StatsAllTimeResponse */ 'tvlE9': string; /** * Total quote asset volume in the legacy exchange in e9 format. * @type {string} * @memberof StatsAllTimeResponse */ 'totalLegacyQuoteAssetVolumeE9': string; /** * Total quote asset volume in the exchange in e9 format. * @type {string} * @memberof StatsAllTimeResponse */ 'totalQuoteAssetVolumeE9': string; /** * Timestamp in milliseconds when the statistics period ends. * @type {number} * @memberof StatsAllTimeResponse */ 'endTimeAtMillis': number; } /** * * @export * @interface StatsEntry */ export interface StatsEntry { /** * Timestamp in milliseconds when the statistics period starts. * @type {number} * @memberof StatsEntry */ 'startTimeAtMillis': number; /** * Total value locked in the legacy exchange in e9 format. * @type {string} * @memberof StatsEntry */ 'legacyTvlE9': string; /** * Total value locked in the exchange in e9 format. * @type {string} * @memberof StatsEntry */ 'tvlE9': string; /** * Total quote asset volume in the legacy exchange in e9 format. * @type {string} * @memberof StatsEntry */ 'totalLegacyQuoteAssetVolumeE9': string; /** * Total quote asset volume in the exchange in e9 format. * @type {string} * @memberof StatsEntry */ 'totalQuoteAssetVolumeE9': string; /** * Timestamp in milliseconds when the statistics period ends. * @type {number} * @memberof StatsEntry */ 'endTimeAtMillis': number; } /** * * @export * @enum {string} */ export declare const StatsInterval: { readonly _1d: "1d"; readonly _1w: "1w"; readonly _1Mo: "1Mo"; readonly Unspecified: "UNSPECIFIED"; }; export type StatsInterval = typeof StatsInterval[keyof typeof StatsInterval]; /** * * @export * @interface StatsResponse */ export interface StatsResponse { /** * * @type {Array} * @memberof StatsResponse */ 'data': Array; } /** * Response message indicating the success or failure of a subscription operation. * @export * @interface SubscriptionResponseMessage */ export interface SubscriptionResponseMessage { /** * Indicates if the subscription operation was successful. * @type {boolean} * @memberof SubscriptionResponseMessage */ 'success': boolean; /** * Additional information about the subscription operation. * @type {string} * @memberof SubscriptionResponseMessage */ 'message': string; } /** * Indicates the type of subscription action. * @export * @enum {string} */ export declare const SubscriptionType: { readonly Subscribe: "Subscribe"; readonly Unsubscribe: "Unsubscribe"; }; export type SubscriptionType = typeof SubscriptionType[keyof typeof SubscriptionType]; /** * * @export * @interface SwapClaimRequest */ export interface SwapClaimRequest { /** * On-chain transaction hash of the swap. * @type {string} * @memberof SwapClaimRequest */ 'txHash': string; } /** * * @export * @interface SwapClaimResponse */ export interface SwapClaimResponse { /** * The claimed transaction hash. * @type {string} * @memberof SwapClaimResponse */ 'txHash': string; /** * Claim status. * @type {string} * @memberof SwapClaimResponse */ 'status': SwapClaimResponseStatusEnum; } export declare const SwapClaimResponseStatusEnum: { readonly Claimed: "claimed"; }; export type SwapClaimResponseStatusEnum = typeof SwapClaimResponseStatusEnum[keyof typeof SwapClaimResponseStatusEnum]; /** * * @export * @interface TickerAllUpdate */ export interface TickerAllUpdate { /** * Array of detailed market ticker information for all markets. * @type {Array} * @memberof TickerAllUpdate */ 'tickerAll': Array; } /** * * @export * @interface TickerResponse */ export interface TickerResponse { /** * Market symbol. * @type {string} * @memberof TickerResponse */ 'symbol': string; /** * Last trade quantity (e9 format). * @type {string} * @memberof TickerResponse */ 'lastQuantityE9': string; /** * Last trade time in milliseconds. * @type {number} * @memberof TickerResponse */ 'lastTimeAtMillis': number; /** * Last trade price (e9 format). * @type {string} * @memberof TickerResponse */ 'lastPriceE9': string; /** * Funding rate value (e9 format). * @type {string} * @memberof TickerResponse */ 'lastFundingRateE9': string; /** * Time in milliseconds of next funding rate update. * @type {number} * @memberof TickerResponse */ 'nextFundingTimeAtMillis': number; /** * 8 hr average funding rate (e9 format). * @type {string} * @memberof TickerResponse */ 'avgFundingRate8hrE9': string; /** * Oracle price of the asset (e9 format). * @type {string} * @memberof TickerResponse */ 'oraclePriceE9': string; /** * Direction of oracle price computed by comparing current oracle price to last oracle price. 0 = no change, -1 = negative trend (current < last), 1 positive trend (current > last). * @type {number} * @memberof TickerResponse */ 'oraclePriceDirection': number; /** * Mark price on the exchange (e9 format). * @type {string} * @memberof TickerResponse */ 'markPriceE9': string; /** * Direction of mark price computed by comparing current mark price to last mark price. 0 = no change, -1 = negative trend (current < last), 1 positive trend (current > last). * @type {number} * @memberof TickerResponse */ 'markPriceDirection': number; /** * Simple average of bestBid and bestAsk. lastPrice if either is not present (e9 format). * @type {string} * @memberof TickerResponse */ 'marketPriceE9': string; /** * Direction of market price computed by comparing current market price to last market price. 0 = no change, -1 = negative trend (current < last), 1 positive trend (current > last). * @type {number} * @memberof TickerResponse */ 'marketPriceDirection': number; /** * Best bid price (e9 format). * @type {string} * @memberof TickerResponse */ 'bestBidPriceE9': string; /** * Best bid quantity (e9 format). * @type {string} * @memberof TickerResponse */ 'bestBidQuantityE9': string; /** * Best ask price (e9 format). * @type {string} * @memberof TickerResponse */ 'bestAskPriceE9': string; /** * Best ask quantity (e9 format). * @type {string} * @memberof TickerResponse */ 'bestAskQuantityE9': string; /** * Open interest value (e9 format). * @type {string} * @memberof TickerResponse */ 'openInterestE9': string; /** * Highest Price in the last 24hrs (e9 format). * @type {string} * @memberof TickerResponse */ 'highPrice24hrE9': string; /** * Lowest Price in the last 24hrs (e9 format). * @type {string} * @memberof TickerResponse */ 'lowPrice24hrE9': string; /** * Total market volume in last 24hrs of asset (e9 format). * @type {string} * @memberof TickerResponse */ 'volume24hrE9': string; /** * Total market volume in last 24hrs in USDC (e9 format). * @type {string} * @memberof TickerResponse */ 'quoteVolume24hrE9': string; /** * Close price 24hrs ago (e9 format). * @type {string} * @memberof TickerResponse */ 'closePrice24hrE9': string; /** * Open price in the last 24hrs (e9 format). * @type {string} * @memberof TickerResponse */ 'openPrice24hrE9': string; /** * 24 hour close time in milliseconds. * @type {number} * @memberof TickerResponse */ 'closeTime24hrAtMillis': number; /** * 24 hour open time in milliseconds. * @type {number} * @memberof TickerResponse */ 'openTime24hrAtMillis': number; /** * First trade id in 24hr. * @type {number} * @memberof TickerResponse */ 'firstId24hr': number; /** * Last trade id in 24hr. * @type {number} * @memberof TickerResponse */ 'lastId24hr': number; /** * Total number of trades in 24hr. * @type {string} * @memberof TickerResponse */ 'count24hr': string; /** * 24hr Market price change (e9 format). * @type {string} * @memberof TickerResponse */ 'priceChange24hrE9': string; /** * 24hr Market price change in percentage (e9 format). * @type {string} * @memberof TickerResponse */ 'priceChangePercent24hrE9': string; /** * Last update time in milliseconds. * @type {number} * @memberof TickerResponse */ 'updatedAtMillis': number; /** * Live estimated funding rate based on current hour\'s average market and oracle prices (e9 format). * @type {string} * @memberof TickerResponse */ 'estimatedFundingRateE9': string; } /** * Represents detailed market ticker information. * @export * @interface TickerUpdate */ export interface TickerUpdate { /** * Market symbol. * @type {string} * @memberof TickerUpdate */ 'symbol': string; /** * Last trade quantity (e9 format). * @type {string} * @memberof TickerUpdate */ 'lastQuantityE9': string; /** * Last trade time in milliseconds. * @type {number} * @memberof TickerUpdate */ 'lastTimeAtMillis': number; /** * Last trade price (e9 format). * @type {string} * @memberof TickerUpdate */ 'lastPriceE9': string; /** * Funding rate value (e9 format). * @type {string} * @memberof TickerUpdate */ 'lastFundingRateE9': string; /** * Time in milliseconds of next funding rate update. * @type {number} * @memberof TickerUpdate */ 'nextFundingTimeAtMillis': number; /** * 8 hr average funding rate (e9 format). * @type {string} * @memberof TickerUpdate */ 'avgFundingRate8hrE9': string; /** * Oracle price of the asset (e9 format). * @type {string} * @memberof TickerUpdate */ 'oraclePriceE9': string; /** * Direction of oracle price computed by comparing current oracle price to last oracle price. 0 = no change, -1 = negative trend (current < last), 1 = positive trend (current > last). * @type {number} * @memberof TickerUpdate */ 'oraclePriceDirection': number; /** * Mark price on the exchange (e9 format). * @type {string} * @memberof TickerUpdate */ 'markPriceE9': string; /** * Direction of mark price computed by comparing current mark price to last mark price. 0 = no change, -1 = negative trend (current < last), 1 = positive trend (current > last). * @type {number} * @memberof TickerUpdate */ 'markPriceDirection': number; /** * Simple average of bestBid and bestAsk, or lastPrice if either is not present (e9 format). * @type {string} * @memberof TickerUpdate */ 'marketPriceE9': string; /** * Direction of market price computed by comparing current market price to last market price. 0 = no change, -1 = negative trend (current < last), 1 = positive trend (current > last). * @type {number} * @memberof TickerUpdate */ 'marketPriceDirection': number; /** * Best bid price (e9 format). * @type {string} * @memberof TickerUpdate */ 'bestBidPriceE9': string; /** * Best bid quantity (e9 format). * @type {string} * @memberof TickerUpdate */ 'bestBidQuantityE9': string; /** * Best ask price (e9 format). * @type {string} * @memberof TickerUpdate */ 'bestAskPriceE9': string; /** * Best ask quantity (e9 format). * @type {string} * @memberof TickerUpdate */ 'bestAskQuantityE9': string; /** * Open interest value (e9 format). * @type {string} * @memberof TickerUpdate */ 'openInterestE9': string; /** * Highest Price in the last 24 hours (e9 format). * @type {string} * @memberof TickerUpdate */ 'highPrice24hrE9': string; /** * Lowest Price in the last 24 hours (e9 format). * @type {string} * @memberof TickerUpdate */ 'lowPrice24hrE9': string; /** * Total market volume in last 24 hours of asset (e9 format). * @type {string} * @memberof TickerUpdate */ 'volume24hrE9': string; /** * Total market volume in last 24 hours in USDC (e9 format). * @type {string} * @memberof TickerUpdate */ 'quoteVolume24hrE9': string; /** * Close price 24 hours ago (e9 format). * @type {string} * @memberof TickerUpdate */ 'closePrice24hrE9': string; /** * Open price in the last 24 hours (e9 format). * @type {string} * @memberof TickerUpdate */ 'openPrice24hrE9': string; /** * 24 hour close timestamp in milliseconds. * @type {number} * @memberof TickerUpdate */ 'closeTime24hrAtMillis': number; /** * 24 hour open timetamp in milliseconds. * @type {number} * @memberof TickerUpdate */ 'openTime24hrAtMillis': number; /** * First trade ID in the last 24 hours. * @type {number} * @memberof TickerUpdate */ 'firstId24hr': number; /** * Last trade ID in the last 24 hours. * @type {number} * @memberof TickerUpdate */ 'lastId24hr': number; /** * Total number of trades in the last 24 hours. * @type {string} * @memberof TickerUpdate */ 'count24hr': string; /** * 24 hour Market price change (e9 format). * @type {string} * @memberof TickerUpdate */ 'priceChange24hrE9': string; /** * 24 hour Market price change as a percentage (e9 format). * @type {string} * @memberof TickerUpdate */ 'priceChangePercent24hrE9': string; /** * Last update timestamp in milliseconds. * @type {number} * @memberof TickerUpdate */ 'updatedAtMillis': number; } /** * * @export * @interface Trade */ export interface Trade { /** * Trade ID * @type {string} * @memberof Trade */ 'id': string; /** * Client order ID. * @type {string} * @memberof Trade */ 'clientOrderId'?: string; /** * Market address. * @type {string} * @memberof Trade */ 'symbol'?: string; /** * Order hash. * @type {string} * @memberof Trade */ 'orderHash'?: string; /** * * @type {OrderType} * @memberof Trade */ 'orderType'?: OrderType; /** * * @type {TradeType} * @memberof Trade */ 'tradeType'?: TradeType; /** * * @type {TradeSide} * @memberof Trade */ 'side': TradeSide; /** * Indicates if the user was a maker to the trade. * @type {boolean} * @memberof Trade */ 'isMaker'?: boolean; /** * Trade price (e9 format). * @type {string} * @memberof Trade */ 'priceE9': string; /** * Trade quantity (e9 format). * @type {string} * @memberof Trade */ 'quantityE9': string; /** * Quote quantity (e9 format). * @type {string} * @memberof Trade */ 'quoteQuantityE9': string; /** * Realized profit and loss (e9 format). * @type {string} * @memberof Trade */ 'realizedPnlE9'?: string; /** * * @type {PositionSide} * @memberof Trade */ 'positionSide'?: PositionSide; /** * Trading fee (e9 format). * @type {string} * @memberof Trade */ 'tradingFeeE9'?: string; /** * Asset used for trading fee. * @type {string} * @memberof Trade */ 'tradingFeeAsset'?: string; /** * Gas fee. * @type {string} * @memberof Trade */ 'gasFeeE9'?: string; /** * Asset used for gas fee. * @type {string} * @memberof Trade */ 'gasFeeAsset'?: string; /** * Mark price at the time of trade execution (e9 format). * @type {string} * @memberof Trade */ 'markPriceE9'?: string; /** * Oracle price at the time of trade execution (e9 format). * @type {string} * @memberof Trade */ 'oraclePriceE9'?: string; /** * Trade timestamp in milliseconds since Unix epoch. * @type {number} * @memberof Trade */ 'executedAtMillis': number; /** * * @type {ClientType} * @memberof Trade */ 'client'?: ClientType; } /** * Trade side based on the user order in this trade. * @export * @enum {string} */ export declare const TradeSide: { readonly Long: "LONG"; readonly Short: "SHORT"; readonly Unspecified: "UNSPECIFIED"; }; export type TradeSide = typeof TradeSide[keyof typeof TradeSide]; /** * Type of trade. * @export * @enum {string} */ export declare const TradeType: { readonly Order: "ORDER"; readonly Liquidation: "LIQUIDATION"; readonly Deleverage: "DELEVERAGE"; readonly Unspecified: "UNSPECIFIED"; }; export type TradeType = typeof TradeType[keyof typeof TradeType]; /** * * @export * @interface TradingFees */ export interface TradingFees { /** * The Account Maker Fee (e9 format). * @type {string} * @memberof TradingFees */ 'makerFeeE9': string; /** * The Account Taker Fee (e9 format). * @type {string} * @memberof TradingFees */ 'takerFeeE9': string; /** * Are the fees applied on the account? * @type {boolean} * @memberof TradingFees */ 'isApplied': boolean; } /** * * @export * @interface Transaction */ export interface Transaction { /** * Transaction ID. * @type {string} * @memberof Transaction */ 'id': string; /** * Market address. * @type {string} * @memberof Transaction */ 'symbol'?: string; /** * * @type {TransactionType} * @memberof Transaction */ 'type': TransactionType; /** * Amount in e9 format (positive or negative). * @type {string} * @memberof Transaction */ 'amountE9': string; /** * Transaction status (SUCCESS, REJECTED). * @type {string} * @memberof Transaction */ 'status'?: string; /** * Asset bank address. * @type {string} * @memberof Transaction */ 'assetSymbol': string; /** * Trade ID * @type {string} * @memberof Transaction */ 'tradeId'?: string; /** * Transaction timestamp in milliseconds since Unix epoch. * @type {number} * @memberof Transaction */ 'executedAtMillis': number; } /** * Transaction type (what caused the change in the asset balance). * @export * @enum {string} */ export declare const TransactionType: { readonly Transfer: "TRANSFER"; readonly Deposit: "DEPOSIT"; readonly Withdraw: "WITHDRAW"; readonly RealizedPnl: "REALIZED_PNL"; readonly FundingFee: "FUNDING_FEE"; readonly TradingFee: "TRADING_FEE"; readonly TradingGasFee: "TRADING_GAS_FEE"; readonly Bonus: "BONUS"; readonly Unspecified: "UNSPECIFIED"; }; export type TransactionType = typeof TransactionType[keyof typeof TransactionType]; /** * * @export * @interface UpdateAccountPreferenceRequest */ export interface UpdateAccountPreferenceRequest { [key: string]: any; /** * User preferred language. * @type {string} * @memberof UpdateAccountPreferenceRequest */ 'language'?: string; /** * User preferred theme. * @type {string} * @memberof UpdateAccountPreferenceRequest */ 'theme'?: string; /** * * @type {Array} * @memberof UpdateAccountPreferenceRequest */ 'market'?: Array; } /** * * @export * @interface UpdateAffiliateEmberRefferalShareRequest */ export interface UpdateAffiliateEmberRefferalShareRequest { /** * Ember refferal share for an affiliate. * @type {number} * @memberof UpdateAffiliateEmberRefferalShareRequest */ 'emberRefferalShare': number; } /** * * @export * @interface UpdateAffiliateFeeConfigRequest */ export interface UpdateAffiliateFeeConfigRequest { /** * Cashback amount to give to the referees * @type {number} * @memberof UpdateAffiliateFeeConfigRequest */ 'cashback': number; } /** * * @export * @interface UserCampaignRewards */ export interface UserCampaignRewards { /** * User address for the rewards earned data. * @type {string} * @memberof UserCampaignRewards */ 'userAddress': string; /** * Name of the campaign. * @type {string} * @memberof UserCampaignRewards */ 'campaignName': string; /** * Epoch number for the rewards earned data. * @type {number} * @memberof UserCampaignRewards */ 'epochNumber': number; /** * Interval number for the rewards earned data. * @type {number} * @memberof UserCampaignRewards */ 'intervalNumber': number; /** * Market Symbol. * @type {string} * @memberof UserCampaignRewards */ 'symbol': string; /** * * @type {string} * @memberof UserCampaignRewards */ 'status': UserCampaignRewardsStatusEnum; /** * Total blue-perp token rewards earned in the epoch (e9 format). * @type {string} * @memberof UserCampaignRewards */ 'blueRewardsE9': string; /** * Total sui-perp token rewards earned in the epoch (e9 format). * @type {string} * @memberof UserCampaignRewards */ 'suiRewardsE9': string; /** * Total wal-perp rewards earned in the epoch (e9 format). * @type {string} * @memberof UserCampaignRewards */ 'walRewardsE9': string; /** * Total cash rewards earned in the epoch (e9 format). * @type {string} * @memberof UserCampaignRewards */ 'cashRewardsE9': string; /** * Total user fee paid in the epoch (e9 format). * @type {string} * @memberof UserCampaignRewards */ 'userFeePaidE9': string; /** * Time in milliseconds for interval start date. * @type {number} * @memberof UserCampaignRewards */ 'intervalStartDate': number; /** * Time in milliseconds for interval end date. * @type {number} * @memberof UserCampaignRewards */ 'intervalEndDate': number; /** * Indicates if the rewards have been disbursed. * @type {boolean} * @memberof UserCampaignRewards */ 'isDisbursed': boolean; /** * Transaction digest of the disbursement. * @type {string} * @memberof UserCampaignRewards */ 'txnDigest': string; /** * Array of claim signatures for different reward types. * @type {Array} * @memberof UserCampaignRewards */ 'claimSignature'?: Array; /** * Status of the claim. * @type {string} * @memberof UserCampaignRewards */ 'claimStatus'?: UserCampaignRewardsClaimStatusEnum; } export declare const UserCampaignRewardsStatusEnum: { readonly Active: "ACTIVE"; readonly NotStarted: "NOT_STARTED"; readonly Finalized: "FINALIZED"; readonly Cooldown: "COOLDOWN"; }; export type UserCampaignRewardsStatusEnum = typeof UserCampaignRewardsStatusEnum[keyof typeof UserCampaignRewardsStatusEnum]; export declare const UserCampaignRewardsClaimStatusEnum: { readonly Claimable: "CLAIMABLE"; readonly Claimed: "CLAIMED"; readonly NotYetClaimable: "NOT_YET_CLAIMABLE"; readonly ClaimEnded: "CLAIM_ENDED"; }; export type UserCampaignRewardsClaimStatusEnum = typeof UserCampaignRewardsClaimStatusEnum[keyof typeof UserCampaignRewardsClaimStatusEnum]; /** * * @export * @interface VaultClaimRequest */ export interface VaultClaimRequest { /** * On-chain transaction hash of the vault deposit. * @type {string} * @memberof VaultClaimRequest */ 'txHash': string; } /** * * @export * @interface VaultClaimResponse */ export interface VaultClaimResponse { /** * The claimed transaction hash. * @type {string} * @memberof VaultClaimResponse */ 'txHash': string; /** * Claim status. * @type {string} * @memberof VaultClaimResponse */ 'status': VaultClaimResponseStatusEnum; } export declare const VaultClaimResponseStatusEnum: { readonly Claimed: "claimed"; }; export type VaultClaimResponseStatusEnum = typeof VaultClaimResponseStatusEnum[keyof typeof VaultClaimResponseStatusEnum]; /** * * @export * @interface WithdrawRequest */ export interface WithdrawRequest { /** * * @type {WithdrawRequestSignedFields} * @memberof WithdrawRequest */ 'signedFields': WithdrawRequestSignedFields; /** * The signature of the request, encoded from the signedFields * @type {string} * @memberof WithdrawRequest */ 'signature': string; } /** * * @export * @interface WithdrawRequestSignedFields */ export interface WithdrawRequestSignedFields { /** * Asset symbol of the withdrawn asset * @type {string} * @memberof WithdrawRequestSignedFields */ 'assetSymbol': string; /** * The Account Address from which to withdraw assets * @type {string} * @memberof WithdrawRequestSignedFields */ 'accountAddress': string; /** * The amount in e9 of the asset that the User will withdraw from their account * @type {string} * @memberof WithdrawRequestSignedFields */ 'amountE9': string; /** * A uniqueness modifier for the request. This is added to guarantee uniqueness of the request. Usually a mix of timestamp and a random number * @type {string} * @memberof WithdrawRequestSignedFields */ 'salt': string; /** * the ID of the external datastore for the target network * @type {string} * @memberof WithdrawRequestSignedFields */ 'edsId': string; /** * The timestamp in milliseconds when the HTTP Request payload has been signed * @type {number} * @memberof WithdrawRequestSignedFields */ 'signedAtMillis': number; } /** * * @export * @interface ZKLoginUserDetailsResponse */ export interface ZKLoginUserDetailsResponse { /** * The zkLogin user salt. * @type {string} * @memberof ZKLoginUserDetailsResponse */ 'salt': string; /** * The zkLogin user\'s address. * @type {string} * @memberof ZKLoginUserDetailsResponse */ 'address': string; /** * The zkLogin user\'s public key. * @type {string} * @memberof ZKLoginUserDetailsResponse */ 'publicKey': string; } /** * * @export * @interface ZKLoginZKPRequest */ export interface ZKLoginZKPRequest { /** * The network to use (e.g., \"mainnet\", \"testnet\"). * @type {string} * @memberof ZKLoginZKPRequest */ 'network'?: string; /** * The ephemeral public key for the ZK proof. * @type {string} * @memberof ZKLoginZKPRequest */ 'ephemeralPublicKey': string; /** * The maximum epoch for the ZK proof. * @type {number} * @memberof ZKLoginZKPRequest */ 'maxEpoch': number; /** * Randomness value for the ZK proof. * @type {string} * @memberof ZKLoginZKPRequest */ 'randomness': string; } /** * * @export * @interface ZKLoginZKPResponse */ export interface ZKLoginZKPResponse { /** * * @type {ProofPoints} * @memberof ZKLoginZKPResponse */ 'proofPoints'?: ProofPoints; /** * * @type {IssBase64Details} * @memberof ZKLoginZKPResponse */ 'issBase64Details'?: IssBase64Details; /** * Base64 encoded header information. * @type {string} * @memberof ZKLoginZKPResponse */ 'headerBase64'?: string; /** * The address seed used in the proof. * @type {string} * @memberof ZKLoginZKPResponse */ 'addressSeed': string; } /** * AccountDataApi - axios parameter creator * @export */ export declare const AccountDataApiAxiosParamCreator: (configuration?: Configuration) => { /** * Retrieves the user\'s account details. * @summary /account * @param {string} [accountAddress] Account address to fetch account details by. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAccountDetails: (accountAddress?: string, options?: RawAxiosRequestConfig) => Promise; /** * Retrieves the funding rate history for a specific account. * @summary /account/fundingRateHistory * @param {string} [accountAddress] Account address to filter funding rate history by. * @param {number} [limit] Default 500; max 1000. * @param {number} [page] The page number to retrieve in a paginated response. * @param {number} [startTimeAtMillis] Start time in milliseconds. Defaults to 7 days ago if not specified. * @param {number} [endTimeAtMillis] End time in milliseconds. Defaults to now if not specified. Must be greater than start time and must be less than 90 days apart. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAccountFundingRateHistory: (accountAddress?: string, limit?: number, page?: number, startTimeAtMillis?: number, endTimeAtMillis?: number, options?: RawAxiosRequestConfig) => Promise; /** * Retrieves the user\'s account preferences. * @summary /account/preferences * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAccountPreferences: (options?: RawAxiosRequestConfig) => Promise; /** * Retrieves the user\'s trade history. * @summary /account/trades * @param {string} [symbol] Market address to filter trades by. If not specified, returns trades for all markets. * @param {number} [startTimeAtMillis] Start time in milliseconds. Defaults to 7 days ago if not specified. * @param {number} [endTimeAtMillis] End time in milliseconds. Defaults to now if not specified. Must be greater than start time and must be less than 90 days apart. * @param {number} [limit] Default 500; max 1000. * @param {TradeType} [tradeType] Type of trade. By default returns all. UNSPECIFIED returns all. * @param {number} [page] The page number to retrieve in a paginated response. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAccountTrades: (symbol?: string, startTimeAtMillis?: number, endTimeAtMillis?: number, limit?: number, tradeType?: TradeType, page?: number, options?: RawAxiosRequestConfig) => Promise; /** * Retrieves the user\'s transaction history (any change in balance). * @summary /account/transactions * @param {Array} [types] Optional query parameter to filter transactions by type. * @param {string} [assetSymbol] Optional query parameter to filter transactions by asset bank address. * @param {number} [startTimeAtMillis] Start time in milliseconds. Defaults to 7 days ago if not specified. * @param {number} [endTimeAtMillis] End time in milliseconds. Defaults to now if not specified. Must be greater than start time and must be less than 90 days apart. * @param {number} [limit] Default 500; max 1000. * @param {number} [page] The page number to retrieve in a paginated response. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAccountTransactionHistory: (types?: Array, assetSymbol?: string, startTimeAtMillis?: number, endTimeAtMillis?: number, limit?: number, page?: number, options?: RawAxiosRequestConfig) => Promise; /** * Retrieves the account value history for a specific account over a given time interval. * @summary /account/valueHistory * @param {GetAccountValueHistoryParamsInterval} interval Time interval for the value history. Options are 24h, 7d, 30d, 90d, or all. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAccountValueHistory: (interval: GetAccountValueHistoryParamsInterval, options?: RawAxiosRequestConfig) => Promise; /** * Retrieves the account value history for 24h. * @summary /accounts/{accountAddress}/valueHistory * @param {string} accountAddress Account address to fetch account value history for. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAccountValueHistoryByAccount: (accountAddress: string, options?: RawAxiosRequestConfig) => Promise; /** * Sets or updates the group ID for a specific account. Accounts belonging to the same group cannot trade against each other. If the groupId is not set, the account will be removed from its group. Only the first 6 characters of the groupID are guaranteed to be respected, longer group IDs may be rejected. * @summary Set the group ID for an account. * @param {AccountGroupIdPatch} accountGroupIdPatch Account group ID update. * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchAccountGroupID: (accountGroupIdPatch: AccountGroupIdPatch, options?: RawAxiosRequestConfig) => Promise; /** * Update user\'s account preferences. This will overwrite the preferences, so always send the full object. * @summary /account/preferences * @param {UpdateAccountPreferenceRequest} updateAccountPreferenceRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ putAccountPreferences: (updateAccountPreferenceRequest: UpdateAccountPreferenceRequest, options?: RawAxiosRequestConfig) => Promise; /** * Sponsors a transaction if it\'s eligible for sponsorship based on allowlisted methods and kinds. * @summary /account/sponsorTx * @param {SponsorTxRequest} sponsorTxRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ sponsorTx: (sponsorTxRequest: SponsorTxRequest, options?: RawAxiosRequestConfig) => Promise; }; /** * AccountDataApi - functional programming interface * @export */ export declare const AccountDataApiFp: (configuration?: Configuration) => { /** * Retrieves the user\'s account details. * @summary /account * @param {string} [accountAddress] Account address to fetch account details by. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAccountDetails(accountAddress?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieves the funding rate history for a specific account. * @summary /account/fundingRateHistory * @param {string} [accountAddress] Account address to filter funding rate history by. * @param {number} [limit] Default 500; max 1000. * @param {number} [page] The page number to retrieve in a paginated response. * @param {number} [startTimeAtMillis] Start time in milliseconds. Defaults to 7 days ago if not specified. * @param {number} [endTimeAtMillis] End time in milliseconds. Defaults to now if not specified. Must be greater than start time and must be less than 90 days apart. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAccountFundingRateHistory(accountAddress?: string, limit?: number, page?: number, startTimeAtMillis?: number, endTimeAtMillis?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieves the user\'s account preferences. * @summary /account/preferences * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAccountPreferences(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieves the user\'s trade history. * @summary /account/trades * @param {string} [symbol] Market address to filter trades by. If not specified, returns trades for all markets. * @param {number} [startTimeAtMillis] Start time in milliseconds. Defaults to 7 days ago if not specified. * @param {number} [endTimeAtMillis] End time in milliseconds. Defaults to now if not specified. Must be greater than start time and must be less than 90 days apart. * @param {number} [limit] Default 500; max 1000. * @param {TradeType} [tradeType] Type of trade. By default returns all. UNSPECIFIED returns all. * @param {number} [page] The page number to retrieve in a paginated response. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAccountTrades(symbol?: string, startTimeAtMillis?: number, endTimeAtMillis?: number, limit?: number, tradeType?: TradeType, page?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * Retrieves the user\'s transaction history (any change in balance). * @summary /account/transactions * @param {Array} [types] Optional query parameter to filter transactions by type. * @param {string} [assetSymbol] Optional query parameter to filter transactions by asset bank address. * @param {number} [startTimeAtMillis] Start time in milliseconds. Defaults to 7 days ago if not specified. * @param {number} [endTimeAtMillis] End time in milliseconds. Defaults to now if not specified. Must be greater than start time and must be less than 90 days apart. * @param {number} [limit] Default 500; max 1000. * @param {number} [page] The page number to retrieve in a paginated response. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAccountTransactionHistory(types?: Array, assetSymbol?: string, startTimeAtMillis?: number, endTimeAtMillis?: number, limit?: number, page?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * Retrieves the account value history for a specific account over a given time interval. * @summary /account/valueHistory * @param {GetAccountValueHistoryParamsInterval} interval Time interval for the value history. Options are 24h, 7d, 30d, 90d, or all. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAccountValueHistory(interval: GetAccountValueHistoryParamsInterval, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieves the account value history for 24h. * @summary /accounts/{accountAddress}/valueHistory * @param {string} accountAddress Account address to fetch account value history for. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAccountValueHistoryByAccount(accountAddress: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Sets or updates the group ID for a specific account. Accounts belonging to the same group cannot trade against each other. If the groupId is not set, the account will be removed from its group. Only the first 6 characters of the groupID are guaranteed to be respected, longer group IDs may be rejected. * @summary Set the group ID for an account. * @param {AccountGroupIdPatch} accountGroupIdPatch Account group ID update. * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchAccountGroupID(accountGroupIdPatch: AccountGroupIdPatch, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update user\'s account preferences. This will overwrite the preferences, so always send the full object. * @summary /account/preferences * @param {UpdateAccountPreferenceRequest} updateAccountPreferenceRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ putAccountPreferences(updateAccountPreferenceRequest: UpdateAccountPreferenceRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Sponsors a transaction if it\'s eligible for sponsorship based on allowlisted methods and kinds. * @summary /account/sponsorTx * @param {SponsorTxRequest} sponsorTxRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ sponsorTx(sponsorTxRequest: SponsorTxRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * AccountDataApi - factory interface * @export */ export declare const AccountDataApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Retrieves the user\'s account details. * @summary /account * @param {string} [accountAddress] Account address to fetch account details by. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAccountDetails(accountAddress?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieves the funding rate history for a specific account. * @summary /account/fundingRateHistory * @param {string} [accountAddress] Account address to filter funding rate history by. * @param {number} [limit] Default 500; max 1000. * @param {number} [page] The page number to retrieve in a paginated response. * @param {number} [startTimeAtMillis] Start time in milliseconds. Defaults to 7 days ago if not specified. * @param {number} [endTimeAtMillis] End time in milliseconds. Defaults to now if not specified. Must be greater than start time and must be less than 90 days apart. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAccountFundingRateHistory(accountAddress?: string, limit?: number, page?: number, startTimeAtMillis?: number, endTimeAtMillis?: number, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieves the user\'s account preferences. * @summary /account/preferences * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAccountPreferences(options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieves the user\'s trade history. * @summary /account/trades * @param {string} [symbol] Market address to filter trades by. If not specified, returns trades for all markets. * @param {number} [startTimeAtMillis] Start time in milliseconds. Defaults to 7 days ago if not specified. * @param {number} [endTimeAtMillis] End time in milliseconds. Defaults to now if not specified. Must be greater than start time and must be less than 90 days apart. * @param {number} [limit] Default 500; max 1000. * @param {TradeType} [tradeType] Type of trade. By default returns all. UNSPECIFIED returns all. * @param {number} [page] The page number to retrieve in a paginated response. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAccountTrades(symbol?: string, startTimeAtMillis?: number, endTimeAtMillis?: number, limit?: number, tradeType?: TradeType, page?: number, options?: RawAxiosRequestConfig): AxiosPromise>; /** * Retrieves the user\'s transaction history (any change in balance). * @summary /account/transactions * @param {Array} [types] Optional query parameter to filter transactions by type. * @param {string} [assetSymbol] Optional query parameter to filter transactions by asset bank address. * @param {number} [startTimeAtMillis] Start time in milliseconds. Defaults to 7 days ago if not specified. * @param {number} [endTimeAtMillis] End time in milliseconds. Defaults to now if not specified. Must be greater than start time and must be less than 90 days apart. * @param {number} [limit] Default 500; max 1000. * @param {number} [page] The page number to retrieve in a paginated response. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAccountTransactionHistory(types?: Array, assetSymbol?: string, startTimeAtMillis?: number, endTimeAtMillis?: number, limit?: number, page?: number, options?: RawAxiosRequestConfig): AxiosPromise>; /** * Retrieves the account value history for a specific account over a given time interval. * @summary /account/valueHistory * @param {GetAccountValueHistoryParamsInterval} interval Time interval for the value history. Options are 24h, 7d, 30d, 90d, or all. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAccountValueHistory(interval: GetAccountValueHistoryParamsInterval, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieves the account value history for 24h. * @summary /accounts/{accountAddress}/valueHistory * @param {string} accountAddress Account address to fetch account value history for. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAccountValueHistoryByAccount(accountAddress: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Sets or updates the group ID for a specific account. Accounts belonging to the same group cannot trade against each other. If the groupId is not set, the account will be removed from its group. Only the first 6 characters of the groupID are guaranteed to be respected, longer group IDs may be rejected. * @summary Set the group ID for an account. * @param {AccountGroupIdPatch} accountGroupIdPatch Account group ID update. * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchAccountGroupID(accountGroupIdPatch: AccountGroupIdPatch, options?: RawAxiosRequestConfig): AxiosPromise; /** * Update user\'s account preferences. This will overwrite the preferences, so always send the full object. * @summary /account/preferences * @param {UpdateAccountPreferenceRequest} updateAccountPreferenceRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ putAccountPreferences(updateAccountPreferenceRequest: UpdateAccountPreferenceRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Sponsors a transaction if it\'s eligible for sponsorship based on allowlisted methods and kinds. * @summary /account/sponsorTx * @param {SponsorTxRequest} sponsorTxRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ sponsorTx(sponsorTxRequest: SponsorTxRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * AccountDataApi - object-oriented interface * @export * @class AccountDataApi * @extends {BaseAPI} */ export declare class AccountDataApi extends BaseAPI { /** * Retrieves the user\'s account details. * @summary /account * @param {string} [accountAddress] Account address to fetch account details by. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AccountDataApi */ getAccountDetails(accountAddress?: string, options?: RawAxiosRequestConfig): Promise>; /** * Retrieves the funding rate history for a specific account. * @summary /account/fundingRateHistory * @param {string} [accountAddress] Account address to filter funding rate history by. * @param {number} [limit] Default 500; max 1000. * @param {number} [page] The page number to retrieve in a paginated response. * @param {number} [startTimeAtMillis] Start time in milliseconds. Defaults to 7 days ago if not specified. * @param {number} [endTimeAtMillis] End time in milliseconds. Defaults to now if not specified. Must be greater than start time and must be less than 90 days apart. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AccountDataApi */ getAccountFundingRateHistory(accountAddress?: string, limit?: number, page?: number, startTimeAtMillis?: number, endTimeAtMillis?: number, options?: RawAxiosRequestConfig): Promise>; /** * Retrieves the user\'s account preferences. * @summary /account/preferences * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AccountDataApi */ getAccountPreferences(options?: RawAxiosRequestConfig): Promise>; /** * Retrieves the user\'s trade history. * @summary /account/trades * @param {string} [symbol] Market address to filter trades by. If not specified, returns trades for all markets. * @param {number} [startTimeAtMillis] Start time in milliseconds. Defaults to 7 days ago if not specified. * @param {number} [endTimeAtMillis] End time in milliseconds. Defaults to now if not specified. Must be greater than start time and must be less than 90 days apart. * @param {number} [limit] Default 500; max 1000. * @param {TradeType} [tradeType] Type of trade. By default returns all. UNSPECIFIED returns all. * @param {number} [page] The page number to retrieve in a paginated response. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AccountDataApi */ getAccountTrades(symbol?: string, startTimeAtMillis?: number, endTimeAtMillis?: number, limit?: number, tradeType?: TradeType, page?: number, options?: RawAxiosRequestConfig): Promise>; /** * Retrieves the user\'s transaction history (any change in balance). * @summary /account/transactions * @param {Array} [types] Optional query parameter to filter transactions by type. * @param {string} [assetSymbol] Optional query parameter to filter transactions by asset bank address. * @param {number} [startTimeAtMillis] Start time in milliseconds. Defaults to 7 days ago if not specified. * @param {number} [endTimeAtMillis] End time in milliseconds. Defaults to now if not specified. Must be greater than start time and must be less than 90 days apart. * @param {number} [limit] Default 500; max 1000. * @param {number} [page] The page number to retrieve in a paginated response. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AccountDataApi */ getAccountTransactionHistory(types?: Array, assetSymbol?: string, startTimeAtMillis?: number, endTimeAtMillis?: number, limit?: number, page?: number, options?: RawAxiosRequestConfig): Promise>; /** * Retrieves the account value history for a specific account over a given time interval. * @summary /account/valueHistory * @param {GetAccountValueHistoryParamsInterval} interval Time interval for the value history. Options are 24h, 7d, 30d, 90d, or all. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AccountDataApi */ getAccountValueHistory(interval: GetAccountValueHistoryParamsInterval, options?: RawAxiosRequestConfig): Promise>; /** * Retrieves the account value history for 24h. * @summary /accounts/{accountAddress}/valueHistory * @param {string} accountAddress Account address to fetch account value history for. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AccountDataApi */ getAccountValueHistoryByAccount(accountAddress: string, options?: RawAxiosRequestConfig): Promise>; /** * Sets or updates the group ID for a specific account. Accounts belonging to the same group cannot trade against each other. If the groupId is not set, the account will be removed from its group. Only the first 6 characters of the groupID are guaranteed to be respected, longer group IDs may be rejected. * @summary Set the group ID for an account. * @param {AccountGroupIdPatch} accountGroupIdPatch Account group ID update. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AccountDataApi */ patchAccountGroupID(accountGroupIdPatch: AccountGroupIdPatch, options?: RawAxiosRequestConfig): Promise>; /** * Update user\'s account preferences. This will overwrite the preferences, so always send the full object. * @summary /account/preferences * @param {UpdateAccountPreferenceRequest} updateAccountPreferenceRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AccountDataApi */ putAccountPreferences(updateAccountPreferenceRequest: UpdateAccountPreferenceRequest, options?: RawAxiosRequestConfig): Promise>; /** * Sponsors a transaction if it\'s eligible for sponsorship based on allowlisted methods and kinds. * @summary /account/sponsorTx * @param {SponsorTxRequest} sponsorTxRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AccountDataApi */ sponsorTx(sponsorTxRequest: SponsorTxRequest, options?: RawAxiosRequestConfig): Promise>; } /** * AuthApi - axios parameter creator * @export */ export declare const AuthApiAxiosParamCreator: (configuration?: Configuration) => { /** * * @param {*} [options] Override http request option. * @throws {RequiredError} */ authJwksGet: (options?: RawAxiosRequestConfig) => Promise; /** * login with token * @param {string} payloadSignature * @param {LoginRequest} loginRequest * @param {number} [refreshTokenValidForSeconds] The number of seconds the refresh token is valid for. If not provided, the default is 30 days. * @param {boolean} [readOnly] * @param {ClientType} [client] The client application originating the request (WEB or VERA). Defaults to WEB if not supplied. * @param {*} [options] Override http request option. * @throws {RequiredError} */ authTokenPost: (payloadSignature: string, loginRequest: LoginRequest, refreshTokenValidForSeconds?: number, readOnly?: boolean, client?: ClientType, options?: RawAxiosRequestConfig) => Promise; /** * Retrieves a new auth token for an account. Expiry is set to 5 min. * @param {RefreshTokenRequest} refreshTokenRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ authTokenRefreshPut: (refreshTokenRequest: RefreshTokenRequest, options?: RawAxiosRequestConfig) => Promise; /** * login compatible with BCS payload with intent bytes * @param {string} payloadSignature * @param {LoginRequest} loginRequest * @param {number} [refreshTokenValidForSeconds] The number of seconds the refresh token is valid for. If not provided, the default is 30 days. * @param {boolean} [readOnly] * @param {ClientType} [client] The client application originating the request (WEB or VERA). Defaults to WEB if not supplied. * @param {*} [options] Override http request option. * @throws {RequiredError} */ authV2TokenPost: (payloadSignature: string, loginRequest: LoginRequest, refreshTokenValidForSeconds?: number, readOnly?: boolean, client?: ClientType, options?: RawAxiosRequestConfig) => Promise; /** * OpenID Connect Discovery endpoint * @summary /.well-known/openid-configuration * @param {*} [options] Override http request option. * @throws {RequiredError} */ getWellKnownOpenidConfiguration: (options?: RawAxiosRequestConfig) => Promise; /** * ZK Login User Details * @summary /auth/zklogin * @param {string} zkloginJwt The JWT of the user signed in with zkLogin. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getZkLoginUserDetails: (zkloginJwt: string, options?: RawAxiosRequestConfig) => Promise; /** * OAuth2 client_credentials grant for service accounts * @summary /auth/client-credentials * @param {ClientCredentialsRequest} clientCredentialsRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ postAuthClientCredentials: (clientCredentialsRequest: ClientCredentialsRequest, options?: RawAxiosRequestConfig) => Promise; /** * * @summary /auth/zklogin/zkp * @param {string} zkloginJwt The JWT of the user signed in with zkLogin. * @param {ZKLoginZKPRequest} zKLoginZKPRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ postZkLoginZkp: (zkloginJwt: string, zKLoginZKPRequest: ZKLoginZKPRequest, options?: RawAxiosRequestConfig) => Promise; }; /** * AuthApi - functional programming interface * @export */ export declare const AuthApiFp: (configuration?: Configuration) => { /** * * @param {*} [options] Override http request option. * @throws {RequiredError} */ authJwksGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{ [key: string]: any | undefined; }>>; /** * login with token * @param {string} payloadSignature * @param {LoginRequest} loginRequest * @param {number} [refreshTokenValidForSeconds] The number of seconds the refresh token is valid for. If not provided, the default is 30 days. * @param {boolean} [readOnly] * @param {ClientType} [client] The client application originating the request (WEB or VERA). Defaults to WEB if not supplied. * @param {*} [options] Override http request option. * @throws {RequiredError} */ authTokenPost(payloadSignature: string, loginRequest: LoginRequest, refreshTokenValidForSeconds?: number, readOnly?: boolean, client?: ClientType, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieves a new auth token for an account. Expiry is set to 5 min. * @param {RefreshTokenRequest} refreshTokenRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ authTokenRefreshPut(refreshTokenRequest: RefreshTokenRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * login compatible with BCS payload with intent bytes * @param {string} payloadSignature * @param {LoginRequest} loginRequest * @param {number} [refreshTokenValidForSeconds] The number of seconds the refresh token is valid for. If not provided, the default is 30 days. * @param {boolean} [readOnly] * @param {ClientType} [client] The client application originating the request (WEB or VERA). Defaults to WEB if not supplied. * @param {*} [options] Override http request option. * @throws {RequiredError} */ authV2TokenPost(payloadSignature: string, loginRequest: LoginRequest, refreshTokenValidForSeconds?: number, readOnly?: boolean, client?: ClientType, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * OpenID Connect Discovery endpoint * @summary /.well-known/openid-configuration * @param {*} [options] Override http request option. * @throws {RequiredError} */ getWellKnownOpenidConfiguration(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * ZK Login User Details * @summary /auth/zklogin * @param {string} zkloginJwt The JWT of the user signed in with zkLogin. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getZkLoginUserDetails(zkloginJwt: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * OAuth2 client_credentials grant for service accounts * @summary /auth/client-credentials * @param {ClientCredentialsRequest} clientCredentialsRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ postAuthClientCredentials(clientCredentialsRequest: ClientCredentialsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary /auth/zklogin/zkp * @param {string} zkloginJwt The JWT of the user signed in with zkLogin. * @param {ZKLoginZKPRequest} zKLoginZKPRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ postZkLoginZkp(zkloginJwt: string, zKLoginZKPRequest: ZKLoginZKPRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * AuthApi - factory interface * @export */ export declare const AuthApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * * @param {*} [options] Override http request option. * @throws {RequiredError} */ authJwksGet(options?: RawAxiosRequestConfig): AxiosPromise<{ [key: string]: any | undefined; }>; /** * login with token * @param {string} payloadSignature * @param {LoginRequest} loginRequest * @param {number} [refreshTokenValidForSeconds] The number of seconds the refresh token is valid for. If not provided, the default is 30 days. * @param {boolean} [readOnly] * @param {ClientType} [client] The client application originating the request (WEB or VERA). Defaults to WEB if not supplied. * @param {*} [options] Override http request option. * @throws {RequiredError} */ authTokenPost(payloadSignature: string, loginRequest: LoginRequest, refreshTokenValidForSeconds?: number, readOnly?: boolean, client?: ClientType, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieves a new auth token for an account. Expiry is set to 5 min. * @param {RefreshTokenRequest} refreshTokenRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ authTokenRefreshPut(refreshTokenRequest: RefreshTokenRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * login compatible with BCS payload with intent bytes * @param {string} payloadSignature * @param {LoginRequest} loginRequest * @param {number} [refreshTokenValidForSeconds] The number of seconds the refresh token is valid for. If not provided, the default is 30 days. * @param {boolean} [readOnly] * @param {ClientType} [client] The client application originating the request (WEB or VERA). Defaults to WEB if not supplied. * @param {*} [options] Override http request option. * @throws {RequiredError} */ authV2TokenPost(payloadSignature: string, loginRequest: LoginRequest, refreshTokenValidForSeconds?: number, readOnly?: boolean, client?: ClientType, options?: RawAxiosRequestConfig): AxiosPromise; /** * OpenID Connect Discovery endpoint * @summary /.well-known/openid-configuration * @param {*} [options] Override http request option. * @throws {RequiredError} */ getWellKnownOpenidConfiguration(options?: RawAxiosRequestConfig): AxiosPromise; /** * ZK Login User Details * @summary /auth/zklogin * @param {string} zkloginJwt The JWT of the user signed in with zkLogin. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getZkLoginUserDetails(zkloginJwt: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * OAuth2 client_credentials grant for service accounts * @summary /auth/client-credentials * @param {ClientCredentialsRequest} clientCredentialsRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ postAuthClientCredentials(clientCredentialsRequest: ClientCredentialsRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary /auth/zklogin/zkp * @param {string} zkloginJwt The JWT of the user signed in with zkLogin. * @param {ZKLoginZKPRequest} zKLoginZKPRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ postZkLoginZkp(zkloginJwt: string, zKLoginZKPRequest: ZKLoginZKPRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * AuthApi - object-oriented interface * @export * @class AuthApi * @extends {BaseAPI} */ export declare class AuthApi extends BaseAPI { /** * * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AuthApi */ authJwksGet(options?: RawAxiosRequestConfig): Promise>; /** * login with token * @param {string} payloadSignature * @param {LoginRequest} loginRequest * @param {number} [refreshTokenValidForSeconds] The number of seconds the refresh token is valid for. If not provided, the default is 30 days. * @param {boolean} [readOnly] * @param {ClientType} [client] The client application originating the request (WEB or VERA). Defaults to WEB if not supplied. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AuthApi */ authTokenPost(payloadSignature: string, loginRequest: LoginRequest, refreshTokenValidForSeconds?: number, readOnly?: boolean, client?: ClientType, options?: RawAxiosRequestConfig): Promise>; /** * Retrieves a new auth token for an account. Expiry is set to 5 min. * @param {RefreshTokenRequest} refreshTokenRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AuthApi */ authTokenRefreshPut(refreshTokenRequest: RefreshTokenRequest, options?: RawAxiosRequestConfig): Promise>; /** * login compatible with BCS payload with intent bytes * @param {string} payloadSignature * @param {LoginRequest} loginRequest * @param {number} [refreshTokenValidForSeconds] The number of seconds the refresh token is valid for. If not provided, the default is 30 days. * @param {boolean} [readOnly] * @param {ClientType} [client] The client application originating the request (WEB or VERA). Defaults to WEB if not supplied. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AuthApi */ authV2TokenPost(payloadSignature: string, loginRequest: LoginRequest, refreshTokenValidForSeconds?: number, readOnly?: boolean, client?: ClientType, options?: RawAxiosRequestConfig): Promise>; /** * OpenID Connect Discovery endpoint * @summary /.well-known/openid-configuration * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AuthApi */ getWellKnownOpenidConfiguration(options?: RawAxiosRequestConfig): Promise>; /** * ZK Login User Details * @summary /auth/zklogin * @param {string} zkloginJwt The JWT of the user signed in with zkLogin. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AuthApi */ getZkLoginUserDetails(zkloginJwt: string, options?: RawAxiosRequestConfig): Promise>; /** * OAuth2 client_credentials grant for service accounts * @summary /auth/client-credentials * @param {ClientCredentialsRequest} clientCredentialsRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AuthApi */ postAuthClientCredentials(clientCredentialsRequest: ClientCredentialsRequest, options?: RawAxiosRequestConfig): Promise>; /** * * @summary /auth/zklogin/zkp * @param {string} zkloginJwt The JWT of the user signed in with zkLogin. * @param {ZKLoginZKPRequest} zKLoginZKPRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AuthApi */ postZkLoginZkp(zkloginJwt: string, zKLoginZKPRequest: ZKLoginZKPRequest, options?: RawAxiosRequestConfig): Promise>; } /** * ExchangeApi - axios parameter creator * @export */ export declare const ExchangeApiAxiosParamCreator: (configuration?: Configuration) => { /** * Retrieves all market ticker information. * @summary /exchange/tickers * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAllMarketTicker: (options?: RawAxiosRequestConfig) => Promise; /** * Retrieves candle stick data for a market. * @summary /exchange/candlesticks * @param {string} symbol The market symbol to get the klines for. * @param {KlineInterval} interval The interval to get the klines for. * @param {CandlePriceType} type Candle price type (last price, market price, oracle or mark price). * @param {number} [startTimeAtMillis] Timestamp in milliseconds in ms to get klines from. * @param {number} [endTimeAtMillis] Timestamp in milliseconds in ms to get klines until. * @param {number} [limit] Default 50; max 1000. * @param {number} [page] The page number to retrieve in a paginated response. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCandlestickData: (symbol: string, interval: KlineInterval, type: CandlePriceType, startTimeAtMillis?: number, endTimeAtMillis?: number, limit?: number, page?: number, options?: RawAxiosRequestConfig) => Promise; /** * Check if the country is geo restricted. * @summary /exchange/country * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCountry: (options?: RawAxiosRequestConfig) => Promise; /** * Returns the current exchange information including available margin assets, markets, and rules. * @summary /exchange/info * @param {*} [options] Override http request option. * @throws {RequiredError} */ getExchangeInfo: (options?: RawAxiosRequestConfig) => Promise; /** * Retrieves exchange statistics. * @summary /exchange/stats * @param {StatsInterval} [interval] * @param {number} [startTimeAtMillis] Timestamp in milliseconds. * @param {number} [endTimeAtMillis] Timestamp in milliseconds. * @param {number} [limit] Number of records to return. Default is 30; max is 200. * @param {number} [page] The page number to retrieve in a paginated response. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getExchangeStats: (interval?: StatsInterval, startTimeAtMillis?: number, endTimeAtMillis?: number, limit?: number, page?: number, options?: RawAxiosRequestConfig) => Promise; /** * Retrieves all time exchange statistics. * @summary /v1/exchange/stats/allTime * @param {*} [options] Override http request option. * @throws {RequiredError} */ getExchangeStatsAllTime: (options?: RawAxiosRequestConfig) => Promise; /** * Retrieve the funding rate history for a specific market address. * @summary /exchange/fundingRateHistory * @param {string} symbol The market symbol to get funding rate history for * @param {number} [limit] Number of records to return. Default is 100; max is 1000. * @param {number} [startTimeAtMillis] The timestamp specifies the earliest point in time for which data should be returned. The value is not included. * @param {number} [endTimeAtMillis] The timestamp specifies the latest point in time for which data should be returned. The value is included. * @param {number} [page] The page number to retrieve in a paginated response. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFundingRateHistory: (symbol: string, limit?: number, startTimeAtMillis?: number, endTimeAtMillis?: number, page?: number, options?: RawAxiosRequestConfig) => Promise; /** * Retrieves the leaderboard of traders based on their performance. * @summary /accounts/leaderboard * @param {LeaderboardInterval} [interval] The interval to get the leaderboard for. Default or Unspecified is 7d. * @param {GetLeaderboardSortByEnum} [sortBy] The field to sort by. Default or Unspecified is accountValue. * @param {SortOrder} [sortOrder] The sort order, either ascending (ASC) or descending (DESC). Default or UNSPECIFIED is DESC. * @param {number} [limit] Default 50; max 1000. * @param {number} [page] The page number to retrieve in a paginated response. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getLeaderboard: (interval?: LeaderboardInterval, sortBy?: GetLeaderboardSortByEnum, sortOrder?: SortOrder, limit?: number, page?: number, options?: RawAxiosRequestConfig) => Promise; /** * Retrieves aggregated ticker data for a market. * @summary /exchange/ticker * @param {string} symbol Market symbol. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMarketTicker: (symbol: string, options?: RawAxiosRequestConfig) => Promise; /** * Returns the current state of the orderbook. * @summary /exchange/depth * @param {string} symbol Market symbol to get the orderbook depth for. * @param {number} [limit] Maximum number of bids and asks to return. Default 500; max 1000. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOrderbookDepth: (symbol: string, limit?: number, options?: RawAxiosRequestConfig) => Promise; /** * Retrieves recent trades executed on a market. * @summary /exchange/trades * @param {string} symbol The market symbol to get the trades for. * @param {TradeType} [tradeType] Type of trade. * @param {number} [limit] Default 500; max 1000. * @param {number} [startTimeAtMillis] The timestamp specifies the earliest point in time for which data should be returned. The value is not included. * @param {number} [endTimeAtMillis] The timestamp specifies the latest point in time for which data should be returned. The value is included. * @param {number} [page] The page number to retrieve in a paginated response. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRecentTrades: (symbol: string, tradeType?: TradeType, limit?: number, startTimeAtMillis?: number, endTimeAtMillis?: number, page?: number, options?: RawAxiosRequestConfig) => Promise; }; /** * ExchangeApi - functional programming interface * @export */ export declare const ExchangeApiFp: (configuration?: Configuration) => { /** * Retrieves all market ticker information. * @summary /exchange/tickers * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAllMarketTicker(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * Retrieves candle stick data for a market. * @summary /exchange/candlesticks * @param {string} symbol The market symbol to get the klines for. * @param {KlineInterval} interval The interval to get the klines for. * @param {CandlePriceType} type Candle price type (last price, market price, oracle or mark price). * @param {number} [startTimeAtMillis] Timestamp in milliseconds in ms to get klines from. * @param {number} [endTimeAtMillis] Timestamp in milliseconds in ms to get klines until. * @param {number} [limit] Default 50; max 1000. * @param {number} [page] The page number to retrieve in a paginated response. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCandlestickData(symbol: string, interval: KlineInterval, type: CandlePriceType, startTimeAtMillis?: number, endTimeAtMillis?: number, limit?: number, page?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>>; /** * Check if the country is geo restricted. * @summary /exchange/country * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCountry(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns the current exchange information including available margin assets, markets, and rules. * @summary /exchange/info * @param {*} [options] Override http request option. * @throws {RequiredError} */ getExchangeInfo(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieves exchange statistics. * @summary /exchange/stats * @param {StatsInterval} [interval] * @param {number} [startTimeAtMillis] Timestamp in milliseconds. * @param {number} [endTimeAtMillis] Timestamp in milliseconds. * @param {number} [limit] Number of records to return. Default is 30; max is 200. * @param {number} [page] The page number to retrieve in a paginated response. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getExchangeStats(interval?: StatsInterval, startTimeAtMillis?: number, endTimeAtMillis?: number, limit?: number, page?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieves all time exchange statistics. * @summary /v1/exchange/stats/allTime * @param {*} [options] Override http request option. * @throws {RequiredError} */ getExchangeStatsAllTime(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieve the funding rate history for a specific market address. * @summary /exchange/fundingRateHistory * @param {string} symbol The market symbol to get funding rate history for * @param {number} [limit] Number of records to return. Default is 100; max is 1000. * @param {number} [startTimeAtMillis] The timestamp specifies the earliest point in time for which data should be returned. The value is not included. * @param {number} [endTimeAtMillis] The timestamp specifies the latest point in time for which data should be returned. The value is included. * @param {number} [page] The page number to retrieve in a paginated response. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFundingRateHistory(symbol: string, limit?: number, startTimeAtMillis?: number, endTimeAtMillis?: number, page?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * Retrieves the leaderboard of traders based on their performance. * @summary /accounts/leaderboard * @param {LeaderboardInterval} [interval] The interval to get the leaderboard for. Default or Unspecified is 7d. * @param {GetLeaderboardSortByEnum} [sortBy] The field to sort by. Default or Unspecified is accountValue. * @param {SortOrder} [sortOrder] The sort order, either ascending (ASC) or descending (DESC). Default or UNSPECIFIED is DESC. * @param {number} [limit] Default 50; max 1000. * @param {number} [page] The page number to retrieve in a paginated response. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getLeaderboard(interval?: LeaderboardInterval, sortBy?: GetLeaderboardSortByEnum, sortOrder?: SortOrder, limit?: number, page?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieves aggregated ticker data for a market. * @summary /exchange/ticker * @param {string} symbol Market symbol. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMarketTicker(symbol: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns the current state of the orderbook. * @summary /exchange/depth * @param {string} symbol Market symbol to get the orderbook depth for. * @param {number} [limit] Maximum number of bids and asks to return. Default 500; max 1000. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOrderbookDepth(symbol: string, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieves recent trades executed on a market. * @summary /exchange/trades * @param {string} symbol The market symbol to get the trades for. * @param {TradeType} [tradeType] Type of trade. * @param {number} [limit] Default 500; max 1000. * @param {number} [startTimeAtMillis] The timestamp specifies the earliest point in time for which data should be returned. The value is not included. * @param {number} [endTimeAtMillis] The timestamp specifies the latest point in time for which data should be returned. The value is included. * @param {number} [page] The page number to retrieve in a paginated response. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRecentTrades(symbol: string, tradeType?: TradeType, limit?: number, startTimeAtMillis?: number, endTimeAtMillis?: number, page?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; }; /** * ExchangeApi - factory interface * @export */ export declare const ExchangeApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Retrieves all market ticker information. * @summary /exchange/tickers * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAllMarketTicker(options?: RawAxiosRequestConfig): AxiosPromise>; /** * Retrieves candle stick data for a market. * @summary /exchange/candlesticks * @param {string} symbol The market symbol to get the klines for. * @param {KlineInterval} interval The interval to get the klines for. * @param {CandlePriceType} type Candle price type (last price, market price, oracle or mark price). * @param {number} [startTimeAtMillis] Timestamp in milliseconds in ms to get klines from. * @param {number} [endTimeAtMillis] Timestamp in milliseconds in ms to get klines until. * @param {number} [limit] Default 50; max 1000. * @param {number} [page] The page number to retrieve in a paginated response. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCandlestickData(symbol: string, interval: KlineInterval, type: CandlePriceType, startTimeAtMillis?: number, endTimeAtMillis?: number, limit?: number, page?: number, options?: RawAxiosRequestConfig): AxiosPromise>>; /** * Check if the country is geo restricted. * @summary /exchange/country * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCountry(options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns the current exchange information including available margin assets, markets, and rules. * @summary /exchange/info * @param {*} [options] Override http request option. * @throws {RequiredError} */ getExchangeInfo(options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieves exchange statistics. * @summary /exchange/stats * @param {StatsInterval} [interval] * @param {number} [startTimeAtMillis] Timestamp in milliseconds. * @param {number} [endTimeAtMillis] Timestamp in milliseconds. * @param {number} [limit] Number of records to return. Default is 30; max is 200. * @param {number} [page] The page number to retrieve in a paginated response. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getExchangeStats(interval?: StatsInterval, startTimeAtMillis?: number, endTimeAtMillis?: number, limit?: number, page?: number, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieves all time exchange statistics. * @summary /v1/exchange/stats/allTime * @param {*} [options] Override http request option. * @throws {RequiredError} */ getExchangeStatsAllTime(options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieve the funding rate history for a specific market address. * @summary /exchange/fundingRateHistory * @param {string} symbol The market symbol to get funding rate history for * @param {number} [limit] Number of records to return. Default is 100; max is 1000. * @param {number} [startTimeAtMillis] The timestamp specifies the earliest point in time for which data should be returned. The value is not included. * @param {number} [endTimeAtMillis] The timestamp specifies the latest point in time for which data should be returned. The value is included. * @param {number} [page] The page number to retrieve in a paginated response. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFundingRateHistory(symbol: string, limit?: number, startTimeAtMillis?: number, endTimeAtMillis?: number, page?: number, options?: RawAxiosRequestConfig): AxiosPromise>; /** * Retrieves the leaderboard of traders based on their performance. * @summary /accounts/leaderboard * @param {LeaderboardInterval} [interval] The interval to get the leaderboard for. Default or Unspecified is 7d. * @param {GetLeaderboardSortByEnum} [sortBy] The field to sort by. Default or Unspecified is accountValue. * @param {SortOrder} [sortOrder] The sort order, either ascending (ASC) or descending (DESC). Default or UNSPECIFIED is DESC. * @param {number} [limit] Default 50; max 1000. * @param {number} [page] The page number to retrieve in a paginated response. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getLeaderboard(interval?: LeaderboardInterval, sortBy?: GetLeaderboardSortByEnum, sortOrder?: SortOrder, limit?: number, page?: number, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieves aggregated ticker data for a market. * @summary /exchange/ticker * @param {string} symbol Market symbol. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMarketTicker(symbol: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns the current state of the orderbook. * @summary /exchange/depth * @param {string} symbol Market symbol to get the orderbook depth for. * @param {number} [limit] Maximum number of bids and asks to return. Default 500; max 1000. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOrderbookDepth(symbol: string, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieves recent trades executed on a market. * @summary /exchange/trades * @param {string} symbol The market symbol to get the trades for. * @param {TradeType} [tradeType] Type of trade. * @param {number} [limit] Default 500; max 1000. * @param {number} [startTimeAtMillis] The timestamp specifies the earliest point in time for which data should be returned. The value is not included. * @param {number} [endTimeAtMillis] The timestamp specifies the latest point in time for which data should be returned. The value is included. * @param {number} [page] The page number to retrieve in a paginated response. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRecentTrades(symbol: string, tradeType?: TradeType, limit?: number, startTimeAtMillis?: number, endTimeAtMillis?: number, page?: number, options?: RawAxiosRequestConfig): AxiosPromise>; }; /** * ExchangeApi - object-oriented interface * @export * @class ExchangeApi * @extends {BaseAPI} */ export declare class ExchangeApi extends BaseAPI { /** * Retrieves all market ticker information. * @summary /exchange/tickers * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ExchangeApi */ getAllMarketTicker(options?: RawAxiosRequestConfig): Promise>; /** * Retrieves candle stick data for a market. * @summary /exchange/candlesticks * @param {string} symbol The market symbol to get the klines for. * @param {KlineInterval} interval The interval to get the klines for. * @param {CandlePriceType} type Candle price type (last price, market price, oracle or mark price). * @param {number} [startTimeAtMillis] Timestamp in milliseconds in ms to get klines from. * @param {number} [endTimeAtMillis] Timestamp in milliseconds in ms to get klines until. * @param {number} [limit] Default 50; max 1000. * @param {number} [page] The page number to retrieve in a paginated response. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ExchangeApi */ getCandlestickData(symbol: string, interval: KlineInterval, type: CandlePriceType, startTimeAtMillis?: number, endTimeAtMillis?: number, limit?: number, page?: number, options?: RawAxiosRequestConfig): Promise>; /** * Check if the country is geo restricted. * @summary /exchange/country * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ExchangeApi */ getCountry(options?: RawAxiosRequestConfig): Promise>; /** * Returns the current exchange information including available margin assets, markets, and rules. * @summary /exchange/info * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ExchangeApi */ getExchangeInfo(options?: RawAxiosRequestConfig): Promise>; /** * Retrieves exchange statistics. * @summary /exchange/stats * @param {StatsInterval} [interval] * @param {number} [startTimeAtMillis] Timestamp in milliseconds. * @param {number} [endTimeAtMillis] Timestamp in milliseconds. * @param {number} [limit] Number of records to return. Default is 30; max is 200. * @param {number} [page] The page number to retrieve in a paginated response. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ExchangeApi */ getExchangeStats(interval?: StatsInterval, startTimeAtMillis?: number, endTimeAtMillis?: number, limit?: number, page?: number, options?: RawAxiosRequestConfig): Promise>; /** * Retrieves all time exchange statistics. * @summary /v1/exchange/stats/allTime * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ExchangeApi */ getExchangeStatsAllTime(options?: RawAxiosRequestConfig): Promise>; /** * Retrieve the funding rate history for a specific market address. * @summary /exchange/fundingRateHistory * @param {string} symbol The market symbol to get funding rate history for * @param {number} [limit] Number of records to return. Default is 100; max is 1000. * @param {number} [startTimeAtMillis] The timestamp specifies the earliest point in time for which data should be returned. The value is not included. * @param {number} [endTimeAtMillis] The timestamp specifies the latest point in time for which data should be returned. The value is included. * @param {number} [page] The page number to retrieve in a paginated response. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ExchangeApi */ getFundingRateHistory(symbol: string, limit?: number, startTimeAtMillis?: number, endTimeAtMillis?: number, page?: number, options?: RawAxiosRequestConfig): Promise>; /** * Retrieves the leaderboard of traders based on their performance. * @summary /accounts/leaderboard * @param {LeaderboardInterval} [interval] The interval to get the leaderboard for. Default or Unspecified is 7d. * @param {GetLeaderboardSortByEnum} [sortBy] The field to sort by. Default or Unspecified is accountValue. * @param {SortOrder} [sortOrder] The sort order, either ascending (ASC) or descending (DESC). Default or UNSPECIFIED is DESC. * @param {number} [limit] Default 50; max 1000. * @param {number} [page] The page number to retrieve in a paginated response. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ExchangeApi */ getLeaderboard(interval?: LeaderboardInterval, sortBy?: GetLeaderboardSortByEnum, sortOrder?: SortOrder, limit?: number, page?: number, options?: RawAxiosRequestConfig): Promise>; /** * Retrieves aggregated ticker data for a market. * @summary /exchange/ticker * @param {string} symbol Market symbol. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ExchangeApi */ getMarketTicker(symbol: string, options?: RawAxiosRequestConfig): Promise>; /** * Returns the current state of the orderbook. * @summary /exchange/depth * @param {string} symbol Market symbol to get the orderbook depth for. * @param {number} [limit] Maximum number of bids and asks to return. Default 500; max 1000. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ExchangeApi */ getOrderbookDepth(symbol: string, limit?: number, options?: RawAxiosRequestConfig): Promise>; /** * Retrieves recent trades executed on a market. * @summary /exchange/trades * @param {string} symbol The market symbol to get the trades for. * @param {TradeType} [tradeType] Type of trade. * @param {number} [limit] Default 500; max 1000. * @param {number} [startTimeAtMillis] The timestamp specifies the earliest point in time for which data should be returned. The value is not included. * @param {number} [endTimeAtMillis] The timestamp specifies the latest point in time for which data should be returned. The value is included. * @param {number} [page] The page number to retrieve in a paginated response. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ExchangeApi */ getRecentTrades(symbol: string, tradeType?: TradeType, limit?: number, startTimeAtMillis?: number, endTimeAtMillis?: number, page?: number, options?: RawAxiosRequestConfig): Promise>; } /** * @export */ export declare const GetLeaderboardSortByEnum: { readonly GetLeaderboardSortByAccountValue: "accountValue"; readonly GetLeaderboardSortByPnL: "pnl"; readonly GetLeaderboardSortByVolume: "volume"; readonly GetLeaderboardSortByUNSPECIFIED: "UNSPECIFIED"; }; export type GetLeaderboardSortByEnum = typeof GetLeaderboardSortByEnum[keyof typeof GetLeaderboardSortByEnum]; /** * RewardsApi - axios parameter creator * @export */ export declare const RewardsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Returns detailed earnings breakdown for an affiliate by interval, ordered by interval number in descending order. * @summary /rewards/affiliate/intervalOverview * @param {string} userAddress The address of the user to get interval overview for * @param {number} [page] The page number to retrieve in a paginated response * @param {number} [limit] The page size for pagination * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAffiliateIntervalOverview: (userAddress: string, page?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise; /** * Returns rankings and earnings for affiliates, sorted by the specified category. * @summary /rewards/affiliate/leaderDashboard * @param {GetAffiliateLeaderDashboardSortByEnum} [sortBy] The category to sort rankings by * @param {GetAffiliateLeaderDashboardSortOrderEnum} [sortOrder] The order to sort rankings by * @param {number} [page] The page number to retrieve in a paginated response * @param {number} [limit] The page size for pagination * @param {string} [search] The name/address of the user to filter by * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAffiliateLeaderDashboard: (sortBy?: GetAffiliateLeaderDashboardSortByEnum, sortOrder?: GetAffiliateLeaderDashboardSortOrderEnum, page?: number, limit?: number, search?: string, options?: RawAxiosRequestConfig) => Promise; /** * Returns the affiliate metadata. * @summary /rewards/affiliate * @param {string} userAddress Specify wallet address. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAffiliateMetadata: (userAddress: string, options?: RawAxiosRequestConfig) => Promise; /** * Returns detailed earnings breakdown for an affiliate users earnings (including perps, spot LP, lending), referral earnings, and total earnings. * @summary /rewards/affiliate/overview * @param {string} userAddress Specify wallet address. * @param {number} [page] The page number to retrieve in a paginated response * @param {number} [limit] The page size for pagination * @param {GetAffiliateOverviewSortByEnum} [sortBy] The category to sort earnings by * @param {GetAffiliateOverviewSortOrderEnum} [sortOrder] The order to sort earnings by * @param {string} [search] The name/address of the user to filter by * @param {string} [minEarningsE9] The minimum earnings to filter by * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAffiliateOverview: (userAddress: string, page?: number, limit?: number, sortBy?: GetAffiliateOverviewSortByEnum, sortOrder?: GetAffiliateOverviewSortOrderEnum, search?: string, minEarningsE9?: string, options?: RawAxiosRequestConfig) => Promise; /** * Returns performance summary for an affiliate including total referrals, earnings, and rankings. * @summary /rewards/affiliate/summary * @param {string} userAddress Specify wallet address. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAffiliateSummary: (userAddress: string, options?: RawAxiosRequestConfig) => Promise; /** * Returns the rewards earned by users for a specific campaign. * @summary /rewards/campaign * @param {string} campaignName Specify the campaign name * @param {string} userAddress Specify wallet address. * @param {number} [epochNumber] Optionally specify epoch number. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCampaignRewards: (campaignName: string, userAddress: string, epochNumber?: number, options?: RawAxiosRequestConfig) => Promise; /** * Returns the contract configuration metadata * @summary Get contract configurations * @param {*} [options] Override http request option. * @throws {RequiredError} */ getContractConfig: (options?: RawAxiosRequestConfig) => Promise; /** * Returns the rewards earned by users for the intervals. * @summary /rewards * @param {number} [intervalNumber] Optionally specify interval number. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRewards: (intervalNumber?: number, options?: RawAxiosRequestConfig) => Promise; /** * Returns the metadata for the rewards campaigns. * @summary /rewards/metadata/campaign * @param {string} [campaignName] Specify the campaign name * @param {GetRewardsCampaignMetadataStatusEnum} [status] Optionally specify the status of the campaigns. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRewardsCampaignMetadata: (campaignName?: string, status?: GetRewardsCampaignMetadataStatusEnum, options?: RawAxiosRequestConfig) => Promise; /** * Returns the latest epoch configs for the campaigns. * @summary /rewards/metadata/epoch/configs * @param {number} [intervalNumber] Specify the interval number * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRewardsEpochConfigMetadata: (intervalNumber?: number, options?: RawAxiosRequestConfig) => Promise; /** * Returns the latest or next epoch epoch for campaign. * @summary /rewards/metadata/epoch * @param {string} [campaignName] Specify the campaign name * @param {GetRewardsEpochMetadataEpochEnum} [epoch] Specify the string \"next\" or \"latest\". * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRewardsEpochMetadata: (campaignName?: string, epoch?: GetRewardsEpochMetadataEpochEnum, options?: RawAxiosRequestConfig) => Promise; /** * Returns the interval metadata for provided parameters. * @summary /rewards/metadata/interval * @param {number} [interval] Either specify an interval number or the string \"next\" or \"latest\". * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRewardsIntervalMetadata: (interval?: number, options?: RawAxiosRequestConfig) => Promise; /** * Returns the all time rewards earned by users. * @summary /rewards/summary * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRewardsSummary: (options?: RawAxiosRequestConfig) => Promise; /** * Mark user claims as claimed for the specified campaign name and interval number * @summary /v1/rewards/claims/mark-claimed * @param {MarkAsClaimedRequest} markAsClaimedRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ markAsClaimed: (markAsClaimedRequest: MarkAsClaimedRequest, options?: RawAxiosRequestConfig) => Promise; /** * Submit an application to become an affiliate. * @summary /rewards/affiliate/onboard * @param {OnboardAffiliateRequest} onboardAffiliateRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ onboardAffiliate: (onboardAffiliateRequest: OnboardAffiliateRequest, options?: RawAxiosRequestConfig) => Promise; /** * Onboard a referee with a referral code. * @summary /rewards/affiliate/onboard/referee * @param {OnboardRefereeRequest} onboardRefereeRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ onboardReferee: (onboardRefereeRequest: OnboardRefereeRequest, options?: RawAxiosRequestConfig) => Promise; /** * Update the ember refferal share for an affiliate. * @summary /rewards/affiliate/emberRefferalShare * @param {UpdateAffiliateEmberRefferalShareRequest} updateAffiliateEmberRefferalShareRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateAffiliateEmberRefferalShare: (updateAffiliateEmberRefferalShareRequest: UpdateAffiliateEmberRefferalShareRequest, options?: RawAxiosRequestConfig) => Promise; /** * Update the fee config for an affiliate. * @summary /rewards/affiliate/feeConfig * @param {UpdateAffiliateFeeConfigRequest} updateAffiliateFeeConfigRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateAffiliateFeeConfig: (updateAffiliateFeeConfigRequest: UpdateAffiliateFeeConfigRequest, options?: RawAxiosRequestConfig) => Promise; }; /** * RewardsApi - functional programming interface * @export */ export declare const RewardsApiFp: (configuration?: Configuration) => { /** * Returns detailed earnings breakdown for an affiliate by interval, ordered by interval number in descending order. * @summary /rewards/affiliate/intervalOverview * @param {string} userAddress The address of the user to get interval overview for * @param {number} [page] The page number to retrieve in a paginated response * @param {number} [limit] The page size for pagination * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAffiliateIntervalOverview(userAddress: string, page?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns rankings and earnings for affiliates, sorted by the specified category. * @summary /rewards/affiliate/leaderDashboard * @param {GetAffiliateLeaderDashboardSortByEnum} [sortBy] The category to sort rankings by * @param {GetAffiliateLeaderDashboardSortOrderEnum} [sortOrder] The order to sort rankings by * @param {number} [page] The page number to retrieve in a paginated response * @param {number} [limit] The page size for pagination * @param {string} [search] The name/address of the user to filter by * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAffiliateLeaderDashboard(sortBy?: GetAffiliateLeaderDashboardSortByEnum, sortOrder?: GetAffiliateLeaderDashboardSortOrderEnum, page?: number, limit?: number, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns the affiliate metadata. * @summary /rewards/affiliate * @param {string} userAddress Specify wallet address. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAffiliateMetadata(userAddress: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns detailed earnings breakdown for an affiliate users earnings (including perps, spot LP, lending), referral earnings, and total earnings. * @summary /rewards/affiliate/overview * @param {string} userAddress Specify wallet address. * @param {number} [page] The page number to retrieve in a paginated response * @param {number} [limit] The page size for pagination * @param {GetAffiliateOverviewSortByEnum} [sortBy] The category to sort earnings by * @param {GetAffiliateOverviewSortOrderEnum} [sortOrder] The order to sort earnings by * @param {string} [search] The name/address of the user to filter by * @param {string} [minEarningsE9] The minimum earnings to filter by * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAffiliateOverview(userAddress: string, page?: number, limit?: number, sortBy?: GetAffiliateOverviewSortByEnum, sortOrder?: GetAffiliateOverviewSortOrderEnum, search?: string, minEarningsE9?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns performance summary for an affiliate including total referrals, earnings, and rankings. * @summary /rewards/affiliate/summary * @param {string} userAddress Specify wallet address. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAffiliateSummary(userAddress: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns the rewards earned by users for a specific campaign. * @summary /rewards/campaign * @param {string} campaignName Specify the campaign name * @param {string} userAddress Specify wallet address. * @param {number} [epochNumber] Optionally specify epoch number. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCampaignRewards(campaignName: string, userAddress: string, epochNumber?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * Returns the contract configuration metadata * @summary Get contract configurations * @param {*} [options] Override http request option. * @throws {RequiredError} */ getContractConfig(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns the rewards earned by users for the intervals. * @summary /rewards * @param {number} [intervalNumber] Optionally specify interval number. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRewards(intervalNumber?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * Returns the metadata for the rewards campaigns. * @summary /rewards/metadata/campaign * @param {string} [campaignName] Specify the campaign name * @param {GetRewardsCampaignMetadataStatusEnum} [status] Optionally specify the status of the campaigns. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRewardsCampaignMetadata(campaignName?: string, status?: GetRewardsCampaignMetadataStatusEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * Returns the latest epoch configs for the campaigns. * @summary /rewards/metadata/epoch/configs * @param {number} [intervalNumber] Specify the interval number * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRewardsEpochConfigMetadata(intervalNumber?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns the latest or next epoch epoch for campaign. * @summary /rewards/metadata/epoch * @param {string} [campaignName] Specify the campaign name * @param {GetRewardsEpochMetadataEpochEnum} [epoch] Specify the string \"next\" or \"latest\". * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRewardsEpochMetadata(campaignName?: string, epoch?: GetRewardsEpochMetadataEpochEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * Returns the interval metadata for provided parameters. * @summary /rewards/metadata/interval * @param {number} [interval] Either specify an interval number or the string \"next\" or \"latest\". * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRewardsIntervalMetadata(interval?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * Returns the all time rewards earned by users. * @summary /rewards/summary * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRewardsSummary(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * Mark user claims as claimed for the specified campaign name and interval number * @summary /v1/rewards/claims/mark-claimed * @param {MarkAsClaimedRequest} markAsClaimedRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ markAsClaimed(markAsClaimedRequest: MarkAsClaimedRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Submit an application to become an affiliate. * @summary /rewards/affiliate/onboard * @param {OnboardAffiliateRequest} onboardAffiliateRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ onboardAffiliate(onboardAffiliateRequest: OnboardAffiliateRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Onboard a referee with a referral code. * @summary /rewards/affiliate/onboard/referee * @param {OnboardRefereeRequest} onboardRefereeRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ onboardReferee(onboardRefereeRequest: OnboardRefereeRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update the ember refferal share for an affiliate. * @summary /rewards/affiliate/emberRefferalShare * @param {UpdateAffiliateEmberRefferalShareRequest} updateAffiliateEmberRefferalShareRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateAffiliateEmberRefferalShare(updateAffiliateEmberRefferalShareRequest: UpdateAffiliateEmberRefferalShareRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update the fee config for an affiliate. * @summary /rewards/affiliate/feeConfig * @param {UpdateAffiliateFeeConfigRequest} updateAffiliateFeeConfigRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateAffiliateFeeConfig(updateAffiliateFeeConfigRequest: UpdateAffiliateFeeConfigRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * RewardsApi - factory interface * @export */ export declare const RewardsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Returns detailed earnings breakdown for an affiliate by interval, ordered by interval number in descending order. * @summary /rewards/affiliate/intervalOverview * @param {string} userAddress The address of the user to get interval overview for * @param {number} [page] The page number to retrieve in a paginated response * @param {number} [limit] The page size for pagination * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAffiliateIntervalOverview(userAddress: string, page?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns rankings and earnings for affiliates, sorted by the specified category. * @summary /rewards/affiliate/leaderDashboard * @param {GetAffiliateLeaderDashboardSortByEnum} [sortBy] The category to sort rankings by * @param {GetAffiliateLeaderDashboardSortOrderEnum} [sortOrder] The order to sort rankings by * @param {number} [page] The page number to retrieve in a paginated response * @param {number} [limit] The page size for pagination * @param {string} [search] The name/address of the user to filter by * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAffiliateLeaderDashboard(sortBy?: GetAffiliateLeaderDashboardSortByEnum, sortOrder?: GetAffiliateLeaderDashboardSortOrderEnum, page?: number, limit?: number, search?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns the affiliate metadata. * @summary /rewards/affiliate * @param {string} userAddress Specify wallet address. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAffiliateMetadata(userAddress: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns detailed earnings breakdown for an affiliate users earnings (including perps, spot LP, lending), referral earnings, and total earnings. * @summary /rewards/affiliate/overview * @param {string} userAddress Specify wallet address. * @param {number} [page] The page number to retrieve in a paginated response * @param {number} [limit] The page size for pagination * @param {GetAffiliateOverviewSortByEnum} [sortBy] The category to sort earnings by * @param {GetAffiliateOverviewSortOrderEnum} [sortOrder] The order to sort earnings by * @param {string} [search] The name/address of the user to filter by * @param {string} [minEarningsE9] The minimum earnings to filter by * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAffiliateOverview(userAddress: string, page?: number, limit?: number, sortBy?: GetAffiliateOverviewSortByEnum, sortOrder?: GetAffiliateOverviewSortOrderEnum, search?: string, minEarningsE9?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns performance summary for an affiliate including total referrals, earnings, and rankings. * @summary /rewards/affiliate/summary * @param {string} userAddress Specify wallet address. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAffiliateSummary(userAddress: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns the rewards earned by users for a specific campaign. * @summary /rewards/campaign * @param {string} campaignName Specify the campaign name * @param {string} userAddress Specify wallet address. * @param {number} [epochNumber] Optionally specify epoch number. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCampaignRewards(campaignName: string, userAddress: string, epochNumber?: number, options?: RawAxiosRequestConfig): AxiosPromise>; /** * Returns the contract configuration metadata * @summary Get contract configurations * @param {*} [options] Override http request option. * @throws {RequiredError} */ getContractConfig(options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns the rewards earned by users for the intervals. * @summary /rewards * @param {number} [intervalNumber] Optionally specify interval number. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRewards(intervalNumber?: number, options?: RawAxiosRequestConfig): AxiosPromise>; /** * Returns the metadata for the rewards campaigns. * @summary /rewards/metadata/campaign * @param {string} [campaignName] Specify the campaign name * @param {GetRewardsCampaignMetadataStatusEnum} [status] Optionally specify the status of the campaigns. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRewardsCampaignMetadata(campaignName?: string, status?: GetRewardsCampaignMetadataStatusEnum, options?: RawAxiosRequestConfig): AxiosPromise>; /** * Returns the latest epoch configs for the campaigns. * @summary /rewards/metadata/epoch/configs * @param {number} [intervalNumber] Specify the interval number * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRewardsEpochConfigMetadata(intervalNumber?: number, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns the latest or next epoch epoch for campaign. * @summary /rewards/metadata/epoch * @param {string} [campaignName] Specify the campaign name * @param {GetRewardsEpochMetadataEpochEnum} [epoch] Specify the string \"next\" or \"latest\". * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRewardsEpochMetadata(campaignName?: string, epoch?: GetRewardsEpochMetadataEpochEnum, options?: RawAxiosRequestConfig): AxiosPromise>; /** * Returns the interval metadata for provided parameters. * @summary /rewards/metadata/interval * @param {number} [interval] Either specify an interval number or the string \"next\" or \"latest\". * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRewardsIntervalMetadata(interval?: number, options?: RawAxiosRequestConfig): AxiosPromise>; /** * Returns the all time rewards earned by users. * @summary /rewards/summary * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRewardsSummary(options?: RawAxiosRequestConfig): AxiosPromise>; /** * Mark user claims as claimed for the specified campaign name and interval number * @summary /v1/rewards/claims/mark-claimed * @param {MarkAsClaimedRequest} markAsClaimedRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ markAsClaimed(markAsClaimedRequest: MarkAsClaimedRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Submit an application to become an affiliate. * @summary /rewards/affiliate/onboard * @param {OnboardAffiliateRequest} onboardAffiliateRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ onboardAffiliate(onboardAffiliateRequest: OnboardAffiliateRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Onboard a referee with a referral code. * @summary /rewards/affiliate/onboard/referee * @param {OnboardRefereeRequest} onboardRefereeRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ onboardReferee(onboardRefereeRequest: OnboardRefereeRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Update the ember refferal share for an affiliate. * @summary /rewards/affiliate/emberRefferalShare * @param {UpdateAffiliateEmberRefferalShareRequest} updateAffiliateEmberRefferalShareRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateAffiliateEmberRefferalShare(updateAffiliateEmberRefferalShareRequest: UpdateAffiliateEmberRefferalShareRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Update the fee config for an affiliate. * @summary /rewards/affiliate/feeConfig * @param {UpdateAffiliateFeeConfigRequest} updateAffiliateFeeConfigRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateAffiliateFeeConfig(updateAffiliateFeeConfigRequest: UpdateAffiliateFeeConfigRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * RewardsApi - object-oriented interface * @export * @class RewardsApi * @extends {BaseAPI} */ export declare class RewardsApi extends BaseAPI { /** * Returns detailed earnings breakdown for an affiliate by interval, ordered by interval number in descending order. * @summary /rewards/affiliate/intervalOverview * @param {string} userAddress The address of the user to get interval overview for * @param {number} [page] The page number to retrieve in a paginated response * @param {number} [limit] The page size for pagination * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof RewardsApi */ getAffiliateIntervalOverview(userAddress: string, page?: number, limit?: number, options?: RawAxiosRequestConfig): Promise>; /** * Returns rankings and earnings for affiliates, sorted by the specified category. * @summary /rewards/affiliate/leaderDashboard * @param {GetAffiliateLeaderDashboardSortByEnum} [sortBy] The category to sort rankings by * @param {GetAffiliateLeaderDashboardSortOrderEnum} [sortOrder] The order to sort rankings by * @param {number} [page] The page number to retrieve in a paginated response * @param {number} [limit] The page size for pagination * @param {string} [search] The name/address of the user to filter by * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof RewardsApi */ getAffiliateLeaderDashboard(sortBy?: GetAffiliateLeaderDashboardSortByEnum, sortOrder?: GetAffiliateLeaderDashboardSortOrderEnum, page?: number, limit?: number, search?: string, options?: RawAxiosRequestConfig): Promise>; /** * Returns the affiliate metadata. * @summary /rewards/affiliate * @param {string} userAddress Specify wallet address. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof RewardsApi */ getAffiliateMetadata(userAddress: string, options?: RawAxiosRequestConfig): Promise>; /** * Returns detailed earnings breakdown for an affiliate users earnings (including perps, spot LP, lending), referral earnings, and total earnings. * @summary /rewards/affiliate/overview * @param {string} userAddress Specify wallet address. * @param {number} [page] The page number to retrieve in a paginated response * @param {number} [limit] The page size for pagination * @param {GetAffiliateOverviewSortByEnum} [sortBy] The category to sort earnings by * @param {GetAffiliateOverviewSortOrderEnum} [sortOrder] The order to sort earnings by * @param {string} [search] The name/address of the user to filter by * @param {string} [minEarningsE9] The minimum earnings to filter by * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof RewardsApi */ getAffiliateOverview(userAddress: string, page?: number, limit?: number, sortBy?: GetAffiliateOverviewSortByEnum, sortOrder?: GetAffiliateOverviewSortOrderEnum, search?: string, minEarningsE9?: string, options?: RawAxiosRequestConfig): Promise>; /** * Returns performance summary for an affiliate including total referrals, earnings, and rankings. * @summary /rewards/affiliate/summary * @param {string} userAddress Specify wallet address. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof RewardsApi */ getAffiliateSummary(userAddress: string, options?: RawAxiosRequestConfig): Promise>; /** * Returns the rewards earned by users for a specific campaign. * @summary /rewards/campaign * @param {string} campaignName Specify the campaign name * @param {string} userAddress Specify wallet address. * @param {number} [epochNumber] Optionally specify epoch number. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof RewardsApi */ getCampaignRewards(campaignName: string, userAddress: string, epochNumber?: number, options?: RawAxiosRequestConfig): Promise>; /** * Returns the contract configuration metadata * @summary Get contract configurations * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof RewardsApi */ getContractConfig(options?: RawAxiosRequestConfig): Promise>; /** * Returns the rewards earned by users for the intervals. * @summary /rewards * @param {number} [intervalNumber] Optionally specify interval number. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof RewardsApi */ getRewards(intervalNumber?: number, options?: RawAxiosRequestConfig): Promise>; /** * Returns the metadata for the rewards campaigns. * @summary /rewards/metadata/campaign * @param {string} [campaignName] Specify the campaign name * @param {GetRewardsCampaignMetadataStatusEnum} [status] Optionally specify the status of the campaigns. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof RewardsApi */ getRewardsCampaignMetadata(campaignName?: string, status?: GetRewardsCampaignMetadataStatusEnum, options?: RawAxiosRequestConfig): Promise>; /** * Returns the latest epoch configs for the campaigns. * @summary /rewards/metadata/epoch/configs * @param {number} [intervalNumber] Specify the interval number * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof RewardsApi */ getRewardsEpochConfigMetadata(intervalNumber?: number, options?: RawAxiosRequestConfig): Promise>; /** * Returns the latest or next epoch epoch for campaign. * @summary /rewards/metadata/epoch * @param {string} [campaignName] Specify the campaign name * @param {GetRewardsEpochMetadataEpochEnum} [epoch] Specify the string \"next\" or \"latest\". * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof RewardsApi */ getRewardsEpochMetadata(campaignName?: string, epoch?: GetRewardsEpochMetadataEpochEnum, options?: RawAxiosRequestConfig): Promise>; /** * Returns the interval metadata for provided parameters. * @summary /rewards/metadata/interval * @param {number} [interval] Either specify an interval number or the string \"next\" or \"latest\". * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof RewardsApi */ getRewardsIntervalMetadata(interval?: number, options?: RawAxiosRequestConfig): Promise>; /** * Returns the all time rewards earned by users. * @summary /rewards/summary * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof RewardsApi */ getRewardsSummary(options?: RawAxiosRequestConfig): Promise>; /** * Mark user claims as claimed for the specified campaign name and interval number * @summary /v1/rewards/claims/mark-claimed * @param {MarkAsClaimedRequest} markAsClaimedRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof RewardsApi */ markAsClaimed(markAsClaimedRequest: MarkAsClaimedRequest, options?: RawAxiosRequestConfig): Promise>; /** * Submit an application to become an affiliate. * @summary /rewards/affiliate/onboard * @param {OnboardAffiliateRequest} onboardAffiliateRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof RewardsApi */ onboardAffiliate(onboardAffiliateRequest: OnboardAffiliateRequest, options?: RawAxiosRequestConfig): Promise>; /** * Onboard a referee with a referral code. * @summary /rewards/affiliate/onboard/referee * @param {OnboardRefereeRequest} onboardRefereeRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof RewardsApi */ onboardReferee(onboardRefereeRequest: OnboardRefereeRequest, options?: RawAxiosRequestConfig): Promise>; /** * Update the ember refferal share for an affiliate. * @summary /rewards/affiliate/emberRefferalShare * @param {UpdateAffiliateEmberRefferalShareRequest} updateAffiliateEmberRefferalShareRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof RewardsApi */ updateAffiliateEmberRefferalShare(updateAffiliateEmberRefferalShareRequest: UpdateAffiliateEmberRefferalShareRequest, options?: RawAxiosRequestConfig): Promise>; /** * Update the fee config for an affiliate. * @summary /rewards/affiliate/feeConfig * @param {UpdateAffiliateFeeConfigRequest} updateAffiliateFeeConfigRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof RewardsApi */ updateAffiliateFeeConfig(updateAffiliateFeeConfigRequest: UpdateAffiliateFeeConfigRequest, options?: RawAxiosRequestConfig): Promise>; } /** * @export */ export declare const GetAffiliateLeaderDashboardSortByEnum: { readonly PerpsRank: "perpsRank"; readonly LendingRank: "lendingRank"; readonly SpotRank: "spotRank"; }; export type GetAffiliateLeaderDashboardSortByEnum = typeof GetAffiliateLeaderDashboardSortByEnum[keyof typeof GetAffiliateLeaderDashboardSortByEnum]; /** * @export */ export declare const GetAffiliateLeaderDashboardSortOrderEnum: { readonly Asc: "asc"; readonly Desc: "desc"; }; export type GetAffiliateLeaderDashboardSortOrderEnum = typeof GetAffiliateLeaderDashboardSortOrderEnum[keyof typeof GetAffiliateLeaderDashboardSortOrderEnum]; /** * @export */ export declare const GetAffiliateOverviewSortByEnum: { readonly RefreeEarnings: "refreeEarnings"; readonly ReferralEarnings: "referralEarnings"; readonly TotalEarnings: "totalEarnings"; }; export type GetAffiliateOverviewSortByEnum = typeof GetAffiliateOverviewSortByEnum[keyof typeof GetAffiliateOverviewSortByEnum]; /** * @export */ export declare const GetAffiliateOverviewSortOrderEnum: { readonly Asc: "asc"; readonly Desc: "desc"; }; export type GetAffiliateOverviewSortOrderEnum = typeof GetAffiliateOverviewSortOrderEnum[keyof typeof GetAffiliateOverviewSortOrderEnum]; /** * @export */ export declare const GetRewardsCampaignMetadataStatusEnum: { readonly Active: "ACTIVE"; readonly Inactive: "INACTIVE"; }; export type GetRewardsCampaignMetadataStatusEnum = typeof GetRewardsCampaignMetadataStatusEnum[keyof typeof GetRewardsCampaignMetadataStatusEnum]; /** * @export */ export declare const GetRewardsEpochMetadataEpochEnum: { readonly Next: "next"; readonly Latest: "latest"; }; export type GetRewardsEpochMetadataEpochEnum = typeof GetRewardsEpochMetadataEpochEnum[keyof typeof GetRewardsEpochMetadataEpochEnum]; /** * StreamsApi - axios parameter creator * @export */ export declare const StreamsApiAxiosParamCreator: (configuration?: Configuration) => { /** * WebSocket Account Streams URL. * @param {string} authorization * @param {WebSocketAccountDataUpgradeEnum} upgrade * @param {string} secWebSocketKey WebSocket key used during the handshake. * @param {WebSocketAccountDataSecWebSocketVersionEnum} secWebSocketVersion WebSocket protocol version. * @param {*} [options] Override http request option. * @throws {RequiredError} */ webSocketAccountData: (authorization: string, upgrade: WebSocketAccountDataUpgradeEnum, secWebSocketKey: string, secWebSocketVersion: WebSocketAccountDataSecWebSocketVersionEnum, options?: RawAxiosRequestConfig) => Promise; /** * WebSocket Market Streams URL. * @param {WebSocketMarketDataUpgradeEnum} upgrade * @param {string} secWebSocketKey WebSocket key used during the handshake. * @param {WebSocketMarketDataSecWebSocketVersionEnum} secWebSocketVersion WebSocket protocol version. * @param {*} [options] Override http request option. * @throws {RequiredError} */ webSocketMarketData: (upgrade: WebSocketMarketDataUpgradeEnum, secWebSocketKey: string, secWebSocketVersion: WebSocketMarketDataSecWebSocketVersionEnum, options?: RawAxiosRequestConfig) => Promise; }; /** * StreamsApi - functional programming interface * @export */ export declare const StreamsApiFp: (configuration?: Configuration) => { /** * WebSocket Account Streams URL. * @param {string} authorization * @param {WebSocketAccountDataUpgradeEnum} upgrade * @param {string} secWebSocketKey WebSocket key used during the handshake. * @param {WebSocketAccountDataSecWebSocketVersionEnum} secWebSocketVersion WebSocket protocol version. * @param {*} [options] Override http request option. * @throws {RequiredError} */ webSocketAccountData(authorization: string, upgrade: WebSocketAccountDataUpgradeEnum, secWebSocketKey: string, secWebSocketVersion: WebSocketAccountDataSecWebSocketVersionEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * WebSocket Market Streams URL. * @param {WebSocketMarketDataUpgradeEnum} upgrade * @param {string} secWebSocketKey WebSocket key used during the handshake. * @param {WebSocketMarketDataSecWebSocketVersionEnum} secWebSocketVersion WebSocket protocol version. * @param {*} [options] Override http request option. * @throws {RequiredError} */ webSocketMarketData(upgrade: WebSocketMarketDataUpgradeEnum, secWebSocketKey: string, secWebSocketVersion: WebSocketMarketDataSecWebSocketVersionEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * StreamsApi - factory interface * @export */ export declare const StreamsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * WebSocket Account Streams URL. * @param {string} authorization * @param {WebSocketAccountDataUpgradeEnum} upgrade * @param {string} secWebSocketKey WebSocket key used during the handshake. * @param {WebSocketAccountDataSecWebSocketVersionEnum} secWebSocketVersion WebSocket protocol version. * @param {*} [options] Override http request option. * @throws {RequiredError} */ webSocketAccountData(authorization: string, upgrade: WebSocketAccountDataUpgradeEnum, secWebSocketKey: string, secWebSocketVersion: WebSocketAccountDataSecWebSocketVersionEnum, options?: RawAxiosRequestConfig): AxiosPromise; /** * WebSocket Market Streams URL. * @param {WebSocketMarketDataUpgradeEnum} upgrade * @param {string} secWebSocketKey WebSocket key used during the handshake. * @param {WebSocketMarketDataSecWebSocketVersionEnum} secWebSocketVersion WebSocket protocol version. * @param {*} [options] Override http request option. * @throws {RequiredError} */ webSocketMarketData(upgrade: WebSocketMarketDataUpgradeEnum, secWebSocketKey: string, secWebSocketVersion: WebSocketMarketDataSecWebSocketVersionEnum, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * StreamsApi - object-oriented interface * @export * @class StreamsApi * @extends {BaseAPI} */ export declare class StreamsApi extends BaseAPI { /** * WebSocket Account Streams URL. * @param {string} authorization * @param {WebSocketAccountDataUpgradeEnum} upgrade * @param {string} secWebSocketKey WebSocket key used during the handshake. * @param {WebSocketAccountDataSecWebSocketVersionEnum} secWebSocketVersion WebSocket protocol version. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StreamsApi */ webSocketAccountData(authorization: string, upgrade: WebSocketAccountDataUpgradeEnum, secWebSocketKey: string, secWebSocketVersion: WebSocketAccountDataSecWebSocketVersionEnum, options?: RawAxiosRequestConfig): Promise>; /** * WebSocket Market Streams URL. * @param {WebSocketMarketDataUpgradeEnum} upgrade * @param {string} secWebSocketKey WebSocket key used during the handshake. * @param {WebSocketMarketDataSecWebSocketVersionEnum} secWebSocketVersion WebSocket protocol version. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StreamsApi */ webSocketMarketData(upgrade: WebSocketMarketDataUpgradeEnum, secWebSocketKey: string, secWebSocketVersion: WebSocketMarketDataSecWebSocketVersionEnum, options?: RawAxiosRequestConfig): Promise>; } /** * @export */ export declare const WebSocketAccountDataUpgradeEnum: { readonly Websocket: "websocket"; }; export type WebSocketAccountDataUpgradeEnum = typeof WebSocketAccountDataUpgradeEnum[keyof typeof WebSocketAccountDataUpgradeEnum]; /** * @export */ export declare const WebSocketAccountDataSecWebSocketVersionEnum: { readonly _13: "13"; }; export type WebSocketAccountDataSecWebSocketVersionEnum = typeof WebSocketAccountDataSecWebSocketVersionEnum[keyof typeof WebSocketAccountDataSecWebSocketVersionEnum]; /** * @export */ export declare const WebSocketMarketDataUpgradeEnum: { readonly Websocket: "websocket"; }; export type WebSocketMarketDataUpgradeEnum = typeof WebSocketMarketDataUpgradeEnum[keyof typeof WebSocketMarketDataUpgradeEnum]; /** * @export */ export declare const WebSocketMarketDataSecWebSocketVersionEnum: { readonly _13: "13"; }; export type WebSocketMarketDataSecWebSocketVersionEnum = typeof WebSocketMarketDataSecWebSocketVersionEnum[keyof typeof WebSocketMarketDataSecWebSocketVersionEnum]; /** * TradeApi - axios parameter creator * @export */ export declare const TradeApiAxiosParamCreator: (configuration?: Configuration) => { /** * Cancel orders for a market using order hashes. - May be a single order hash or a list of order hashes. - All orders must belong to the same account. - If no order hashes are specified, then will cancel all orders for the given market - All orders being cancelled by request will receive the same time priority. * @summary /trade/orders/cancel * @param {CancelOrdersRequest} cancelOrdersRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ cancelOrders: (cancelOrdersRequest: CancelOrdersRequest, options?: RawAxiosRequestConfig) => Promise; /** * Cancel orders in standby for a market using order hashes. - May be a single order hash or a list of order hashes. - All orders must belong to the same account. - If no order hashes are specified, then will cancel all orders for the given market - All orders being cancelled by request will receive the same time priority. * @summary /trade/orders/cancel/standby * @param {CancelOrdersRequest} cancelOrdersRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ cancelStandbyOrders: (cancelOrdersRequest: CancelOrdersRequest, options?: RawAxiosRequestConfig) => Promise; /** * Retrieve details of open orders for a specific account. * @summary /trade/openOrders * @param {string} [symbol] Filter by specific perpetual symbol (optional) * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOpenOrders: (symbol?: string, options?: RawAxiosRequestConfig) => Promise; /** * Retrieve details of orders in standby for a specific account. * @summary /trade/standbyOrders * @param {string} [symbol] Filter by specific perpetual symbol (optional) * @param {*} [options] Override http request option. * @throws {RequiredError} */ getStandbyOrders: (symbol?: string, options?: RawAxiosRequestConfig) => Promise; /** * Submit a new order for execution. * @summary /trade/orders * @param {CreateOrderRequest} createOrderRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ postCreateOrder: (createOrderRequest: CreateOrderRequest, options?: RawAxiosRequestConfig) => Promise; /** * Initiates a withdraw action to remove some amount of funds from a user\'s account. * @summary /trade/withdraw * @param {WithdrawRequest} withdrawRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ postWithdraw: (withdrawRequest: WithdrawRequest, options?: RawAxiosRequestConfig) => Promise; /** * Adjust margin for an isolated position on a specific market. * @summary /trade/adjustIsolatedMargin * @param {AdjustIsolatedMarginRequest} adjustIsolatedMarginRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ putAdjustIsolatedMargin: (adjustIsolatedMarginRequest: AdjustIsolatedMarginRequest, options?: RawAxiosRequestConfig) => Promise; /** * Authorizes an account to trade, perform liquidations and more, on behalf of another account. * @summary /trade/accounts/authorize * @param {AccountAuthorizationRequest} accountAuthorizationRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ putAuthorizeAccount: (accountAuthorizationRequest: AccountAuthorizationRequest, options?: RawAxiosRequestConfig) => Promise; /** * Deauthorizes an account to trade, perform liquidations and more, on behalf of another account. * @summary /trade/accounts/deauthorize * @param {AccountAuthorizationRequest} accountAuthorizationRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ putDeauthorizeAccount: (accountAuthorizationRequest: AccountAuthorizationRequest, options?: RawAxiosRequestConfig) => Promise; /** * Updates leverage for positions of a given market and closes all open orders for that market. * @summary /trade/leverage * @param {AccountPositionLeverageUpdateRequest} accountPositionLeverageUpdateRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ putLeverageUpdate: (accountPositionLeverageUpdateRequest: AccountPositionLeverageUpdateRequest, options?: RawAxiosRequestConfig) => Promise; }; /** * TradeApi - functional programming interface * @export */ export declare const TradeApiFp: (configuration?: Configuration) => { /** * Cancel orders for a market using order hashes. - May be a single order hash or a list of order hashes. - All orders must belong to the same account. - If no order hashes are specified, then will cancel all orders for the given market - All orders being cancelled by request will receive the same time priority. * @summary /trade/orders/cancel * @param {CancelOrdersRequest} cancelOrdersRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ cancelOrders(cancelOrdersRequest: CancelOrdersRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Cancel orders in standby for a market using order hashes. - May be a single order hash or a list of order hashes. - All orders must belong to the same account. - If no order hashes are specified, then will cancel all orders for the given market - All orders being cancelled by request will receive the same time priority. * @summary /trade/orders/cancel/standby * @param {CancelOrdersRequest} cancelOrdersRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ cancelStandbyOrders(cancelOrdersRequest: CancelOrdersRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieve details of open orders for a specific account. * @summary /trade/openOrders * @param {string} [symbol] Filter by specific perpetual symbol (optional) * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOpenOrders(symbol?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * Retrieve details of orders in standby for a specific account. * @summary /trade/standbyOrders * @param {string} [symbol] Filter by specific perpetual symbol (optional) * @param {*} [options] Override http request option. * @throws {RequiredError} */ getStandbyOrders(symbol?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * Submit a new order for execution. * @summary /trade/orders * @param {CreateOrderRequest} createOrderRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ postCreateOrder(createOrderRequest: CreateOrderRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Initiates a withdraw action to remove some amount of funds from a user\'s account. * @summary /trade/withdraw * @param {WithdrawRequest} withdrawRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ postWithdraw(withdrawRequest: WithdrawRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Adjust margin for an isolated position on a specific market. * @summary /trade/adjustIsolatedMargin * @param {AdjustIsolatedMarginRequest} adjustIsolatedMarginRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ putAdjustIsolatedMargin(adjustIsolatedMarginRequest: AdjustIsolatedMarginRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Authorizes an account to trade, perform liquidations and more, on behalf of another account. * @summary /trade/accounts/authorize * @param {AccountAuthorizationRequest} accountAuthorizationRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ putAuthorizeAccount(accountAuthorizationRequest: AccountAuthorizationRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Deauthorizes an account to trade, perform liquidations and more, on behalf of another account. * @summary /trade/accounts/deauthorize * @param {AccountAuthorizationRequest} accountAuthorizationRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ putDeauthorizeAccount(accountAuthorizationRequest: AccountAuthorizationRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Updates leverage for positions of a given market and closes all open orders for that market. * @summary /trade/leverage * @param {AccountPositionLeverageUpdateRequest} accountPositionLeverageUpdateRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ putLeverageUpdate(accountPositionLeverageUpdateRequest: AccountPositionLeverageUpdateRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * TradeApi - factory interface * @export */ export declare const TradeApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Cancel orders for a market using order hashes. - May be a single order hash or a list of order hashes. - All orders must belong to the same account. - If no order hashes are specified, then will cancel all orders for the given market - All orders being cancelled by request will receive the same time priority. * @summary /trade/orders/cancel * @param {CancelOrdersRequest} cancelOrdersRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ cancelOrders(cancelOrdersRequest: CancelOrdersRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Cancel orders in standby for a market using order hashes. - May be a single order hash or a list of order hashes. - All orders must belong to the same account. - If no order hashes are specified, then will cancel all orders for the given market - All orders being cancelled by request will receive the same time priority. * @summary /trade/orders/cancel/standby * @param {CancelOrdersRequest} cancelOrdersRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ cancelStandbyOrders(cancelOrdersRequest: CancelOrdersRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieve details of open orders for a specific account. * @summary /trade/openOrders * @param {string} [symbol] Filter by specific perpetual symbol (optional) * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOpenOrders(symbol?: string, options?: RawAxiosRequestConfig): AxiosPromise>; /** * Retrieve details of orders in standby for a specific account. * @summary /trade/standbyOrders * @param {string} [symbol] Filter by specific perpetual symbol (optional) * @param {*} [options] Override http request option. * @throws {RequiredError} */ getStandbyOrders(symbol?: string, options?: RawAxiosRequestConfig): AxiosPromise>; /** * Submit a new order for execution. * @summary /trade/orders * @param {CreateOrderRequest} createOrderRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ postCreateOrder(createOrderRequest: CreateOrderRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Initiates a withdraw action to remove some amount of funds from a user\'s account. * @summary /trade/withdraw * @param {WithdrawRequest} withdrawRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ postWithdraw(withdrawRequest: WithdrawRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Adjust margin for an isolated position on a specific market. * @summary /trade/adjustIsolatedMargin * @param {AdjustIsolatedMarginRequest} adjustIsolatedMarginRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ putAdjustIsolatedMargin(adjustIsolatedMarginRequest: AdjustIsolatedMarginRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Authorizes an account to trade, perform liquidations and more, on behalf of another account. * @summary /trade/accounts/authorize * @param {AccountAuthorizationRequest} accountAuthorizationRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ putAuthorizeAccount(accountAuthorizationRequest: AccountAuthorizationRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Deauthorizes an account to trade, perform liquidations and more, on behalf of another account. * @summary /trade/accounts/deauthorize * @param {AccountAuthorizationRequest} accountAuthorizationRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ putDeauthorizeAccount(accountAuthorizationRequest: AccountAuthorizationRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Updates leverage for positions of a given market and closes all open orders for that market. * @summary /trade/leverage * @param {AccountPositionLeverageUpdateRequest} accountPositionLeverageUpdateRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ putLeverageUpdate(accountPositionLeverageUpdateRequest: AccountPositionLeverageUpdateRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * TradeApi - object-oriented interface * @export * @class TradeApi * @extends {BaseAPI} */ export declare class TradeApi extends BaseAPI { /** * Cancel orders for a market using order hashes. - May be a single order hash or a list of order hashes. - All orders must belong to the same account. - If no order hashes are specified, then will cancel all orders for the given market - All orders being cancelled by request will receive the same time priority. * @summary /trade/orders/cancel * @param {CancelOrdersRequest} cancelOrdersRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TradeApi */ cancelOrders(cancelOrdersRequest: CancelOrdersRequest, options?: RawAxiosRequestConfig): Promise>; /** * Cancel orders in standby for a market using order hashes. - May be a single order hash or a list of order hashes. - All orders must belong to the same account. - If no order hashes are specified, then will cancel all orders for the given market - All orders being cancelled by request will receive the same time priority. * @summary /trade/orders/cancel/standby * @param {CancelOrdersRequest} cancelOrdersRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TradeApi */ cancelStandbyOrders(cancelOrdersRequest: CancelOrdersRequest, options?: RawAxiosRequestConfig): Promise>; /** * Retrieve details of open orders for a specific account. * @summary /trade/openOrders * @param {string} [symbol] Filter by specific perpetual symbol (optional) * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TradeApi */ getOpenOrders(symbol?: string, options?: RawAxiosRequestConfig): Promise>; /** * Retrieve details of orders in standby for a specific account. * @summary /trade/standbyOrders * @param {string} [symbol] Filter by specific perpetual symbol (optional) * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TradeApi */ getStandbyOrders(symbol?: string, options?: RawAxiosRequestConfig): Promise>; /** * Submit a new order for execution. * @summary /trade/orders * @param {CreateOrderRequest} createOrderRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TradeApi */ postCreateOrder(createOrderRequest: CreateOrderRequest, options?: RawAxiosRequestConfig): Promise>; /** * Initiates a withdraw action to remove some amount of funds from a user\'s account. * @summary /trade/withdraw * @param {WithdrawRequest} withdrawRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TradeApi */ postWithdraw(withdrawRequest: WithdrawRequest, options?: RawAxiosRequestConfig): Promise>; /** * Adjust margin for an isolated position on a specific market. * @summary /trade/adjustIsolatedMargin * @param {AdjustIsolatedMarginRequest} adjustIsolatedMarginRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TradeApi */ putAdjustIsolatedMargin(adjustIsolatedMarginRequest: AdjustIsolatedMarginRequest, options?: RawAxiosRequestConfig): Promise>; /** * Authorizes an account to trade, perform liquidations and more, on behalf of another account. * @summary /trade/accounts/authorize * @param {AccountAuthorizationRequest} accountAuthorizationRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TradeApi */ putAuthorizeAccount(accountAuthorizationRequest: AccountAuthorizationRequest, options?: RawAxiosRequestConfig): Promise>; /** * Deauthorizes an account to trade, perform liquidations and more, on behalf of another account. * @summary /trade/accounts/deauthorize * @param {AccountAuthorizationRequest} accountAuthorizationRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TradeApi */ putDeauthorizeAccount(accountAuthorizationRequest: AccountAuthorizationRequest, options?: RawAxiosRequestConfig): Promise>; /** * Updates leverage for positions of a given market and closes all open orders for that market. * @summary /trade/leverage * @param {AccountPositionLeverageUpdateRequest} accountPositionLeverageUpdateRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TradeApi */ putLeverageUpdate(accountPositionLeverageUpdateRequest: AccountPositionLeverageUpdateRequest, options?: RawAxiosRequestConfig): Promise>; } /** * VeraPointsApi - axios parameter creator * @export */ export declare const VeraPointsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Claim a swap transaction for Vera Points attribution. * @summary /vera/swap/claim * @param {SwapClaimRequest} swapClaimRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ claimSwap: (swapClaimRequest: SwapClaimRequest, options?: RawAxiosRequestConfig) => Promise; /** * Claim a vault deposit transaction for Vera Points attribution. * @summary /vera/vault/claim * @param {VaultClaimRequest} vaultClaimRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ claimVault: (vaultClaimRequest: VaultClaimRequest, options?: RawAxiosRequestConfig) => Promise; /** * Returns a user\'s lifetime Vera Points, current tier, rank, and next tier threshold. Public endpoint; user_address is passed as query parameter. * @summary Get user\'s points, tier, and rank * @param {string} userAddress Wallet address to look up balance for. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getBalance: (userAddress: string, options?: RawAxiosRequestConfig) => Promise; /** * Paginated leaderboard ranked by lifetime Vera Points. * @summary Top users by lifetime points * @param {number} [limit] Number of entries to return. * @param {number} [offset] Number of entries to skip. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getLeaderboard: (limit?: number, offset?: number, options?: RawAxiosRequestConfig) => Promise; /** * Record a daily app session for vault points eligibility. user_address is extracted from JWT; session_date is set server-side to the current UTC date. Idempotent — one session per (user, date) pair; multiple calls on the same day are no-ops. This is a required daily gate for vault balance points. * @summary /vera/session * @param {*} [options] Override http request option. * @throws {RequiredError} */ recordSession: (options?: RawAxiosRequestConfig) => Promise; }; /** * VeraPointsApi - functional programming interface * @export */ export declare const VeraPointsApiFp: (configuration?: Configuration) => { /** * Claim a swap transaction for Vera Points attribution. * @summary /vera/swap/claim * @param {SwapClaimRequest} swapClaimRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ claimSwap(swapClaimRequest: SwapClaimRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Claim a vault deposit transaction for Vera Points attribution. * @summary /vera/vault/claim * @param {VaultClaimRequest} vaultClaimRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ claimVault(vaultClaimRequest: VaultClaimRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns a user\'s lifetime Vera Points, current tier, rank, and next tier threshold. Public endpoint; user_address is passed as query parameter. * @summary Get user\'s points, tier, and rank * @param {string} userAddress Wallet address to look up balance for. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getBalance(userAddress: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Paginated leaderboard ranked by lifetime Vera Points. * @summary Top users by lifetime points * @param {number} [limit] Number of entries to return. * @param {number} [offset] Number of entries to skip. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getLeaderboard(limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Record a daily app session for vault points eligibility. user_address is extracted from JWT; session_date is set server-side to the current UTC date. Idempotent — one session per (user, date) pair; multiple calls on the same day are no-ops. This is a required daily gate for vault balance points. * @summary /vera/session * @param {*} [options] Override http request option. * @throws {RequiredError} */ recordSession(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * VeraPointsApi - factory interface * @export */ export declare const VeraPointsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Claim a swap transaction for Vera Points attribution. * @summary /vera/swap/claim * @param {SwapClaimRequest} swapClaimRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ claimSwap(swapClaimRequest: SwapClaimRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Claim a vault deposit transaction for Vera Points attribution. * @summary /vera/vault/claim * @param {VaultClaimRequest} vaultClaimRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ claimVault(vaultClaimRequest: VaultClaimRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns a user\'s lifetime Vera Points, current tier, rank, and next tier threshold. Public endpoint; user_address is passed as query parameter. * @summary Get user\'s points, tier, and rank * @param {string} userAddress Wallet address to look up balance for. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getBalance(userAddress: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Paginated leaderboard ranked by lifetime Vera Points. * @summary Top users by lifetime points * @param {number} [limit] Number of entries to return. * @param {number} [offset] Number of entries to skip. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getLeaderboard(limit?: number, offset?: number, options?: RawAxiosRequestConfig): AxiosPromise; /** * Record a daily app session for vault points eligibility. user_address is extracted from JWT; session_date is set server-side to the current UTC date. Idempotent — one session per (user, date) pair; multiple calls on the same day are no-ops. This is a required daily gate for vault balance points. * @summary /vera/session * @param {*} [options] Override http request option. * @throws {RequiredError} */ recordSession(options?: RawAxiosRequestConfig): AxiosPromise; }; /** * VeraPointsApi - object-oriented interface * @export * @class VeraPointsApi * @extends {BaseAPI} */ export declare class VeraPointsApi extends BaseAPI { /** * Claim a swap transaction for Vera Points attribution. * @summary /vera/swap/claim * @param {SwapClaimRequest} swapClaimRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof VeraPointsApi */ claimSwap(swapClaimRequest: SwapClaimRequest, options?: RawAxiosRequestConfig): Promise>; /** * Claim a vault deposit transaction for Vera Points attribution. * @summary /vera/vault/claim * @param {VaultClaimRequest} vaultClaimRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof VeraPointsApi */ claimVault(vaultClaimRequest: VaultClaimRequest, options?: RawAxiosRequestConfig): Promise>; /** * Returns a user\'s lifetime Vera Points, current tier, rank, and next tier threshold. Public endpoint; user_address is passed as query parameter. * @summary Get user\'s points, tier, and rank * @param {string} userAddress Wallet address to look up balance for. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof VeraPointsApi */ getBalance(userAddress: string, options?: RawAxiosRequestConfig): Promise>; /** * Paginated leaderboard ranked by lifetime Vera Points. * @summary Top users by lifetime points * @param {number} [limit] Number of entries to return. * @param {number} [offset] Number of entries to skip. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof VeraPointsApi */ getLeaderboard(limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise>; /** * Record a daily app session for vault points eligibility. user_address is extracted from JWT; session_date is set server-side to the current UTC date. Idempotent — one session per (user, date) pair; multiple calls on the same day are no-ops. This is a required daily gate for vault balance points. * @summary /vera/session * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof VeraPointsApi */ recordSession(options?: RawAxiosRequestConfig): Promise>; }