@alpaca-open-api/core 0.1.0-rc.0

package/dist/generated/trading/client.d.ts

@@ -0,0 +1,1186 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Trading API
+ * Alpaca's Trading API is a modern platform for algorithmic trading.
+ * OpenAPI spec version: 2.0.1
+ */
+import type { Account, AccountConfigurations, ActivityEventV2, AddAssetToWatchlistBody, AddAssetToWatchlistByNameBody, AddAssetToWatchlistByNameParams, Assets, CalendarParams, CanceledOrderResponse, ClockParams, ClockResp, CreateCryptoTransferRequest, CreateWhitelistedAddressBody, CreateWhitelistedPerpAddressBody, CryptoTransfer, CryptoWallet, DeleteAllOpenPositionsParams, DeleteOpenPositionParams, DeleteWatchlistByNameParams, Error, GetAccountActivitiesByActivityTypeParams, GetAccountActivitiesParams, GetAccountPortfolioHistoryParams, GetAllOrdersParams, GetCryptoPerpAccountLeverage200, GetCryptoPerpAccountLeverageParams, GetCryptoPerpAccountVitals200, GetCryptoPerpTransferEstimate200, GetCryptoPerpTransferEstimateParams, GetCryptoTransferEstimate200, GetCryptoTransferEstimateParams, GetOptionsContracts200, GetOptionsContractsParams, GetOrderByClientOrderIdParams, GetOrderByOrderIDParams, GetTokenizationRequestsParams, GetV2AssetsParams, GetV2CorporateActionsAnnouncements200Item, GetV2CorporateActionsAnnouncementsId200, GetV2CorporateActionsAnnouncementsParams, GetWatchlistByNameParams, LegacyCalendarParams, LegacyClock, LegacyPublicCalendarResp, ListCryptoFundingWalletsParams, ListCryptoPerpFundingWalletsParams, N400Response, N401Response, N403Response, N429Response, N500Response, NonTradeActivities, OptionContract, Order, PatchOrderRequest, PortfolioHistory, Position, PositionClosedReponse, PostOrderBody, PublicCalendarResp, SetCryptoPerpAccountLeverage200, SetCryptoPerpAccountLeverageParams, SubscribeToActivitiesSSEParams, TokenizationMintRequest, TokenizationMintResponse, TokenizationRequest, TradingActivities, UpdateWatchlistByNameParams, UpdateWatchlistRequest, UsCorporatesParams, UsCorporatesResp, UsTreasuriesParams, UsTreasuriesResp, Watchlist, WatchlistWithoutAsset, WhitelistedAddress } from './model/index.js';
+export type subscribeToActivitiesSSEResponse200 = {
+    data: ActivityEventV2[];
+    status: 200;
+};
+export type subscribeToActivitiesSSEResponseSuccess = (subscribeToActivitiesSSEResponse200) & {
+    headers: Headers;
+};
+export type subscribeToActivitiesSSEResponse = (subscribeToActivitiesSSEResponseSuccess);
+export declare const getSubscribeToActivitiesSSEUrl: (params?: SubscribeToActivitiesSSEParams) => string;
+/**
+ * The Events API sends the real-time events and provides historical queries with SSE (Server Sent Events).
+ *
+ * This endpoint streams events on account activities.
+ *
+ * Historical events are streamed immediately if queried, and updates are pushed as events occur.
+ *
+ * Query parameter rules:
+ * - If `until` is specified, `since` is required.
+ * - If `until_id` is specified, `since_id` is required.
+ * - You cannot use `since` and `since_id` together.
+ * Behavior:
+ * - If `since` or `since_id` is not specified, this will not return any historic data.
+ * - If `until` or `until_id` is specified, stream will end at the specified point with status 200.
+ *
+ * ---
+ *
+ * Warning: Currently, OAS-3 does not fully support responses from an SSE API.
+ *
+ * In case the client code is generated from this OAS spec, please do not specify `since` and `until`, as the generated client may hang forever waiting for the response to end.
+ *
+ * If you require the streaming capabilities, we recommend not using the generated clients for this specific endpoint until the OAS-3 standards define how to represent this behavior.
+ *
+ * ---
+ *
+ * ###  Comment messages
+ * According to the SSE specification, any line that starts with a colon is a comment which does not contain data.  It is typically a free text that does not follow any data schema. A few examples mentioned below for comment messages.
+ *
+ * #####  Slow client
+ *
+ * The server sends a comment when the client is not consuming messages fast enough. Example: `: you are reading too slowly, dropped 10000 messages`
+ *
+ * ##### Internal server error
+ *
+ * An error message is sent as a comment when the server closes the connection on an internal server error (only sent by the v2 and v2beta1 endpoints). Example: `: internal server error`
+ *
+ * ---
+ * @summary Subscribe to Activity Events (SSE)
+ */
+export declare const subscribeToActivitiesSSE: (params?: SubscribeToActivitiesSSEParams, options?: RequestInit) => Promise<subscribeToActivitiesSSEResponse>;
+export type getAccountResponse200 = {
+    data: Account;
+    status: 200;
+};
+export type getAccountResponseSuccess = (getAccountResponse200) & {
+    headers: Headers;
+};
+export type getAccountResponse = (getAccountResponseSuccess);
+export declare const getGetAccountUrl: () => string;
+/**
+ * Returns your account details.
+ * @summary Get Account
+ */
+export declare const getAccount: (options?: RequestInit) => Promise<getAccountResponse>;
+export type getAccountActivitiesResponse200 = {
+    data: (TradingActivities | NonTradeActivities)[];
+    status: 200;
+};
+export type getAccountActivitiesResponseSuccess = (getAccountActivitiesResponse200) & {
+    headers: Headers;
+};
+export type getAccountActivitiesResponse = (getAccountActivitiesResponseSuccess);
+export declare const getGetAccountActivitiesUrl: (params?: GetAccountActivitiesParams) => string;
+/**
+ * Returns a list of activities
+ *
+ * Notes:
+ * * Pagination is handled using the `page_token` and `page_size` parameters.
+ * * `page_token` represents the ID of the last item on your current page of results.
+ *    For example, if the ID of the last activity in your first response is `20220203000000000::045b3b8d-c566-4bef-b741-2bf598dd6ae7`, you would pass that value as `page_token` to retrieve the next page of results.
+ * @summary Retrieve Account Activities
+ */
+export declare const getAccountActivities: (params?: GetAccountActivitiesParams, options?: RequestInit) => Promise<getAccountActivitiesResponse>;
+export type getAccountActivitiesByActivityTypeResponse200 = {
+    data: (TradingActivities | NonTradeActivities)[];
+    status: 200;
+};
+export type getAccountActivitiesByActivityTypeResponseSuccess = (getAccountActivitiesByActivityTypeResponse200) & {
+    headers: Headers;
+};
+export type getAccountActivitiesByActivityTypeResponse = (getAccountActivitiesByActivityTypeResponseSuccess);
+export declare const getGetAccountActivitiesByActivityTypeUrl: (activityType: string, params?: GetAccountActivitiesByActivityTypeParams) => string;
+/**
+ * Returns account activity entries for a specific type of activity.
+ * @summary Retrieve Account Activities of Specific Type
+ */
+export declare const getAccountActivitiesByActivityType: (activityType: string, params?: GetAccountActivitiesByActivityTypeParams, options?: RequestInit) => Promise<getAccountActivitiesByActivityTypeResponse>;
+export type getAccountConfigResponse200 = {
+    data: AccountConfigurations;
+    status: 200;
+};
+export type getAccountConfigResponseSuccess = (getAccountConfigResponse200) & {
+    headers: Headers;
+};
+export type getAccountConfigResponse = (getAccountConfigResponseSuccess);
+export declare const getGetAccountConfigUrl: () => string;
+/**
+ * gets the current account configuration values
+ * @summary Get Account Configurations
+ */
+export declare const getAccountConfig: (options?: RequestInit) => Promise<getAccountConfigResponse>;
+export type patchAccountConfigResponse200 = {
+    data: AccountConfigurations;
+    status: 200;
+};
+export type patchAccountConfigResponseSuccess = (patchAccountConfigResponse200) & {
+    headers: Headers;
+};
+export type patchAccountConfigResponse = (patchAccountConfigResponseSuccess);
+export declare const getPatchAccountConfigUrl: () => string;
+/**
+ * Updates and returns the current account configuration values
+ * @summary Account Configurations
+ */
+export declare const patchAccountConfig: (accountConfigurations?: AccountConfigurations, options?: RequestInit) => Promise<patchAccountConfigResponse>;
+export type getAccountPortfolioHistoryResponse200 = {
+    data: PortfolioHistory;
+    status: 200;
+};
+export type getAccountPortfolioHistoryResponseSuccess = (getAccountPortfolioHistoryResponse200) & {
+    headers: Headers;
+};
+export type getAccountPortfolioHistoryResponse = (getAccountPortfolioHistoryResponseSuccess);
+export declare const getGetAccountPortfolioHistoryUrl: (params?: GetAccountPortfolioHistoryParams) => string;
+/**
+ * Returns timeseries data about equity and profit/loss (P/L) of the account in requested timespan.
+ * @summary Get Account Portfolio History
+ */
+export declare const getAccountPortfolioHistory: (params?: GetAccountPortfolioHistoryParams, options?: RequestInit) => Promise<getAccountPortfolioHistoryResponse>;
+export type getV2AssetsResponse200 = {
+    data: Assets[];
+    status: 200;
+};
+export type getV2AssetsResponseSuccess = (getV2AssetsResponse200) & {
+    headers: Headers;
+};
+export type getV2AssetsResponse = (getV2AssetsResponseSuccess);
+export declare const getGetV2AssetsUrl: (params?: GetV2AssetsParams) => string;
+/**
+ * The assets API serves as the master list of assets available for trade and data consumption from Alpaca. Assets are sorted by asset class, exchange and symbol.
+ * @summary Get Assets
+ */
+export declare const getV2Assets: (params?: GetV2AssetsParams, options?: RequestInit) => Promise<getV2AssetsResponse>;
+export type getV2AssetsSymbolOrAssetIdResponse200 = {
+    data: Assets;
+    status: 200;
+};
+export type getV2AssetsSymbolOrAssetIdResponse404 = {
+    data: void;
+    status: 404;
+};
+export type getV2AssetsSymbolOrAssetIdResponseSuccess = (getV2AssetsSymbolOrAssetIdResponse200) & {
+    headers: Headers;
+};
+export type getV2AssetsSymbolOrAssetIdResponseError = (getV2AssetsSymbolOrAssetIdResponse404) & {
+    headers: Headers;
+};
+export type getV2AssetsSymbolOrAssetIdResponse = (getV2AssetsSymbolOrAssetIdResponseSuccess | getV2AssetsSymbolOrAssetIdResponseError);
+export declare const getGetV2AssetsSymbolOrAssetIdUrl: (symbolOrAssetId: string) => string;
+/**
+ * Get the asset model for a given symbol or asset_id. The symbol or asset_id should be passed in as a path parameter.
+ *
+ * **Note**: For crypto, the symbol has to follow old symbology, e.g. BTCUSD.
+ *
+ * **Note**: For coin pairs, the symbol should be separated by a slash (/), e.g. BTC/USDT. Since the slash is a special character in HTTP, use the URL encoded version instead, e.g. /v2/assets/BTC%2FUSDT
+ * @summary Get an Asset by ID or Symbol
+ */
+export declare const getV2AssetsSymbolOrAssetId: (symbolOrAssetId: string, options?: RequestInit) => Promise<getV2AssetsSymbolOrAssetIdResponse>;
+export type usCorporatesResponse200 = {
+    data: UsCorporatesResp;
+    status: 200;
+};
+export type usCorporatesResponse400 = {
+    data: N400Response;
+    status: 400;
+};
+export type usCorporatesResponse401 = {
+    data: N401Response;
+    status: 401;
+};
+export type usCorporatesResponse403 = {
+    data: N403Response;
+    status: 403;
+};
+export type usCorporatesResponse429 = {
+    data: N429Response;
+    status: 429;
+};
+export type usCorporatesResponse500 = {
+    data: N500Response;
+    status: 500;
+};
+export type usCorporatesResponseSuccess = (usCorporatesResponse200) & {
+    headers: Headers;
+};
+export type usCorporatesResponseError = (usCorporatesResponse400 | usCorporatesResponse401 | usCorporatesResponse403 | usCorporatesResponse429 | usCorporatesResponse500) & {
+    headers: Headers;
+};
+export type usCorporatesResponse = (usCorporatesResponseSuccess | usCorporatesResponseError);
+export declare const getUsCorporatesUrl: (params?: UsCorporatesParams) => string;
+/**
+ * Serves the list of US corporates available at Alpaca. The response is sorted by ISIN.
+ * @summary Get US corporates
+ */
+export declare const usCorporates: (params?: UsCorporatesParams, options?: RequestInit) => Promise<usCorporatesResponse>;
+export type usTreasuriesResponse200 = {
+    data: UsTreasuriesResp;
+    status: 200;
+};
+export type usTreasuriesResponse400 = {
+    data: N400Response;
+    status: 400;
+};
+export type usTreasuriesResponse403 = {
+    data: N403Response;
+    status: 403;
+};
+export type usTreasuriesResponse429 = {
+    data: N429Response;
+    status: 429;
+};
+export type usTreasuriesResponse500 = {
+    data: N500Response;
+    status: 500;
+};
+export type usTreasuriesResponseSuccess = (usTreasuriesResponse200) & {
+    headers: Headers;
+};
+export type usTreasuriesResponseError = (usTreasuriesResponse400 | usTreasuriesResponse403 | usTreasuriesResponse429 | usTreasuriesResponse500) & {
+    headers: Headers;
+};
+export type usTreasuriesResponse = (usTreasuriesResponseSuccess | usTreasuriesResponseError);
+export declare const getUsTreasuriesUrl: (params?: UsTreasuriesParams) => string;
+/**
+ * Serves the list of US treasuries available at Alpaca. The response is sorted by ISIN.
+ * @summary Get US treasuries
+ */
+export declare const usTreasuries: (params?: UsTreasuriesParams, options?: RequestInit) => Promise<usTreasuriesResponse>;
+export type legacyCalendarResponse200 = {
+    data: LegacyPublicCalendarResp;
+    status: 200;
+};
+export type legacyCalendarResponse400 = {
+    data: N400Response;
+    status: 400;
+};
+export type legacyCalendarResponse429 = {
+    data: N429Response;
+    status: 429;
+};
+export type legacyCalendarResponse500 = {
+    data: N500Response;
+    status: 500;
+};
+export type legacyCalendarResponseSuccess = (legacyCalendarResponse200) & {
+    headers: Headers;
+};
+export type legacyCalendarResponseError = (legacyCalendarResponse400 | legacyCalendarResponse429 | legacyCalendarResponse500) & {
+    headers: Headers;
+};
+export type legacyCalendarResponse = (legacyCalendarResponseSuccess | legacyCalendarResponseError);
+export declare const getLegacyCalendarUrl: (params?: LegacyCalendarParams) => string;
+/**
+ * The calendar API serves the full list of market days from 1970 to 2029. It can also be queried by specifying a start and/or end time to narrow down the results. In addition to the dates, the response also contains the specific open and close times for the market days, taking into account early closures.
+ * @summary Get US Market Calendar
+ */
+export declare const legacyCalendar: (params?: LegacyCalendarParams, options?: RequestInit) => Promise<legacyCalendarResponse>;
+export type legacyClockResponse200 = {
+    data: LegacyClock;
+    status: 200;
+};
+export type legacyClockResponse429 = {
+    data: N429Response;
+    status: 429;
+};
+export type legacyClockResponse500 = {
+    data: N500Response;
+    status: 500;
+};
+export type legacyClockResponseSuccess = (legacyClockResponse200) & {
+    headers: Headers;
+};
+export type legacyClockResponseError = (legacyClockResponse429 | legacyClockResponse500) & {
+    headers: Headers;
+};
+export type legacyClockResponse = (legacyClockResponseSuccess | legacyClockResponseError);
+export declare const getLegacyClockUrl: () => string;
+/**
+ * The clock API serves the current market timestamp, whether or not the market is currently open, as well as the times of the next market open and close.
+ * @summary Get US Market Clock
+ */
+export declare const legacyClock: (options?: RequestInit) => Promise<legacyClockResponse>;
+export type getV2CorporateActionsAnnouncementsResponse200 = {
+    data: GetV2CorporateActionsAnnouncements200Item[];
+    status: 200;
+};
+export type getV2CorporateActionsAnnouncementsResponseSuccess = (getV2CorporateActionsAnnouncementsResponse200) & {
+    headers: Headers;
+};
+export type getV2CorporateActionsAnnouncementsResponse = (getV2CorporateActionsAnnouncementsResponseSuccess);
+export declare const getGetV2CorporateActionsAnnouncementsUrl: (params: GetV2CorporateActionsAnnouncementsParams) => string;
+/**
+ * This endpoint is deprecated, please use [the new corporate actions endpoint](https://docs.alpaca.markets/reference/corporateactions-1) instead.
+ * @deprecated
+ * @summary Retrieve Announcements
+ */
+export declare const getV2CorporateActionsAnnouncements: (params: GetV2CorporateActionsAnnouncementsParams, options?: RequestInit) => Promise<getV2CorporateActionsAnnouncementsResponse>;
+export type getV2CorporateActionsAnnouncementsIdResponse200 = {
+    data: GetV2CorporateActionsAnnouncementsId200;
+    status: 200;
+};
+export type getV2CorporateActionsAnnouncementsIdResponseSuccess = (getV2CorporateActionsAnnouncementsIdResponse200) & {
+    headers: Headers;
+};
+export type getV2CorporateActionsAnnouncementsIdResponse = (getV2CorporateActionsAnnouncementsIdResponseSuccess);
+export declare const getGetV2CorporateActionsAnnouncementsIdUrl: (id: string) => string;
+/**
+ * This endpoint is deprecated, please use [the new corporate actions endpoint](https://docs.alpaca.markets/reference/corporateactions-1) instead.
+ * @deprecated
+ * @summary Retrieve a Specific Announcement
+ */
+export declare const getV2CorporateActionsAnnouncementsId: (id: string, options?: RequestInit) => Promise<getV2CorporateActionsAnnouncementsIdResponse>;
+export type getOptionsContractsResponse200 = {
+    data: GetOptionsContracts200;
+    status: 200;
+};
+export type getOptionsContractsResponseSuccess = (getOptionsContractsResponse200) & {
+    headers: Headers;
+};
+export type getOptionsContractsResponse = (getOptionsContractsResponseSuccess);
+export declare const getGetOptionsContractsUrl: (params?: GetOptionsContractsParams) => string;
+/**
+ * This endpoint allows you to retrieve a list of option contracts based on various filtering criteria.
+ * By default only active contracts that expire before the upcoming weekend are returned.
+ * @summary Get Option Contracts
+ */
+export declare const getOptionsContracts: (params?: GetOptionsContractsParams, options?: RequestInit) => Promise<getOptionsContractsResponse>;
+export type getOptionContractSymbolOrIdResponse200 = {
+    data: OptionContract;
+    status: 200;
+};
+export type getOptionContractSymbolOrIdResponse404 = {
+    data: Error;
+    status: 404;
+};
+export type getOptionContractSymbolOrIdResponseSuccess = (getOptionContractSymbolOrIdResponse200) & {
+    headers: Headers;
+};
+export type getOptionContractSymbolOrIdResponseError = (getOptionContractSymbolOrIdResponse404) & {
+    headers: Headers;
+};
+export type getOptionContractSymbolOrIdResponse = (getOptionContractSymbolOrIdResponseSuccess | getOptionContractSymbolOrIdResponseError);
+export declare const getGetOptionContractSymbolOrIdUrl: (symbolOrId: string) => string;
+/**
+ * Get an option contract by symbol or contract ID. The symbol or id should be passed in as a path parameter.
+ * @summary Get an option contract by ID or Symbol
+ */
+export declare const getOptionContractSymbolOrId: (symbolOrId: string, options?: RequestInit) => Promise<getOptionContractSymbolOrIdResponse>;
+export type deleteAllOrdersResponse207 = {
+    data: CanceledOrderResponse[];
+    status: 207;
+};
+export type deleteAllOrdersResponse500 = {
+    data: void;
+    status: 500;
+};
+export type deleteAllOrdersResponseSuccess = (deleteAllOrdersResponse207) & {
+    headers: Headers;
+};
+export type deleteAllOrdersResponseError = (deleteAllOrdersResponse500) & {
+    headers: Headers;
+};
+export type deleteAllOrdersResponse = (deleteAllOrdersResponseSuccess | deleteAllOrdersResponseError);
+export declare const getDeleteAllOrdersUrl: () => string;
+/**
+ * Attempts to cancel all open orders. A response will be provided for each order that is attempted to be cancelled. If an order is no longer cancelable, the server will respond with status 500 and reject the request.
+ * @summary Delete All Orders
+ */
+export declare const deleteAllOrders: (options?: RequestInit) => Promise<deleteAllOrdersResponse>;
+export type getAllOrdersResponse200 = {
+    data: Order[];
+    status: 200;
+};
+export type getAllOrdersResponseSuccess = (getAllOrdersResponse200) & {
+    headers: Headers;
+};
+export type getAllOrdersResponse = (getAllOrdersResponseSuccess);
+export declare const getGetAllOrdersUrl: (params?: GetAllOrdersParams) => string;
+/**
+ * Retrieves a list of orders for the account, filtered by the supplied query parameters.
+ * @summary Get All Orders
+ */
+export declare const getAllOrders: (params?: GetAllOrdersParams, options?: RequestInit) => Promise<getAllOrdersResponse>;
+export type postOrderResponse200 = {
+    data: Order;
+    status: 200;
+};
+export type postOrderResponse403 = {
+    data: void;
+    status: 403;
+};
+export type postOrderResponse422 = {
+    data: void;
+    status: 422;
+};
+export type postOrderResponseSuccess = (postOrderResponse200) & {
+    headers: Headers;
+};
+export type postOrderResponseError = (postOrderResponse403 | postOrderResponse422) & {
+    headers: Headers;
+};
+export type postOrderResponse = (postOrderResponseSuccess | postOrderResponseError);
+export declare const getPostOrderUrl: () => string;
+/**
+ * Places a new order for the given account. An order request may be rejected if the account is not authorized for trading, or if the tradable balance is insufficient to fill the order.
+ * @summary Create an Order
+ */
+export declare const postOrder: (postOrderBody: PostOrderBody, options?: RequestInit) => Promise<postOrderResponse>;
+export type deleteOrderByOrderIDResponse204 = {
+    data: void;
+    status: 204;
+};
+export type deleteOrderByOrderIDResponse422 = {
+    data: void;
+    status: 422;
+};
+export type deleteOrderByOrderIDResponseSuccess = (deleteOrderByOrderIDResponse204) & {
+    headers: Headers;
+};
+export type deleteOrderByOrderIDResponseError = (deleteOrderByOrderIDResponse422) & {
+    headers: Headers;
+};
+export type deleteOrderByOrderIDResponse = (deleteOrderByOrderIDResponseSuccess | deleteOrderByOrderIDResponseError);
+export declare const getDeleteOrderByOrderIDUrl: (orderId: string) => string;
+/**
+ * Attempts to cancel an Open Order. If the order is no longer cancelable, the request will be rejected with status 422; otherwise accepted with return status 204.
+ * @summary Delete Order by ID
+ */
+export declare const deleteOrderByOrderID: (orderId: string, options?: RequestInit) => Promise<deleteOrderByOrderIDResponse>;
+export type getOrderByOrderIDResponse200 = {
+    data: Order;
+    status: 200;
+};
+export type getOrderByOrderIDResponseSuccess = (getOrderByOrderIDResponse200) & {
+    headers: Headers;
+};
+export type getOrderByOrderIDResponse = (getOrderByOrderIDResponseSuccess);
+export declare const getGetOrderByOrderIDUrl: (orderId: string, params?: GetOrderByOrderIDParams) => string;
+/**
+ * Retrieves a single order for the given order_id.
+ * @summary Get Order by ID
+ */
+export declare const getOrderByOrderID: (orderId: string, params?: GetOrderByOrderIDParams, options?: RequestInit) => Promise<getOrderByOrderIDResponse>;
+export type patchOrderByOrderIdResponse200 = {
+    data: Order;
+    status: 200;
+};
+export type patchOrderByOrderIdResponseSuccess = (patchOrderByOrderIdResponse200) & {
+    headers: Headers;
+};
+export type patchOrderByOrderIdResponse = (patchOrderByOrderIdResponseSuccess);
+export declare const getPatchOrderByOrderIdUrl: (orderId: string) => string;
+/**
+ * Replaces a single order with updated parameters. Each parameter overrides the corresponding attribute of the existing order. The other attributes remain the same as the existing order.
+ *
+ * A success return code from a replaced order does NOT guarantee the existing open order has been replaced. If the existing open order is filled before the replacing (new) order reaches the execution venue, the replacing (new) order is rejected, and these events are sent in the trade_updates stream channel.
+ *
+ * While an order is being replaced, buying power is reduced by the larger of the two orders that have been placed (the old order being replaced, and the newly placed order to replace it). If you are replacing a buy entry order with a higher limit price than the original order, the buying power is calculated based on the newly placed order. If you are replacing it with a lower limit price, the buying power is calculated based on the old order.
+ *
+ * Note: Order cannot be replaced when the status is `accepted`, `pending_new`, `pending_cancel` or `pending_replace`.
+ *
+ * Note: Notional orders for non-IPO asset classes cannot be replaced. Any attempt to modify a non-IPO notional order via this endpoint will be rejected; cancel it and submit a new one instead.
+ *
+ * Note: IPO indications of interest (`asset_class: "ipo"`) **are** notional and **can** be replaced via this endpoint by providing a new `notional` value. `qty` and `notional` are mutually exclusive on a single replace request.
+ * @summary Replace Order by ID
+ */
+export declare const patchOrderByOrderId: (orderId: string, patchOrderRequest: PatchOrderRequest, options?: RequestInit) => Promise<patchOrderByOrderIdResponse>;
+export type getOrderByClientOrderIdResponse200 = {
+    data: Order;
+    status: 200;
+};
+export type getOrderByClientOrderIdResponseSuccess = (getOrderByClientOrderIdResponse200) & {
+    headers: Headers;
+};
+export type getOrderByClientOrderIdResponse = (getOrderByClientOrderIdResponseSuccess);
+export declare const getGetOrderByClientOrderIdUrl: (params: GetOrderByClientOrderIdParams) => string;
+/**
+ * Retrieves a single order specified by the client order ID.
+ * @summary Get Order by Client Order ID
+ */
+export declare const getOrderByClientOrderId: (params: GetOrderByClientOrderIdParams, options?: RequestInit) => Promise<getOrderByClientOrderIdResponse>;
+export type getCryptoPerpAccountVitalsResponse200 = {
+    data: GetCryptoPerpAccountVitals200;
+    status: 200;
+};
+export type getCryptoPerpAccountVitalsResponseSuccess = (getCryptoPerpAccountVitalsResponse200) & {
+    headers: Headers;
+};
+export type getCryptoPerpAccountVitalsResponse = (getCryptoPerpAccountVitalsResponseSuccess);
+export declare const getGetCryptoPerpAccountVitalsUrl: () => string;
+/**
+ * Fetches key financial metrics for the crypto perpetuals account, providing a snapshot of its current status by detailing the relationship between the user's positions and their collateral. The response includes maintenance margin (USDT), collateral balance (USDT), total collateral (USDT), and profit/loss (USDT)
+ * @summary Retrieve Account Vitals
+ */
+export declare const getCryptoPerpAccountVitals: (options?: RequestInit) => Promise<getCryptoPerpAccountVitalsResponse>;
+export type getCryptoPerpAccountLeverageResponse200 = {
+    data: GetCryptoPerpAccountLeverage200;
+    status: 200;
+};
+export type getCryptoPerpAccountLeverageResponseSuccess = (getCryptoPerpAccountLeverageResponse200) & {
+    headers: Headers;
+};
+export type getCryptoPerpAccountLeverageResponse = (getCryptoPerpAccountLeverageResponseSuccess);
+export declare const getGetCryptoPerpAccountLeverageUrl: (params?: GetCryptoPerpAccountLeverageParams) => string;
+/**
+ * Retrieves the current leverage setting for the crypto perpetuals account, specific to a given underlying asset. To use this endpoint, provide the 'symbol' of the asset as a query parameter. The system will return the asset's symbol and the integer value representing the current leverage applied to it within the account
+ * @summary Get Account Leverage for an Asset
+ */
+export declare const getCryptoPerpAccountLeverage: (params?: GetCryptoPerpAccountLeverageParams, options?: RequestInit) => Promise<getCryptoPerpAccountLeverageResponse>;
+export type setCryptoPerpAccountLeverageResponse200 = {
+    data: SetCryptoPerpAccountLeverage200;
+    status: 200;
+};
+export type setCryptoPerpAccountLeverageResponseSuccess = (setCryptoPerpAccountLeverageResponse200) & {
+    headers: Headers;
+};
+export type setCryptoPerpAccountLeverageResponse = (setCryptoPerpAccountLeverageResponseSuccess);
+export declare const getSetCryptoPerpAccountLeverageUrl: (params?: SetCryptoPerpAccountLeverageParams) => string;
+/**
+ * Updates the leverage for the crypto perpetuals account for a specific underlying asset. Provide the 'symbol' of the asset and the desired 'leverage' (as an integer) using query parameters. The system will return the asset's symbol and the newly set leverage value upon successful update
+ * @summary Set Account Leverage for an Asset
+ */
+export declare const setCryptoPerpAccountLeverage: (params?: SetCryptoPerpAccountLeverageParams, options?: RequestInit) => Promise<setCryptoPerpAccountLeverageResponse>;
+export type listCryptoPerpFundingWalletsResponse200 = {
+    data: CryptoWallet;
+    status: 200;
+};
+export type listCryptoPerpFundingWalletsResponseSuccess = (listCryptoPerpFundingWalletsResponse200) & {
+    headers: Headers;
+};
+export type listCryptoPerpFundingWalletsResponse = (listCryptoPerpFundingWalletsResponseSuccess);
+export declare const getListCryptoPerpFundingWalletsUrl: (params?: ListCryptoPerpFundingWalletsParams) => string;
+/**
+ * Lists wallets for the account given in the path parameter. If an asset is specified and no wallet for the account and asset pair exists one will be created. If no asset is specified only existing wallets will be listed for the account. An account may have at most one wallet per asset
+ * @summary Retrieve Crypto Funding Wallets
+ */
+export declare const listCryptoPerpFundingWallets: (params?: ListCryptoPerpFundingWalletsParams, options?: RequestInit) => Promise<listCryptoPerpFundingWalletsResponse>;
+export type getCryptoPerpTransferEstimateResponse200 = {
+    data: GetCryptoPerpTransferEstimate200;
+    status: 200;
+};
+export type getCryptoPerpTransferEstimateResponseSuccess = (getCryptoPerpTransferEstimateResponse200) & {
+    headers: Headers;
+};
+export type getCryptoPerpTransferEstimateResponse = (getCryptoPerpTransferEstimateResponseSuccess);
+export declare const getGetCryptoPerpTransferEstimateUrl: (params?: GetCryptoPerpTransferEstimateParams) => string;
+/**
+ * Returns the estimated on-chain network (gas) fee for a proposed withdrawal from a perpetuals wallet at current chain conditions. Pass the `asset`, `from_address`, `to_address`, and `amount` you intend to send; the response reports the network fee that would be charged for the corresponding transaction.
+ * @summary Returns the estimated gas fee for a proposed transaction
+ */
+export declare const getCryptoPerpTransferEstimate: (params?: GetCryptoPerpTransferEstimateParams, options?: RequestInit) => Promise<getCryptoPerpTransferEstimateResponse>;
+export type listCryptoPerpFundingTransfersResponse200 = {
+    data: CryptoTransfer;
+    status: 200;
+};
+export type listCryptoPerpFundingTransfersResponseSuccess = (listCryptoPerpFundingTransfersResponse200) & {
+    headers: Headers;
+};
+export type listCryptoPerpFundingTransfersResponse = (listCryptoPerpFundingTransfersResponseSuccess);
+export declare const getListCryptoPerpFundingTransfersUrl: () => string;
+/**
+ * Returns an array of all transfers associated with the given account across all wallets
+ * @summary Retrieve Crypto Funding Transfers
+ */
+export declare const listCryptoPerpFundingTransfers: (options?: RequestInit) => Promise<listCryptoPerpFundingTransfersResponse>;
+export type createCryptoPerpTransferForAccountResponse200 = {
+    data: CryptoTransfer;
+    status: 200;
+};
+export type createCryptoPerpTransferForAccountResponseSuccess = (createCryptoPerpTransferForAccountResponse200) & {
+    headers: Headers;
+};
+export type createCryptoPerpTransferForAccountResponse = (createCryptoPerpTransferForAccountResponseSuccess);
+export declare const getCreateCryptoPerpTransferForAccountUrl: () => string;
+/**
+ * Creates a withdrawal request. Note that outgoing withdrawals must be sent to a whitelisted address and you must whitelist addresses at least 24 hours in advance. If you attempt to withdraw funds to a non-whitelisted address then the transfer will be rejected
+ * @summary Request a New Withdrawal
+ */
+export declare const createCryptoPerpTransferForAccount: (createCryptoTransferRequest: CreateCryptoTransferRequest, options?: RequestInit) => Promise<createCryptoPerpTransferForAccountResponse>;
+export type getCryptoPerpFundingTransferResponse200 = {
+    data: CryptoTransfer;
+    status: 200;
+};
+export type getCryptoPerpFundingTransferResponseSuccess = (getCryptoPerpFundingTransferResponse200) & {
+    headers: Headers;
+};
+export type getCryptoPerpFundingTransferResponse = (getCryptoPerpFundingTransferResponseSuccess);
+export declare const getGetCryptoPerpFundingTransferUrl: (transferId: string) => string;
+/**
+ * Returns a specific wallet transfer by passing into the query the transfer_id
+ * @summary Retrieve a Crypto Funding Transfer
+ */
+export declare const getCryptoPerpFundingTransfer: (transferId: string, options?: RequestInit) => Promise<getCryptoPerpFundingTransferResponse>;
+export type listWhitelistedPerpAddressResponse200 = {
+    data: WhitelistedAddress;
+    status: 200;
+};
+export type listWhitelistedPerpAddressResponseSuccess = (listWhitelistedPerpAddressResponse200) & {
+    headers: Headers;
+};
+export type listWhitelistedPerpAddressResponse = (listWhitelistedPerpAddressResponseSuccess);
+export declare const getListWhitelistedPerpAddressUrl: () => string;
+/**
+ * Returns the list of whitelisted withdrawal addresses for your perpetuals wallets.
+ * @summary An array of whitelisted addresses
+ */
+export declare const listWhitelistedPerpAddress: (options?: RequestInit) => Promise<listWhitelistedPerpAddressResponse>;
+export type createWhitelistedPerpAddressResponse200 = {
+    data: WhitelistedAddress;
+    status: 200;
+};
+export type createWhitelistedPerpAddressResponseSuccess = (createWhitelistedPerpAddressResponse200) & {
+    headers: Headers;
+};
+export type createWhitelistedPerpAddressResponse = (createWhitelistedPerpAddressResponseSuccess);
+export declare const getCreateWhitelistedPerpAddressUrl: () => string;
+/**
+ * Submits a new whitelisted withdrawal address for your perpetuals wallets. The chain is derived from the supplied asset symbol and address, and the same address cannot be whitelisted twice on the same chain.
+ *
+ * Where travel rule reporting applies to your account, address details are validated against the travel rule provider before being persisted.
+ *
+ * Note that whitelisted addresses must wait at least 24 hours before they can be used as a withdrawal destination.
+ * @summary Request a new whitelisted address
+ */
+export declare const createWhitelistedPerpAddress: (createWhitelistedPerpAddressBody: CreateWhitelistedPerpAddressBody, options?: RequestInit) => Promise<createWhitelistedPerpAddressResponse>;
+export type deleteWhitelistedPerpAddressResponse200 = {
+    data: void;
+    status: 200;
+};
+export type deleteWhitelistedPerpAddressResponseSuccess = (deleteWhitelistedPerpAddressResponse200) & {
+    headers: Headers;
+};
+export type deleteWhitelistedPerpAddressResponse = (deleteWhitelistedPerpAddressResponseSuccess);
+export declare const getDeleteWhitelistedPerpAddressUrl: (whitelistedAddressId: string) => string;
+/**
+ * Deletes a whitelisted withdrawal address from your perpetuals wallets by ID. Subsequent withdrawals targeting the deleted address will be rejected.
+ * @summary Delete a whitelisted address
+ */
+export declare const deleteWhitelistedPerpAddress: (whitelistedAddressId: string, options?: RequestInit) => Promise<deleteWhitelistedPerpAddressResponse>;
+export type deleteAllOpenPositionsResponse207 = {
+    data: PositionClosedReponse[];
+    status: 207;
+};
+export type deleteAllOpenPositionsResponse500 = {
+    data: void;
+    status: 500;
+};
+export type deleteAllOpenPositionsResponseSuccess = (deleteAllOpenPositionsResponse207) & {
+    headers: Headers;
+};
+export type deleteAllOpenPositionsResponseError = (deleteAllOpenPositionsResponse500) & {
+    headers: Headers;
+};
+export type deleteAllOpenPositionsResponse = (deleteAllOpenPositionsResponseSuccess | deleteAllOpenPositionsResponseError);
+export declare const getDeleteAllOpenPositionsUrl: (params?: DeleteAllOpenPositionsParams) => string;
+/**
+ * Closes (liquidates) all of the account's open long and short positions. A response will be provided for each order that is attempted to be cancelled. If an order is no longer cancelable, the server will respond with status 500 and reject the request.
+ * @summary Close All Positions
+ */
+export declare const deleteAllOpenPositions: (params?: DeleteAllOpenPositionsParams, options?: RequestInit) => Promise<deleteAllOpenPositionsResponse>;
+export type getAllOpenPositionsResponse200 = {
+    data: Position[];
+    status: 200;
+};
+export type getAllOpenPositionsResponseSuccess = (getAllOpenPositionsResponse200) & {
+    headers: Headers;
+};
+export type getAllOpenPositionsResponse = (getAllOpenPositionsResponseSuccess);
+export declare const getGetAllOpenPositionsUrl: () => string;
+/**
+ * The positions API provides information about an account's current open positions. The response will include information such as cost basis, shares traded, and market value, which will be updated live as price information is updated. Once a position is closed, it will no longer be queryable through this API
+ *
+ * Retrieves a list of the account's open positions
+ * @summary All Open Positions
+ */
+export declare const getAllOpenPositions: (options?: RequestInit) => Promise<getAllOpenPositionsResponse>;
+export type deleteOpenPositionResponse200 = {
+    data: Order;
+    status: 200;
+};
+export type deleteOpenPositionResponseSuccess = (deleteOpenPositionResponse200) & {
+    headers: Headers;
+};
+export type deleteOpenPositionResponse = (deleteOpenPositionResponseSuccess);
+export declare const getDeleteOpenPositionUrl: (symbolOrAssetId: string, params?: DeleteOpenPositionParams) => string;
+/**
+ * Closes (liquidates) the account's open position for the given symbol. Works for both long and short positions.
+ * @summary Close a Position
+ */
+export declare const deleteOpenPosition: (symbolOrAssetId: string, params?: DeleteOpenPositionParams, options?: RequestInit) => Promise<deleteOpenPositionResponse>;
+export type getOpenPositionResponse200 = {
+    data: Position;
+    status: 200;
+};
+export type getOpenPositionResponseSuccess = (getOpenPositionResponse200) & {
+    headers: Headers;
+};
+export type getOpenPositionResponse = (getOpenPositionResponseSuccess);
+export declare const getGetOpenPositionUrl: (symbolOrAssetId: string) => string;
+/**
+ * Retrieves the account's open position for the given symbol or assetId.
+ * @summary Get an Open Position
+ */
+export declare const getOpenPosition: (symbolOrAssetId: string, options?: RequestInit) => Promise<getOpenPositionResponse>;
+export type optionDoNotExerciseResponse200 = {
+    data: void;
+    status: 200;
+};
+export type optionDoNotExerciseResponse403 = {
+    data: Error;
+    status: 403;
+};
+export type optionDoNotExerciseResponse422 = {
+    data: Error;
+    status: 422;
+};
+export type optionDoNotExerciseResponseSuccess = (optionDoNotExerciseResponse200) & {
+    headers: Headers;
+};
+export type optionDoNotExerciseResponseError = (optionDoNotExerciseResponse403 | optionDoNotExerciseResponse422) & {
+    headers: Headers;
+};
+export type optionDoNotExerciseResponse = (optionDoNotExerciseResponseSuccess | optionDoNotExerciseResponseError);
+export declare const getOptionDoNotExerciseUrl: (symbolOrContractId: string) => string;
+/**
+ * This endpoint enables users to submit a do-not-exercise (DNE) instruction for a held option contract, preventing automatic exercise at expiry.
+ * By default, Alpaca will automatically exercise in-the-money (ITM) contracts at expiry. This endpoint allows users to override that behavior.
+ * To override this behavior and submit an exercise instruction, please contact our support team.
+ * @summary Do Not Exercise an Options Position
+ */
+export declare const optionDoNotExercise: (symbolOrContractId: string, options?: RequestInit) => Promise<optionDoNotExerciseResponse>;
+export type optionExerciseResponse200 = {
+    data: void;
+    status: 200;
+};
+export type optionExerciseResponse403 = {
+    data: Error;
+    status: 403;
+};
+export type optionExerciseResponse422 = {
+    data: Error;
+    status: 422;
+};
+export type optionExerciseResponseSuccess = (optionExerciseResponse200) & {
+    headers: Headers;
+};
+export type optionExerciseResponseError = (optionExerciseResponse403 | optionExerciseResponse422) & {
+    headers: Headers;
+};
+export type optionExerciseResponse = (optionExerciseResponseSuccess | optionExerciseResponseError);
+export declare const getOptionExerciseUrl: (symbolOrContractId: string) => string;
+/**
+ * This endpoint enables users to exercise a held option contract, converting it into the underlying asset based on the specified terms.
+ * All available held shares of this option contract will be exercised.
+ * By default, Alpaca will automatically exercise in-the-money (ITM) contracts at expiry.
+ * Exercise requests will be processed immediately once received. Exercise requests submitted between market close and midnight will be rejected to avoid any confusion about when the exercise will settle.
+ * To cancel an exercise request or to submit a Do-not-exercise (DNE) instruction, you can use the do-not-exercise endpoint or contact our support team.
+ * @summary Exercise an Options Position
+ */
+export declare const optionExercise: (symbolOrContractId: string, options?: RequestInit) => Promise<optionExerciseResponse>;
+export type postTokenizationMintResponse200 = {
+    data: TokenizationMintResponse;
+    status: 200;
+};
+export type postTokenizationMintResponse400 = {
+    data: Error;
+    status: 400;
+};
+export type postTokenizationMintResponse401 = {
+    data: Error;
+    status: 401;
+};
+export type postTokenizationMintResponse403 = {
+    data: Error;
+    status: 403;
+};
+export type postTokenizationMintResponse422 = {
+    data: Error;
+    status: 422;
+};
+export type postTokenizationMintResponseSuccess = (postTokenizationMintResponse200) & {
+    headers: Headers;
+};
+export type postTokenizationMintResponseError = (postTokenizationMintResponse400 | postTokenizationMintResponse401 | postTokenizationMintResponse403 | postTokenizationMintResponse422) & {
+    headers: Headers;
+};
+export type postTokenizationMintResponse = (postTokenizationMintResponseSuccess | postTokenizationMintResponseError);
+export declare const getPostTokenizationMintUrl: () => string;
+/**
+ * This endpoint is used by an Authorized Participant to request the minting of a tokenized asset.
+ * @summary Mint a Tokenized Asset
+ */
+export declare const postTokenizationMint: (tokenizationMintRequest: TokenizationMintRequest, options?: RequestInit) => Promise<postTokenizationMintResponse>;
+export type getTokenizationRequestsResponse200 = {
+    data: TokenizationRequest[];
+    status: 200;
+};
+export type getTokenizationRequestsResponse401 = {
+    data: Error;
+    status: 401;
+};
+export type getTokenizationRequestsResponse403 = {
+    data: Error;
+    status: 403;
+};
+export type getTokenizationRequestsResponse422 = {
+    data: Error;
+    status: 422;
+};
+export type getTokenizationRequestsResponseSuccess = (getTokenizationRequestsResponse200) & {
+    headers: Headers;
+};
+export type getTokenizationRequestsResponseError = (getTokenizationRequestsResponse401 | getTokenizationRequestsResponse403 | getTokenizationRequestsResponse422) & {
+    headers: Headers;
+};
+export type getTokenizationRequestsResponse = (getTokenizationRequestsResponseSuccess | getTokenizationRequestsResponseError);
+export declare const getGetTokenizationRequestsUrl: (params?: GetTokenizationRequestsParams) => string;
+/**
+ * An Authorized Participant can use this endpoint to list the tokenization requests performed on the Instant Tokenization Network (ITN).
+ * @summary List Tokenization Requests
+ */
+export declare const getTokenizationRequests: (params?: GetTokenizationRequestsParams, options?: RequestInit) => Promise<getTokenizationRequestsResponse>;
+export type listCryptoFundingWalletsResponse200 = {
+    data: CryptoWallet;
+    status: 200;
+};
+export type listCryptoFundingWalletsResponseSuccess = (listCryptoFundingWalletsResponse200) & {
+    headers: Headers;
+};
+export type listCryptoFundingWalletsResponse = (listCryptoFundingWalletsResponseSuccess);
+export declare const getListCryptoFundingWalletsUrl: (params?: ListCryptoFundingWalletsParams) => string;
+/**
+ * Lists wallets for the account given in the path parameter. If an asset is specified and no wallet for the account and asset pair exists one will be created. If no asset is specified only existing wallets will be listed for the account. An account may have at most one wallet per asset.
+ * @summary Retrieve Crypto Funding Wallets
+ */
+export declare const listCryptoFundingWallets: (params?: ListCryptoFundingWalletsParams, options?: RequestInit) => Promise<listCryptoFundingWalletsResponse>;
+export type getCryptoTransferEstimateResponse200 = {
+    data: GetCryptoTransferEstimate200;
+    status: 200;
+};
+export type getCryptoTransferEstimateResponseSuccess = (getCryptoTransferEstimateResponse200) & {
+    headers: Headers;
+};
+export type getCryptoTransferEstimateResponse = (getCryptoTransferEstimateResponseSuccess);
+export declare const getGetCryptoTransferEstimateUrl: (params?: GetCryptoTransferEstimateParams) => string;
+/**
+ * Returns the estimated on-chain network (gas) fee for a proposed crypto withdrawal at current chain conditions. Pass the `asset`, `from_address`, `to_address`, and `amount` you intend to send; the response reports the network fee that would be charged for the corresponding transaction.
+ * @summary Returns the estimated gas fee for a proposed transaction.
+ */
+export declare const getCryptoTransferEstimate: (params?: GetCryptoTransferEstimateParams, options?: RequestInit) => Promise<getCryptoTransferEstimateResponse>;
+export type listCryptoFundingTransfersResponse200 = {
+    data: CryptoTransfer;
+    status: 200;
+};
+export type listCryptoFundingTransfersResponseSuccess = (listCryptoFundingTransfersResponse200) & {
+    headers: Headers;
+};
+export type listCryptoFundingTransfersResponse = (listCryptoFundingTransfersResponseSuccess);
+export declare const getListCryptoFundingTransfersUrl: () => string;
+/**
+ * Returns an array of all transfers associated with the given account across all wallets.
+ * @summary Retrieve Crypto Funding Transfers
+ */
+export declare const listCryptoFundingTransfers: (options?: RequestInit) => Promise<listCryptoFundingTransfersResponse>;
+export type createCryptoTransferForAccountResponse200 = {
+    data: CryptoTransfer;
+    status: 200;
+};
+export type createCryptoTransferForAccountResponseSuccess = (createCryptoTransferForAccountResponse200) & {
+    headers: Headers;
+};
+export type createCryptoTransferForAccountResponse = (createCryptoTransferForAccountResponseSuccess);
+export declare const getCreateCryptoTransferForAccountUrl: () => string;
+/**
+ * Creates a withdrawal request. Note that outgoing withdrawals must be sent to a whitelisted address and you must whitelist addresses at least 24 hours in advance. If you attempt to withdraw funds to a non-whitelisted address then the transfer will be rejected.
+ * @summary Request a New Withdrawal
+ */
+export declare const createCryptoTransferForAccount: (createCryptoTransferRequest: CreateCryptoTransferRequest, options?: RequestInit) => Promise<createCryptoTransferForAccountResponse>;
+export type getCryptoFundingTransferResponse200 = {
+    data: CryptoTransfer;
+    status: 200;
+};
+export type getCryptoFundingTransferResponseSuccess = (getCryptoFundingTransferResponse200) & {
+    headers: Headers;
+};
+export type getCryptoFundingTransferResponse = (getCryptoFundingTransferResponseSuccess);
+export declare const getGetCryptoFundingTransferUrl: (transferId: string) => string;
+/**
+ * Returns a specific wallet transfer by passing into the query the transfer_id.
+ * @summary Retrieve a Crypto Funding Transfer
+ */
+export declare const getCryptoFundingTransfer: (transferId: string, options?: RequestInit) => Promise<getCryptoFundingTransferResponse>;
+export type listWhitelistedAddressResponse200 = {
+    data: WhitelistedAddress;
+    status: 200;
+};
+export type listWhitelistedAddressResponseSuccess = (listWhitelistedAddressResponse200) & {
+    headers: Headers;
+};
+export type listWhitelistedAddressResponse = (listWhitelistedAddressResponseSuccess);
+export declare const getListWhitelistedAddressUrl: () => string;
+/**
+ * Returns the list of whitelisted withdrawal addresses for your account.
+ * @summary An array of whitelisted addresses
+ */
+export declare const listWhitelistedAddress: (options?: RequestInit) => Promise<listWhitelistedAddressResponse>;
+export type createWhitelistedAddressResponse200 = {
+    data: WhitelistedAddress;
+    status: 200;
+};
+export type createWhitelistedAddressResponseSuccess = (createWhitelistedAddressResponse200) & {
+    headers: Headers;
+};
+export type createWhitelistedAddressResponse = (createWhitelistedAddressResponseSuccess);
+export declare const getCreateWhitelistedAddressUrl: () => string;
+/**
+ * Submits a new whitelisted withdrawal address for your account. The chain is derived from the supplied asset symbol and address, and the same address cannot be whitelisted twice on the same chain.
+ *
+ * Where travel rule reporting applies to your account, address details are validated against the travel rule provider before being persisted.
+ *
+ * Note that whitelisted addresses must wait at least 24 hours before they can be used as a withdrawal destination.
+ * @summary Request a new whitelisted address
+ */
+export declare const createWhitelistedAddress: (createWhitelistedAddressBody: CreateWhitelistedAddressBody, options?: RequestInit) => Promise<createWhitelistedAddressResponse>;
+export type deleteWhitelistedAddressResponse200 = {
+    data: void;
+    status: 200;
+};
+export type deleteWhitelistedAddressResponseSuccess = (deleteWhitelistedAddressResponse200) & {
+    headers: Headers;
+};
+export type deleteWhitelistedAddressResponse = (deleteWhitelistedAddressResponseSuccess);
+export declare const getDeleteWhitelistedAddressUrl: (whitelistedAddressId: string) => string;
+/**
+ * Deletes a whitelisted withdrawal address by ID. Subsequent withdrawals targeting the deleted address will be rejected.
+ * @summary Delete a whitelisted address
+ */
+export declare const deleteWhitelistedAddress: (whitelistedAddressId: string, options?: RequestInit) => Promise<deleteWhitelistedAddressResponse>;
+export type getWatchlistsResponse200 = {
+    data: WatchlistWithoutAsset[];
+    status: 200;
+};
+export type getWatchlistsResponseSuccess = (getWatchlistsResponse200) & {
+    headers: Headers;
+};
+export type getWatchlistsResponse = (getWatchlistsResponseSuccess);
+export declare const getGetWatchlistsUrl: () => string;
+/**
+ * Returns the list of watchlists registered under the account.
+ * @summary Get All Watchlists
+ */
+export declare const getWatchlists: (options?: RequestInit) => Promise<getWatchlistsResponse>;
+export type postWatchlistResponse200 = {
+    data: Watchlist;
+    status: 200;
+};
+export type postWatchlistResponseSuccess = (postWatchlistResponse200) & {
+    headers: Headers;
+};
+export type postWatchlistResponse = (postWatchlistResponseSuccess);
+export declare const getPostWatchlistUrl: () => string;
+/**
+ * Create a new watchlist with initial set of assets.
+ * @summary Create Watchlist
+ */
+export declare const postWatchlist: (updateWatchlistRequest: UpdateWatchlistRequest, options?: RequestInit) => Promise<postWatchlistResponse>;
+export type deleteWatchlistByIdResponse204 = {
+    data: void;
+    status: 204;
+};
+export type deleteWatchlistByIdResponse404 = {
+    data: void;
+    status: 404;
+};
+export type deleteWatchlistByIdResponseSuccess = (deleteWatchlistByIdResponse204) & {
+    headers: Headers;
+};
+export type deleteWatchlistByIdResponseError = (deleteWatchlistByIdResponse404) & {
+    headers: Headers;
+};
+export type deleteWatchlistByIdResponse = (deleteWatchlistByIdResponseSuccess | deleteWatchlistByIdResponseError);
+export declare const getDeleteWatchlistByIdUrl: (watchlistId: string) => string;
+/**
+ * Delete a watchlist. This is a permanent deletion.
+ * @summary Delete Watchlist By Id
+ */
+export declare const deleteWatchlistById: (watchlistId: string, options?: RequestInit) => Promise<deleteWatchlistByIdResponse>;
+export type getWatchlistByIdResponse200 = {
+    data: Watchlist;
+    status: 200;
+};
+export type getWatchlistByIdResponseSuccess = (getWatchlistByIdResponse200) & {
+    headers: Headers;
+};
+export type getWatchlistByIdResponse = (getWatchlistByIdResponseSuccess);
+export declare const getGetWatchlistByIdUrl: (watchlistId: string) => string;
+/**
+ * Returns a watchlist identified by the ID.
+ * @summary Get Watchlist by ID
+ */
+export declare const getWatchlistById: (watchlistId: string, options?: RequestInit) => Promise<getWatchlistByIdResponse>;
+export type addAssetToWatchlistResponse200 = {
+    data: Watchlist;
+    status: 200;
+};
+export type addAssetToWatchlistResponseSuccess = (addAssetToWatchlistResponse200) & {
+    headers: Headers;
+};
+export type addAssetToWatchlistResponse = (addAssetToWatchlistResponseSuccess);
+export declare const getAddAssetToWatchlistUrl: (watchlistId: string) => string;
+/**
+ * Append an asset for the symbol to the end of watchlist asset list
+ * @summary Add Asset to Watchlist
+ */
+export declare const addAssetToWatchlist: (watchlistId: string, addAssetToWatchlistBody?: AddAssetToWatchlistBody, options?: RequestInit) => Promise<addAssetToWatchlistResponse>;
+export type updateWatchlistByIdResponse200 = {
+    data: Watchlist;
+    status: 200;
+};
+export type updateWatchlistByIdResponseSuccess = (updateWatchlistByIdResponse200) & {
+    headers: Headers;
+};
+export type updateWatchlistByIdResponse = (updateWatchlistByIdResponseSuccess);
+export declare const getUpdateWatchlistByIdUrl: (watchlistId: string) => string;
+/**
+ * Update the name and/or content of watchlist
+ * @summary Update Watchlist By Id
+ */
+export declare const updateWatchlistById: (watchlistId: string, updateWatchlistRequest?: UpdateWatchlistRequest, options?: RequestInit) => Promise<updateWatchlistByIdResponse>;
+export type removeAssetFromWatchlistResponse200 = {
+    data: Watchlist;
+    status: 200;
+};
+export type removeAssetFromWatchlistResponseSuccess = (removeAssetFromWatchlistResponse200) & {
+    headers: Headers;
+};
+export type removeAssetFromWatchlistResponse = (removeAssetFromWatchlistResponseSuccess);
+export declare const getRemoveAssetFromWatchlistUrl: (watchlistId: string, symbol: string) => string;
+/**
+ * Delete one entry for an asset by symbol name
+ * @summary Delete Symbol from Watchlist
+ */
+export declare const removeAssetFromWatchlist: (watchlistId: string, symbol: string, options?: RequestInit) => Promise<removeAssetFromWatchlistResponse>;
+export type deleteWatchlistByNameResponse204 = {
+    data: void;
+    status: 204;
+};
+export type deleteWatchlistByNameResponseSuccess = (deleteWatchlistByNameResponse204) & {
+    headers: Headers;
+};
+export type deleteWatchlistByNameResponse = (deleteWatchlistByNameResponseSuccess);
+export declare const getDeleteWatchlistByNameUrl: (params: DeleteWatchlistByNameParams) => string;
+/**
+ * Delete a watchlist. This is a permanent deletion.
+ * @summary Delete Watchlist By Name
+ */
+export declare const deleteWatchlistByName: (params: DeleteWatchlistByNameParams, options?: RequestInit) => Promise<deleteWatchlistByNameResponse>;
+export type getWatchlistByNameResponse200 = {
+    data: Watchlist;
+    status: 200;
+};
+export type getWatchlistByNameResponseSuccess = (getWatchlistByNameResponse200) & {
+    headers: Headers;
+};
+export type getWatchlistByNameResponse = (getWatchlistByNameResponseSuccess);
+export declare const getGetWatchlistByNameUrl: (params: GetWatchlistByNameParams) => string;
+/**
+ * You can also call GET, PUT, POST and DELETE with watchlist name with another endpoint /v2/watchlists:by_name and query parameter name=<watchlist_name>, instead of /v2/watchlists/{watchlist_id} endpoints
+ *
+ * Returns a watchlist by name
+ * @summary Get Watchlist by Name
+ */
+export declare const getWatchlistByName: (params: GetWatchlistByNameParams, options?: RequestInit) => Promise<getWatchlistByNameResponse>;
+export type addAssetToWatchlistByNameResponse200 = {
+    data: Watchlist;
+    status: 200;
+};
+export type addAssetToWatchlistByNameResponseSuccess = (addAssetToWatchlistByNameResponse200) & {
+    headers: Headers;
+};
+export type addAssetToWatchlistByNameResponse = (addAssetToWatchlistByNameResponseSuccess);
+export declare const getAddAssetToWatchlistByNameUrl: (params: AddAssetToWatchlistByNameParams) => string;
+/**
+ * Append an asset for the symbol to the end of watchlist asset list
+ * @summary Add Asset to Watchlist By Name
+ */
+export declare const addAssetToWatchlistByName: (params: AddAssetToWatchlistByNameParams, addAssetToWatchlistByNameBody?: AddAssetToWatchlistByNameBody, options?: RequestInit) => Promise<addAssetToWatchlistByNameResponse>;
+export type updateWatchlistByNameResponse200 = {
+    data: Watchlist;
+    status: 200;
+};
+export type updateWatchlistByNameResponseSuccess = (updateWatchlistByNameResponse200) & {
+    headers: Headers;
+};
+export type updateWatchlistByNameResponse = (updateWatchlistByNameResponseSuccess);
+export declare const getUpdateWatchlistByNameUrl: (params: UpdateWatchlistByNameParams) => string;
+/**
+ * Update the name and/or content of watchlist
+ * @summary Update Watchlist By Name
+ */
+export declare const updateWatchlistByName: (params: UpdateWatchlistByNameParams, updateWatchlistRequest?: UpdateWatchlistRequest, options?: RequestInit) => Promise<updateWatchlistByNameResponse>;
+export type calendarResponse200 = {
+    data: PublicCalendarResp;
+    status: 200;
+};
+export type calendarResponse400 = {
+    data: N400Response;
+    status: 400;
+};
+export type calendarResponse429 = {
+    data: N429Response;
+    status: 429;
+};
+export type calendarResponse500 = {
+    data: N500Response;
+    status: 500;
+};
+export type calendarResponseSuccess = (calendarResponse200) & {
+    headers: Headers;
+};
+export type calendarResponseError = (calendarResponse400 | calendarResponse429 | calendarResponse500) & {
+    headers: Headers;
+};
+export type calendarResponse = (calendarResponseSuccess | calendarResponseError);
+export declare const getCalendarUrl: (market: "BMO" | "BNYM" | "BOATS" | "CEUX" | "CHIX" | "HKEX" | "IEX" | "IEXG" | "ISE" | "LSE" | "MTA" | "MTAA" | "NASDAQ" | "NYSE" | "OCEA" | "OPRA" | "OTC" | "OTCM" | "SIFMA" | "TADAWUL" | "XAMS" | "XBRU" | "XDUB" | "XETR" | "XETRA" | "XHKG" | "XLIS" | "XLON" | "XNAS" | "XNYS" | "XPAR" | "XSAU", params?: CalendarParams) => string;
+/**
+ * This endpoint returns the market calendar.
+ * @summary Get Market Calendar
+ */
+export declare const calendar: (market: "BMO" | "BNYM" | "BOATS" | "CEUX" | "CHIX" | "HKEX" | "IEX" | "IEXG" | "ISE" | "LSE" | "MTA" | "MTAA" | "NASDAQ" | "NYSE" | "OCEA" | "OPRA" | "OTC" | "OTCM" | "SIFMA" | "TADAWUL" | "XAMS" | "XBRU" | "XDUB" | "XETR" | "XETRA" | "XHKG" | "XLIS" | "XLON" | "XNAS" | "XNYS" | "XPAR" | "XSAU", params?: CalendarParams, options?: RequestInit) => Promise<calendarResponse>;
+export type clockResponse200 = {
+    data: ClockResp;
+    status: 200;
+};
+export type clockResponse400 = {
+    data: N400Response;
+    status: 400;
+};
+export type clockResponse429 = {
+    data: N429Response;
+    status: 429;
+};
+export type clockResponse500 = {
+    data: N500Response;
+    status: 500;
+};
+export type clockResponseSuccess = (clockResponse200) & {
+    headers: Headers;
+};
+export type clockResponseError = (clockResponse400 | clockResponse429 | clockResponse500) & {
+    headers: Headers;
+};
+export type clockResponse = (clockResponseSuccess | clockResponseError);
+export declare const getClockUrl: (params?: ClockParams) => string;
+/**
+ * This API serves information about multiple markets: the current time, if it's a market day, the current phase of the market, etc.
+ * @summary Get Market Clock
+ */
+export declare const clock: (params?: ClockParams, options?: RequestInit) => Promise<clockResponse>;