parsec-api 0.8.1 → 0.11.0

package/src/resources/account.ts

@@ -9,15 +9,18 @@ export class Account extends APIResource {
   /**
    * Returns the raw balance payload from the exchange (opaque JSON).
    */
-  balance(query: AccountBalanceParams, options?: RequestOptions): APIPromise<AccountBalanceResponse> {
-    return this._client.get('/api/v1/balance', { query, ...options });
-  }
-
-  /**
-   * Returns the customer's tier and list of linked exchanges.
-   */
-  capabilities(options?: RequestOptions): APIPromise<AccountCapabilitiesResponse> {
-    return this._client.get('/api/v1/session/capabilities', options);
+  balance(params: AccountBalanceParams, options?: RequestOptions): APIPromise<AccountBalanceResponse> {
+    const { 'X-Exchange-Credentials': xExchangeCredentials, ...query } = params;
+    return this._client.get('/api/v1/balance', {
+      query,
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(xExchangeCredentials != null ? { 'X-Exchange-Credentials': xExchangeCredentials } : undefined),
+        },
+        options?.headers,
+      ]),
+    });
   }
 
   /**
@@ -32,14 +35,12 @@ export class Account extends APIResource {
   }
 
   /**
-   * Updates stored credentials for this API key. Returns 204 on success.
+   * Returns the authenticated customer's tier, billing period, rate limits, and
+   * current consumption (monthly requests, WebSocket connections/subscriptions).
+   * Values of 0 for limits indicate unlimited.
    */
-  updateCredentials(body: AccountUpdateCredentialsParams, options?: RequestOptions): APIPromise<void> {
-    return this._client.put('/api/v1/credentials', {
-      body,
-      ...options,
-      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
-    });
+  usage(options?: RequestOptions): APIPromise<AccountUsageResponse> {
+    return this._client.get('/api/v1/usage', options);
   }
 
   /**
@@ -58,18 +59,6 @@ export interface AccountBalanceResponse {
   raw: { [key: string]: unknown };
 }
 
-export interface AccountCapabilitiesResponse {
-  /**
-   * Exchange IDs the customer has credentials linked for.
-   */
-  linked_exchanges: Array<string>;
-
-  /**
-   * Customer tier (e.g., "free", "pro", "admin").
-   */
-  tier: string;
-}
-
 export type AccountPingResponse = Array<AccountPingResponse.AccountPingResponseItem>;
 
 export namespace AccountPingResponse {
@@ -84,6 +73,78 @@ export namespace AccountPingResponse {
   }
 }
 
+export interface AccountUsageResponse {
+  /**
+   * Unix seconds — 1st of next month UTC.
+   */
+  billing_period_end: number;
+
+  /**
+   * Unix seconds — 1st of current month UTC.
+   */
+  billing_period_start: number;
+
+  limits: AccountUsageResponse.Limits;
+
+  /**
+   * Current tier (free, pro, scale).
+   */
+  tier: string;
+
+  usage: AccountUsageResponse.Usage;
+}
+
+export namespace AccountUsageResponse {
+  export interface Limits {
+    /**
+     * Max historical data age in days. 0 = unlimited.
+     */
+    history_max_age_days: number;
+
+    /**
+     * Monthly REST request cap. 0 = unlimited.
+     */
+    monthly_requests: number;
+
+    /**
+     * REST queries per second. 0 = unlimited.
+     */
+    rest_qps: number;
+
+    /**
+     * REST burst QPS allowance. 0 = unlimited.
+     */
+    rest_qps_burst: number;
+
+    /**
+     * Max orderbook depth per WebSocket subscription.
+     */
+    ws_max_depth: number;
+
+    /**
+     * Max WebSocket subscriptions across all connections. 0 = unlimited.
+     */
+    ws_max_subscriptions: number;
+  }
+
+  export interface Usage {
+    /**
+     * REST requests consumed this billing period.
+     */
+    monthly_requests: number;
+
+    /**
+     * Currently active WebSocket connections.
+     */
+    ws_active_connections: number;
+
+    /**
+     * Currently active WebSocket subscriptions.
+     */
+    ws_active_subscriptions: number;
+  }
+}
+
 export interface AccountUserActivityResponse {
   exchanges: { [key: string]: unknown };
 
@@ -100,14 +161,21 @@ export namespace AccountUserActivityResponse {
 
 export interface AccountBalanceParams {
   /**
-   * Exchange identifier (e.g., kalshi, polymarket).
+   * Query param: Exchange identifier (e.g., kalshi, polymarket).
    */
   exchange: string;
 
   /**
-   * Refresh balance before returning (default false).
+   * Query param: Refresh balance before returning (default false).
    */
   refresh?: boolean;
+
+  /**
+   * Header param: Base64-encoded JSON of per-request exchange credentials (Mode B).
+   * When provided, Parsec creates a transient exchange session instead of using
+   * stored credentials. The JSON shape matches the RequestCredentials schema.
+   */
+  'X-Exchange-Credentials'?: string;
 }
 
 export interface AccountPingParams {
@@ -117,18 +185,6 @@ export interface AccountPingParams {
   exchange?: string;
 }
 
-export interface AccountUpdateCredentialsParams {
-  evm_private_key?: string | null;
-
-  kalshi_api_key_id?: string | null;
-
-  kalshi_private_key?: string | null;
-
-  poly_funder?: string | null;
-
-  poly_signature_type?: string | null;
-}
-
 export interface AccountUserActivityParams {
   /**
    * User address (typically an EVM address).
@@ -150,12 +206,11 @@ export interface AccountUserActivityParams {
 export declare namespace Account {
   export {
     type AccountBalanceResponse as AccountBalanceResponse,
-    type AccountCapabilitiesResponse as AccountCapabilitiesResponse,
     type AccountPingResponse as AccountPingResponse,
+    type AccountUsageResponse as AccountUsageResponse,
     type AccountUserActivityResponse as AccountUserActivityResponse,
     type AccountBalanceParams as AccountBalanceParams,
     type AccountPingParams as AccountPingParams,
-    type AccountUpdateCredentialsParams as AccountUpdateCredentialsParams,
     type AccountUserActivityParams as AccountUserActivityParams,
   };
 }

package/src/resources/builder/builder.ts

@@ -0,0 +1,78 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as EscrowAPI from './escrow';
+import { Escrow, EscrowConfigResponse } from './escrow';
+import * as OnboardAPI from './onboard';
+import { Onboard, OnboardCreateParams, OnboardCreateResponse } from './onboard';
+import * as UsersAPI from './users';
+import {
+  UserCreateParams,
+  UserCreateResponse,
+  UserListParams,
+  UserListResponse,
+  UserRetrieveResponse,
+  UserUpdateParams,
+  UserUpdateResponse,
+  Users,
+} from './users';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+
+export class Builder extends APIResource {
+  users: UsersAPI.Users = new UsersAPI.Users(this._client);
+  onboard: OnboardAPI.Onboard = new OnboardAPI.Onboard(this._client);
+  escrow: EscrowAPI.Escrow = new EscrowAPI.Escrow(this._client);
+
+  /**
+   * Returns the builder's QPS pool allocation, end-user count, and total allocated
+   * QPS.
+   */
+  pool(options?: RequestOptions): APIPromise<BuilderPoolResponse> {
+    return this._client.get('/api/v1/builder/pool', options);
+  }
+}
+
+export interface BuilderPoolResponse {
+  /**
+   * Number of end-users created by this builder.
+   */
+  end_user_count: number;
+
+  /**
+   * Total QPS available to this builder.
+   */
+  qps_pool: number;
+
+  /**
+   * Total QPS allocated to end-users.
+   */
+  total_allocated_qps: number;
+}
+
+Builder.Users = Users;
+Builder.Onboard = Onboard;
+Builder.Escrow = Escrow;
+
+export declare namespace Builder {
+  export { type BuilderPoolResponse as BuilderPoolResponse };
+
+  export {
+    Users as Users,
+    type UserCreateResponse as UserCreateResponse,
+    type UserRetrieveResponse as UserRetrieveResponse,
+    type UserUpdateResponse as UserUpdateResponse,
+    type UserListResponse as UserListResponse,
+    type UserCreateParams as UserCreateParams,
+    type UserUpdateParams as UserUpdateParams,
+    type UserListParams as UserListParams,
+  };
+
+  export {
+    Onboard as Onboard,
+    type OnboardCreateResponse as OnboardCreateResponse,
+    type OnboardCreateParams as OnboardCreateParams,
+  };
+
+  export { Escrow as Escrow, type EscrowConfigResponse as EscrowConfigResponse };
+}

package/src/resources/builder/escrow.ts

@@ -0,0 +1,62 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+
+export class Escrow extends APIResource {
+  /**
+   * Returns the builder's fee escrow configuration including contract address, fee
+   * rates, and treasury address. Read-only — fee escrow is configured by Parsec
+   * admins during onboarding.
+   */
+  config(options?: RequestOptions): APIPromise<EscrowConfigResponse> {
+    return this._client.get('/api/v1/builder/escrow/config', options);
+  }
+}
+
+export interface EscrowConfigResponse {
+  /**
+   * Affiliate fee rate in basis points.
+   */
+  affiliate_fee_bps: number;
+
+  /**
+   * Escrow smart contract address.
+   */
+  escrow_contract_address: string;
+
+  /**
+   * Whether fee escrow is enabled for this builder.
+   */
+  fee_escrow_enabled: boolean;
+
+  /**
+   * Minimum fee in basis points.
+   */
+  min_fee_bps: number;
+
+  /**
+   * Minimum fee in USDC (human-readable).
+   */
+  min_fee_usdc: string;
+
+  /**
+   * Treasury address for fee distribution.
+   */
+  treasury_address: string;
+
+  /**
+   * Affiliate fee recipient address.
+   */
+  affiliate_address?: string | null;
+
+  /**
+   * Fee rate in basis points.
+   */
+  fee_bps?: number | null;
+}
+
+export declare namespace Escrow {
+  export { type EscrowConfigResponse as EscrowConfigResponse };
+}

package/src/resources/builder/index.ts

@@ -0,0 +1,15 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { Builder, type BuilderPoolResponse } from './builder';
+export { Escrow, type EscrowConfigResponse } from './escrow';
+export { Onboard, type OnboardCreateResponse, type OnboardCreateParams } from './onboard';
+export {
+  Users,
+  type UserCreateResponse,
+  type UserRetrieveResponse,
+  type UserUpdateResponse,
+  type UserListResponse,
+  type UserCreateParams,
+  type UserUpdateParams,
+  type UserListParams,
+} from './users';

package/src/resources/builder/onboard.ts

@@ -0,0 +1,206 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+
+export class Onboard extends APIResource {
+  /**
+   * Sets up an end-user for trading on a specific exchange. Managed mode creates
+   * wallet + exchange credentials. Self mode stores user-provided credentials.
+   */
+  create(body: OnboardCreateParams, options?: RequestOptions): APIPromise<OnboardCreateResponse> {
+    return this._client.post('/api/v1/builder/onboard', { body, ...options });
+  }
+}
+
+export interface OnboardCreateResponse {
+  /**
+   * Parsec customer ID of the onboarded user.
+   */
+  customer_id: string;
+
+  /**
+   * Exchange that was onboarded.
+   */
+  exchange: string;
+
+  /**
+   * Whether fee escrow is enabled for this user.
+   */
+  fee_escrow_enabled: boolean;
+
+  /**
+   * All exchanges linked to this user.
+   */
+  linked_exchanges: Array<string>;
+
+  /**
+   * Onboard mode used ("managed" or "self").
+   */
+  mode: string;
+
+  /**
+   * Onboard status ("complete").
+   */
+  status: string;
+
+  /**
+   * Steps completed during this call.
+   */
+  steps_completed: Array<string>;
+
+  /**
+   * Affiliate fee recipient address.
+   */
+  affiliate_address?: string | null;
+
+  /**
+   * EOA wallet address (managed mode only).
+   */
+  eoa_address?: string | null;
+
+  /**
+   * Fee rate in basis points.
+   */
+  fee_bps?: number | null;
+
+  /**
+   * Safe wallet address (present when wallet_type is "safe").
+   */
+  safe_address?: string | null;
+
+  wallet?: OnboardCreateResponse.Wallet;
+}
+
+export namespace OnboardCreateResponse {
+  export interface Wallet {
+    /**
+     * EVM wallet address on Polygon.
+     */
+    eoa_address: string;
+
+    /**
+     * Privy wallet identifier.
+     */
+    privy_wallet_id: string;
+
+    /**
+     * Wallet type ("eoa" or "safe").
+     */
+    wallet_type: string;
+
+    /**
+     * Token balances for this wallet.
+     */
+    balances?: Array<Wallet.Balance> | null;
+
+    /**
+     * Chain ID for the wallet (e.g. 137 for Polygon).
+     */
+    chain_id?: number | null;
+
+    /**
+     * Wallet creation timestamp.
+     */
+    created_at?: string | null;
+
+    /**
+     * Safe wallet address (present when wallet_type is "safe").
+     */
+    safe_address?: string | null;
+  }
+
+  export namespace Wallet {
+    export interface Balance {
+      /**
+       * Token symbol (e.g. "USDC").
+       */
+      token: string;
+
+      /**
+       * Human-readable balance (e.g. "100.50").
+       */
+      balance: string;
+
+      /**
+       * Token decimal places.
+       */
+      decimals: number;
+
+      /**
+       * Raw balance in smallest unit (e.g. "100500000").
+       */
+      raw_balance: string;
+
+      /**
+       * ERC-20 contract address. Null for native token.
+       */
+      contract_address?: string | null;
+    }
+  }
+}
+
+export interface OnboardCreateParams {
+  /**
+   * Parsec customer ID of the end-user to onboard.
+   */
+  customer_id: string;
+
+  /**
+   * Exchange to onboard ("polymarket" or "kalshi").
+   */
+  exchange: string;
+
+  /**
+   * Managed = Parsec creates wallet + credentials. Self = you provide credentials.
+   */
+  mode: 'managed' | 'self';
+
+  /**
+   * Kalshi API key ID (self mode).
+   */
+  api_key_id?: string;
+
+  /**
+   * Chain ID for Safe wallet creation.
+   */
+  chain_id?: number;
+
+  /**
+   * Polymarket CLOB API key (self mode).
+   */
+  clob_api_key?: string;
+
+  /**
+   * Polymarket CLOB API passphrase (self mode).
+   */
+  clob_api_passphrase?: string;
+
+  /**
+   * Polymarket CLOB API secret (self mode).
+   */
+  clob_api_secret?: string;
+
+  /**
+   * External wallet address (required when wallet_type is "safe").
+   */
+  eoa_address?: string;
+
+  /**
+   * Kalshi RSA private key in PEM format (self mode).
+   */
+  private_key?: string;
+
+  /**
+   * Wallet type for managed mode ("eoa" or "safe").
+   */
+  wallet_type?: string;
+}
+
+export declare namespace Onboard {
+  export {
+    type OnboardCreateResponse as OnboardCreateResponse,
+    type OnboardCreateParams as OnboardCreateParams,
+  };
+}