@clear-street/studio-sdk 0.1.0-alpha.10

package/src/resources/accounts/pnl-sums.ts

@@ -0,0 +1,176 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../resource';
+import * as Core from '../../core';
+import * as PnlSumsAPI from './pnl-sums';
+
+export class PnlSums extends APIResource {
+  /**
+   * List historical PNL summations for a given account over a given date range,
+   * filtered on the given query parameters.
+   */
+  list(
+    accountId: string,
+    query: PnlSumListParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<PnlSumListResponse> {
+    return this._client.get(`/accounts/${accountId}/pnl-sums`, { query, ...options });
+  }
+}
+
+export interface PnlSumListResponse {
+  /**
+   * Account ID for the account.
+   */
+  account_id?: string;
+
+  data?: Array<PnlSumListResponse.Data>;
+
+  /**
+   * Sum of profit and loss from intraday trading activities for the given date range
+   * across all symbols.
+   */
+  day_pnl?: number;
+
+  /**
+   * Echoed back from the provided query param.
+   */
+  ending_date?: number;
+
+  /**
+   * The equity at the end of the date range. End of day equity of the ending date in
+   * the date range.
+   */
+  ending_equity?: number;
+
+  /**
+   * Entity ID for the legal entity.
+   */
+  entity_id?: string;
+
+  /**
+   * Sum of profit and loss from previous trading date across all symbols.
+   */
+  position_pnl?: number;
+
+  /**
+   * Sum of profit and loss realized from position closing trading activity across
+   * all symbols.
+   */
+  realized_pnl?: number;
+
+  /**
+   * Echoed back from the provided query param.
+   */
+  starting_date?: number;
+
+  /**
+   * The equity at the start of the date range. Start of day equity of the starting
+   * date in the date range.
+   */
+  starting_equity?: number;
+
+  /**
+   * Echoed back from the provided query param.
+   */
+  symbol?: string;
+
+  /**
+   * `realized_pnl + unrealized_pnl`
+   */
+  total_pnl?: number;
+
+  /**
+   * Echoed back from the provided query param.
+   */
+  underlying_symbol?: string;
+
+  /**
+   * Sum of profit and loss from market changes across all symbols.
+   */
+  unrealized_pnl?: number;
+}
+
+export namespace PnlSumListResponse {
+  export interface Data {
+    /**
+     * The asset class of the symbol.
+     */
+    asset_class?: 'other' | 'currency' | 'equity' | 'option' | 'debt' | 'fund';
+
+    /**
+     * Sum of the notional bought.
+     */
+    bought_notional?: number;
+
+    /**
+     * Sum of quantity bought.
+     */
+    bought_quantity?: string;
+
+    /**
+     * Sum of profit and loss from intraday trading activities for the given date range
+     */
+    day_pnl?: number;
+
+    /**
+     * Sum of profit and loss from previous trading date.
+     */
+    position_pnl?: number;
+
+    /**
+     * Sum of profit and loss realized from position closing trading activity.
+     */
+    realized_pnl?: number;
+
+    /**
+     * Sum of the notional sold.
+     */
+    sold_notional?: number;
+
+    /**
+     * Sum of quantity sold.
+     */
+    sold_quantity?: string;
+
+    symbol?: string;
+
+    /**
+     * `realized_pnl + unrealized_pnl`
+     */
+    total_pnl?: number;
+
+    /**
+     * Sum of profit and loss from market changes.
+     */
+    unrealized_pnl?: number;
+  }
+}
+
+export interface PnlSumListParams {
+  /**
+   * The ending date to accumulate PNL data for, inclusive.
+   */
+  ending_date: number;
+
+  /**
+   * The starting date to accumulate PNL data for.
+   */
+  starting_date: number;
+
+  /**
+   * Filters for a specific symbol.
+   */
+  symbol?: string;
+
+  /**
+   * Filters for a specific underlying symbol, e.g. all options for a particular
+   * underlying.
+   */
+  underlying_symbol?: string;
+}
+
+export namespace PnlSums {
+  export import PnlSumListResponse = PnlSumsAPI.PnlSumListResponse;
+  export import PnlSumListParams = PnlSumsAPI.PnlSumListParams;
+}

package/src/resources/accounts/positions.ts

@@ -0,0 +1,66 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../resource';
+import { isRequestOptions } from '../../core';
+import * as Core from '../../core';
+import * as PositionsAPI from './positions';
+import * as Shared from '../shared';
+
+export class Positions extends APIResource {
+  /**
+   * Get current positions for a given account for a given symbol.
+   */
+  retrieve(
+    accountId: string,
+    symbol: string,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<Shared.Position> {
+    return this._client.get(`/accounts/${accountId}/positions/${symbol}`, options);
+  }
+
+  /**
+   * List current positions for a given account.
+   */
+  list(
+    accountId: string,
+    query?: PositionListParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<PositionListResponse>;
+  list(accountId: string, options?: Core.RequestOptions): Core.APIPromise<PositionListResponse>;
+  list(
+    accountId: string,
+    query: PositionListParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<PositionListResponse> {
+    if (isRequestOptions(query)) {
+      return this.list(accountId, {}, query);
+    }
+    return this._client.get(`/accounts/${accountId}/positions`, { query, ...options });
+  }
+}
+
+export interface PositionListResponse {
+  data: Array<Shared.Position>;
+
+  /**
+   * Cursor for the next page of results.
+   */
+  next_page_token?: string;
+}
+
+export interface PositionListParams {
+  /**
+   * Number of positions to return per page.
+   */
+  page_size?: number;
+
+  /**
+   * Cursor for the page to return.
+   */
+  page_token?: string;
+}
+
+export namespace Positions {
+  export import PositionListResponse = PositionsAPI.PositionListResponse;
+  export import PositionListParams = PositionsAPI.PositionListParams;
+}

package/src/resources/accounts/trades.ts

@@ -0,0 +1,62 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../resource';
+import { isRequestOptions } from '../../core';
+import * as Core from '../../core';
+import * as TradesAPI from './trades';
+import * as Shared from '../shared';
+
+export class Trades extends APIResource {
+  /**
+   * Get trade a trade by its unique trade ID.
+   */
+  retrieve(accountId: string, tradeId: string, options?: Core.RequestOptions): Core.APIPromise<Shared.Trade> {
+    return this._client.get(`/accounts/${accountId}/trades/${tradeId}`, options);
+  }
+
+  /**
+   * List trades for a given account for the current trading day.
+   */
+  list(
+    accountId: string,
+    query?: TradeListParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<TradeListResponse>;
+  list(accountId: string, options?: Core.RequestOptions): Core.APIPromise<TradeListResponse>;
+  list(
+    accountId: string,
+    query: TradeListParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<TradeListResponse> {
+    if (isRequestOptions(query)) {
+      return this.list(accountId, {}, query);
+    }
+    return this._client.get(`/accounts/${accountId}/trades`, { query, ...options });
+  }
+}
+
+export interface TradeListResponse {
+  data: Array<Shared.Trade>;
+
+  /**
+   * Cursor for the next page of results.
+   */
+  next_page_token?: string;
+}
+
+export interface TradeListParams {
+  /**
+   * Number of trades to return per page.
+   */
+  page_size?: number;
+
+  /**
+   * Cursor for the page to return.
+   */
+  page_token?: string;
+}
+
+export namespace Trades {
+  export import TradeListResponse = TradesAPI.TradeListResponse;
+  export import TradeListParams = TradesAPI.TradeListParams;
+}