IBKR 3rd Party Web API

/**
 * IBKR3rdPartyWebAPI - generated by OmniStream from IBKR 3rd Party Web API's OpenAPI spec.
 * One typed method per endpoint. A single Omni key reaches the API.
 */
const DEFAULT_BASE = "https://grid.skinvaults.online/v1/proxy/interactivebrokers";

export class IBKR3rdPartyWebAPIError extends Error {
  status: number;
  code?: string;
  constructor(status: number, code: string | undefined, message?: string) {
    super(message || `IBKR3rdPartyWebAPI error ${status}`);
    this.name = "IBKR3rdPartyWebAPIError";
    this.status = status;
    this.code = code;
  }
}

export interface IBKR3rdPartyWebAPIOptions {
  baseUrl?: string;
  fetch?: typeof fetch;
  timeoutMs?: number;
}

export class IBKR3rdPartyWebAPI {
  /** @param token Your OmniStream key (one key for every API). */
  constructor(private token: string, private opts: IBKR3rdPartyWebAPIOptions = {}) {
    if (!token) throw new Error("IBKR3rdPartyWebAPI: token is required");
  }
  rateLimit: { remainingMinute?: number; remainingDay?: number } | null = null;

  private async _request(method: string, path: string, { params, body }: { params?: Record<string, unknown>; body?: unknown } = {}): Promise<any> {
    const f = this.opts.fetch ?? globalThis.fetch;
    const url = new URL((this.opts.baseUrl ?? DEFAULT_BASE).replace(/\/+$/, "") + path);
    if (params) for (const [k, v] of Object.entries(params)) if (v != null) url.searchParams.set(k, String(v));
    const headers: Record<string, string> = { "x-omni-key": this.token };
    if (body !== undefined) headers["content-type"] = "application/json";
    const res = await f(url, { method, headers, body: body !== undefined ? JSON.stringify(body) : undefined });
    this.rateLimit = {
      remainingMinute: Number(res.headers.get("x-ratelimit-remaining-minute")) || undefined,
      remainingDay: Number(res.headers.get("x-ratelimit-remaining-day")) || undefined,
    };
    const data = await res.json().catch(() => ({}));
    if (!res.ok) throw new IBKR3rdPartyWebAPIError(res.status, data?.error?.code, data?.error?.message);
    return data.data ?? data;
  }

  /** Brokerage Accounts */
  getaccounts(params: { "account": string }): Promise<any> {
    return this._request("GET", "/accounts", { params });
  }

  /** Return margin impact info */
  postaccountsAccountOrderImpact(body: unknown, params: { "account": string }): Promise<any> {
    return this._request("POST", "/accounts/{account}/order_impact", { body, params });
  }

  /** Open Orders */
  getaccountsAccountOrders(params: { "account": string }): Promise<any> {
    return this._request("GET", "/accounts/{account}/orders", { params });
  }

  /** Place Order */
  postaccountsAccountOrders(body: unknown, params: { "account": string }): Promise<any> {
    return this._request("POST", "/accounts/{account}/orders", { body, params });
  }

  /** Return specific order info */
  getaccountsAccountOrdersCustomerorderid(params: { "account": string; "CustomerOrderId": string }): Promise<any> {
    return this._request("GET", "/accounts/{account}/orders/{CustomerOrderId}", { params });
  }

  /** Modify Order */
  putaccountsAccountOrdersCustomerorderid(body: unknown, params: { "account": string; "CustomerOrderId": string }): Promise<any> {
    return this._request("PUT", "/accounts/{account}/orders/{CustomerOrderId}", { body, params });
  }

  /** Cancel Order */
  deleteaccountsAccountOrdersCustomerorderid(params: { "account": string; "CustomerOrderId": string }): Promise<any> {
    return this._request("DELETE", "/accounts/{account}/orders/{CustomerOrderId}", { params });
  }

  /** Account Positions */
  getaccountsAccountPositions(params: { "account": string }): Promise<any> {
    return this._request("GET", "/accounts/{account}/positions", { params });
  }

  /** Account Values Summary */
  getaccountsAccountSummary(params: { "account": string }): Promise<any> {
    return this._request("GET", "/accounts/{account}/summary", { params });
  }

  /** Returns trades in account */
  getaccountsAccountTrades(params: { "account": string }): Promise<any> {
    return this._request("GET", "/accounts/{account}/trades", { params });
  }

  /** Exchange Components */
  getmarketdataExchangeComponents(): Promise<any> {
    return this._request("GET", "/marketdata/exchange_components", {});
  }

  /** Market Data Snapshot */
  getmarketdataSnapshot(): Promise<any> {
    return this._request("GET", "/marketdata/snapshot", {});
  }

  /** Obtain a access token */
  postoauthAccessToken(body: unknown): Promise<any> {
    return this._request("POST", "/oauth/access_token", { body });
  }

  /** Obtain a live session token */
  postoauthLiveSessionToken(body: unknown): Promise<any> {
    return this._request("POST", "/oauth/live_session_token", { body });
  }

  /** Obtain a request token */
  postoauthRequestToken(body: unknown): Promise<any> {
    return this._request("POST", "/oauth/request_token", { body });
  }

  /** Get security definition */
  getsecdef(): Promise<any> {
    return this._request("GET", "/secdef", {});
  }
}

export default IBKR3rdPartyWebAPI;