@master-chief/alpaca-ts/dist/services/account.d.ts

A TypeScript Node.js library for the https://alpaca.markets REST API and WebSocket streams.

import { Account } from "../entities/Account.js";
import { BaseHttpRequest } from "../rest/BaseHttpRequest.js";
import { PortfolioHistory } from "../entities/PortfolioHistory.js";
import { CancelablePromise } from "../rest/CancelablePromise.js";
import { TradingActivities } from "../entities/TradingActivities.js";
import { NonTradeActivities } from "../entities/NonTradeActivities.js";
import { AccountConfigurations } from "../entities/AccountConfigurations.js";
/**
 * Get account activities of one type
 * Returns account activity entries for many types of activities.
 * @returns any returns an array of Account activities
 * @throws ApiError
 */
export declare const getAccountActivities: (httpRequest: BaseHttpRequest, { activityTypes, }: {
    /**
     * A comma-separated list of the activity types to include in the response. If unspecified, activities of all types will be returned. (Cannot be used with category)
     */
    activityTypes?: "trade_activity" | "non_trade_activity";
}) => CancelablePromise<Array<TradingActivities | NonTradeActivities>>;
/**
 * Get account activities of one type
 * Returns account activity entries for a specific type of activity.
 * @returns any returns an array of Account activities
 * @throws ApiError
 */
export declare const getAccountActivitiesByType: (httpRequest: BaseHttpRequest, { activityType, date, until, after, direction, pageSize, pageToken, category, }: {
    /**
     * The activity type you want to view entries for. A list of valid activity types can be found at the bottom of this page.
     */
    activityType: string;
    /**
     * The date for which you want to see activities.
     */
    date?: string;
    /**
     * The response will contain only activities submitted before this date. (Cannot be used with date.)
     */
    until?: string;
    /**
     * The response will contain only activities submitted after this date. (Cannot be used with date.)
     */
    after?: string;
    /**
     * asc or desc (default desc if unspecified.)
     */
    direction?: "asc" | "desc";
    /**
     * The maximum number of entries to return in the response. (See the section on paging above.)
     */
    pageSize?: number;
    /**
     * The ID of the end of your current page of results.
     */
    pageToken?: string;
    /**
     * trade_activity or non_trade_activity, to specify the kind of results the server should return. (Cannot be used with /{activity_type} or ?activity_types=...)
     */
    category?: string;
}) => CancelablePromise<Array<TradingActivities | NonTradeActivities>>;
/**
 * Get account
 * Returns the account associated with the API key.
 * @returns Account OK
 * @throws ApiError
 */
export declare const getAccount: (httpRequest: BaseHttpRequest) => CancelablePromise<Account>;
/**
 * Account Portfolio History
 * Returns timeseries data about equity and profit/loss (P/L) of the account in requested timespan.
 * @returns PortfolioHistory Successful response
 * @throws ApiError
 */
export declare const getAccountPortfolioHistory: (httpRequest: BaseHttpRequest, { period, timeframe, dateEnd, extendedHours, }: {
    /**
     * The duration of the data in <number> + <unit>, such as 1D, where <unit> can be D for day, W for week, M for month and A for year. Defaults to 1M.
     */
    period?: string;
    /**
     * The resolution of time window. 1Min, 5Min, 15Min, 1H, or 1D. If omitted, 1Min for less than 7 days period, 15Min for less than 30 days, or otherwise 1D.
     */
    timeframe?: string;
    /**
     * The date the data is returned up to, in “YYYY-MM-DD” format. Defaults to the current market date (rolls over at the market open if extended_hours is false, otherwise at 7am ET)
     */
    dateEnd?: string;
    /**
     * If true, include extended hours in the result. This is effective only for timeframe less than 1D.
     */
    extendedHours?: string;
}) => CancelablePromise<PortfolioHistory>;
/**
 * Account Configurations
 * gets the current account configuration values
 * @returns AccountConfigurations Successful response
 * @throws ApiError
 */
export declare const getAccountConfigurations: (httpRequest: BaseHttpRequest) => CancelablePromise<AccountConfigurations>;
/**
 * Account Configurations
 * Updates and returns the current account configuration values
 * @returns AccountConfigurations Successful response
 * @throws ApiError
 */
export declare const patchAccountConfigurations: (httpRequest: BaseHttpRequest, { requestBody, }: {
    requestBody?: AccountConfigurations;
}) => CancelablePromise<AccountConfigurations>;