@finatic/client 0.9.5 → 0.9.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.ts +5 -630
- package/dist/index.js +3283 -383
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +3280 -349
- package/dist/index.mjs.map +1 -1
- package/package.json +15 -15
package/dist/index.d.ts
CHANGED
|
@@ -113,10 +113,6 @@ declare class Configuration {
|
|
|
113
113
|
* Do not edit the class manually.
|
|
114
114
|
*/
|
|
115
115
|
|
|
116
|
-
interface RequestArgs {
|
|
117
|
-
url: string;
|
|
118
|
-
options: RawAxiosRequestConfig;
|
|
119
|
-
}
|
|
120
116
|
declare class BaseAPI {
|
|
121
117
|
protected basePath: string;
|
|
122
118
|
protected axios: AxiosInstance;
|
|
@@ -3317,423 +3313,6 @@ interface SessionStartRequest {
|
|
|
3317
3313
|
'user_id'?: string | null;
|
|
3318
3314
|
}
|
|
3319
3315
|
|
|
3320
|
-
/**
|
|
3321
|
-
* BrokersApi - axios parameter creator
|
|
3322
|
-
*/
|
|
3323
|
-
declare const BrokersApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
3324
|
-
/**
|
|
3325
|
-
* Remove a company\'s access to a broker connection. If the company is the only one with access, the entire connection is deleted. If other companies have access, only the company\'s access is removed.
|
|
3326
|
-
* @summary Disconnect Company From Broker
|
|
3327
|
-
* @param {string} connectionId Connection ID
|
|
3328
|
-
* @param {*} [options] Override http request option.
|
|
3329
|
-
* @throws {RequiredError}
|
|
3330
|
-
*/
|
|
3331
|
-
disconnectCompanyFromBrokerApiV1BrokersDisconnectCompanyConnectionIdDelete: (connectionId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3332
|
-
/**
|
|
3333
|
-
* Get accounts for all authorized broker connections. This endpoint is accessible from the portal and uses session-only authentication. Returns accounts from connections the company has read access to.
|
|
3334
|
-
* @summary Get Accounts
|
|
3335
|
-
* @param {string | null} [brokerId] Filter by broker ID
|
|
3336
|
-
* @param {string | null} [connectionId] Filter by connection ID
|
|
3337
|
-
* @param {BrokerDataAccountTypeEnum | null} [accountType] Filter by account type (e.g., \'margin\', \'cash\', \'crypto_wallet\', \'live\', \'sim\')
|
|
3338
|
-
* @param {AccountStatus | null} [status] Filter by account status (e.g., \'active\', \'inactive\')
|
|
3339
|
-
* @param {string | null} [currency] Filter by currency (e.g., \'USD\', \'EUR\')
|
|
3340
|
-
* @param {number} [limit] Maximum number of accounts to return
|
|
3341
|
-
* @param {number} [offset] Number of accounts to skip for pagination
|
|
3342
|
-
* @param {boolean} [includeMetadata] Include connection metadata in response (excluded by default for FDX compliance)
|
|
3343
|
-
* @param {*} [options] Override http request option.
|
|
3344
|
-
* @throws {RequiredError}
|
|
3345
|
-
*/
|
|
3346
|
-
getAccountsApiV1BrokersDataAccountsGet: (brokerId?: string | null, connectionId?: string | null, accountType?: BrokerDataAccountTypeEnum | null, status?: AccountStatus | null, currency?: string | null, limit?: number, offset?: number, includeMetadata?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3347
|
-
/**
|
|
3348
|
-
* Get balances for all authorized broker connections. This endpoint is accessible from the portal and uses session-only authentication. Returns balances from connections the company has read access to.
|
|
3349
|
-
* @summary Get Balances
|
|
3350
|
-
* @param {string | null} [brokerId] Filter by broker ID
|
|
3351
|
-
* @param {string | null} [connectionId] Filter by connection ID
|
|
3352
|
-
* @param {string | null} [accountId] Filter by broker provided account ID or internal account UUID
|
|
3353
|
-
* @param {boolean | null} [isEndOfDaySnapshot] Filter by end-of-day snapshot status (true/false)
|
|
3354
|
-
* @param {number} [limit] Maximum number of balances to return
|
|
3355
|
-
* @param {number} [offset] Number of balances to skip for pagination
|
|
3356
|
-
* @param {string | null} [balanceCreatedAfter] Filter balances created after this timestamp
|
|
3357
|
-
* @param {string | null} [balanceCreatedBefore] Filter balances created before this timestamp
|
|
3358
|
-
* @param {boolean} [includeMetadata] Include balance metadata in response (excluded by default for FDX compliance)
|
|
3359
|
-
* @param {*} [options] Override http request option.
|
|
3360
|
-
* @throws {RequiredError}
|
|
3361
|
-
*/
|
|
3362
|
-
getBalancesApiV1BrokersDataBalancesGet: (brokerId?: string | null, connectionId?: string | null, accountId?: string | null, isEndOfDaySnapshot?: boolean | null, limit?: number, offset?: number, balanceCreatedAfter?: string | null, balanceCreatedBefore?: string | null, includeMetadata?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3363
|
-
/**
|
|
3364
|
-
* Get all available brokers. This is a fast operation that returns a cached list of available brokers. The list is loaded once at startup and never changes during runtime. Returns ------- FinaticResponse[list[BrokerInfo]] list of available brokers with their metadata.
|
|
3365
|
-
* @summary Get Brokers
|
|
3366
|
-
* @param {*} [options] Override http request option.
|
|
3367
|
-
* @throws {RequiredError}
|
|
3368
|
-
*/
|
|
3369
|
-
getBrokersApiV1BrokersGet: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3370
|
-
/**
|
|
3371
|
-
* Get order events for a specific order. This endpoint returns all lifecycle events for the specified order.
|
|
3372
|
-
* @summary Get Order Events
|
|
3373
|
-
* @param {string} orderId Order ID
|
|
3374
|
-
* @param {string | null} [connectionId] Filter by connection ID
|
|
3375
|
-
* @param {number} [limit] Maximum number of events to return
|
|
3376
|
-
* @param {number} [offset] Number of events to skip for pagination
|
|
3377
|
-
* @param {boolean} [includeMetadata] Include event metadata in response (excluded by default for FDX compliance)
|
|
3378
|
-
* @param {*} [options] Override http request option.
|
|
3379
|
-
* @throws {RequiredError}
|
|
3380
|
-
*/
|
|
3381
|
-
getOrderEventsApiV1BrokersDataOrdersOrderIdEventsGet: (orderId: string, connectionId?: string | null, limit?: number, offset?: number, includeMetadata?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3382
|
-
/**
|
|
3383
|
-
* Get order fills for a specific order. This endpoint returns all execution fills for the specified order.
|
|
3384
|
-
* @summary Get Order Fills
|
|
3385
|
-
* @param {string} orderId Order ID
|
|
3386
|
-
* @param {string | null} [connectionId] Filter by connection ID
|
|
3387
|
-
* @param {number} [limit] Maximum number of fills to return
|
|
3388
|
-
* @param {number} [offset] Number of fills to skip for pagination
|
|
3389
|
-
* @param {boolean} [includeMetadata] Include fill metadata in response (excluded by default for FDX compliance)
|
|
3390
|
-
* @param {*} [options] Override http request option.
|
|
3391
|
-
* @throws {RequiredError}
|
|
3392
|
-
*/
|
|
3393
|
-
getOrderFillsApiV1BrokersDataOrdersOrderIdFillsGet: (orderId: string, connectionId?: string | null, limit?: number, offset?: number, includeMetadata?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3394
|
-
/**
|
|
3395
|
-
* Get order groups. This endpoint returns order groups that contain multiple orders.
|
|
3396
|
-
* @summary Get Order Groups
|
|
3397
|
-
* @param {string | null} [brokerId] Filter by broker ID
|
|
3398
|
-
* @param {string | null} [connectionId] Filter by connection ID
|
|
3399
|
-
* @param {number} [limit] Maximum number of order groups to return
|
|
3400
|
-
* @param {number} [offset] Number of order groups to skip for pagination
|
|
3401
|
-
* @param {string | null} [createdAfter] Filter order groups created after this timestamp
|
|
3402
|
-
* @param {string | null} [createdBefore] Filter order groups created before this timestamp
|
|
3403
|
-
* @param {boolean} [includeMetadata] Include group metadata in response (excluded by default for FDX compliance)
|
|
3404
|
-
* @param {*} [options] Override http request option.
|
|
3405
|
-
* @throws {RequiredError}
|
|
3406
|
-
*/
|
|
3407
|
-
getOrderGroupsApiV1BrokersDataOrdersGroupsGet: (brokerId?: string | null, connectionId?: string | null, limit?: number, offset?: number, createdAfter?: string | null, createdBefore?: string | null, includeMetadata?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3408
|
-
/**
|
|
3409
|
-
* Get orders for all authorized broker connections. This endpoint is accessible from the portal and uses session-only authentication. Returns orders from connections the company has read access to.
|
|
3410
|
-
* @summary Get Orders
|
|
3411
|
-
* @param {string | null} [brokerId] Filter by broker ID
|
|
3412
|
-
* @param {string | null} [connectionId] Filter by connection ID
|
|
3413
|
-
* @param {string | null} [accountId] Filter by broker provided account ID or internal account UUID
|
|
3414
|
-
* @param {string | null} [symbol] Filter by symbol
|
|
3415
|
-
* @param {string | null} [orderStatus] Filter by order status (e.g., \'filled\', \'pending_new\', \'cancelled\')
|
|
3416
|
-
* @param {BrokerDataOrderSideEnum | null} [side] Filter by order side (e.g., \'buy\', \'sell\')
|
|
3417
|
-
* @param {BrokerDataAssetTypeEnum | null} [assetType] Filter by asset type (e.g., \'stock\', \'option\', \'crypto\', \'future\')
|
|
3418
|
-
* @param {number} [limit] Maximum number of orders to return
|
|
3419
|
-
* @param {number} [offset] Number of orders to skip for pagination
|
|
3420
|
-
* @param {string | null} [createdAfter] Filter orders created after this timestamp
|
|
3421
|
-
* @param {string | null} [createdBefore] Filter orders created before this timestamp
|
|
3422
|
-
* @param {boolean} [includeMetadata] Include order metadata in response (excluded by default for FDX compliance)
|
|
3423
|
-
* @param {*} [options] Override http request option.
|
|
3424
|
-
* @throws {RequiredError}
|
|
3425
|
-
*/
|
|
3426
|
-
getOrdersApiV1BrokersDataOrdersGet: (brokerId?: string | null, connectionId?: string | null, accountId?: string | null, symbol?: string | null, orderStatus?: string | null, side?: BrokerDataOrderSideEnum | null, assetType?: BrokerDataAssetTypeEnum | null, limit?: number, offset?: number, createdAfter?: string | null, createdBefore?: string | null, includeMetadata?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3427
|
-
/**
|
|
3428
|
-
* Get position lot fills for a specific lot. This endpoint returns all fills associated with a specific position lot.
|
|
3429
|
-
* @summary Get Position Lot Fills
|
|
3430
|
-
* @param {string} lotId Position lot ID
|
|
3431
|
-
* @param {string | null} [connectionId] Filter by connection ID
|
|
3432
|
-
* @param {number} [limit] Maximum number of fills to return
|
|
3433
|
-
* @param {number} [offset] Number of fills to skip for pagination
|
|
3434
|
-
* @param {*} [options] Override http request option.
|
|
3435
|
-
* @throws {RequiredError}
|
|
3436
|
-
*/
|
|
3437
|
-
getPositionLotFillsApiV1BrokersDataPositionsLotsLotIdFillsGet: (lotId: string, connectionId?: string | null, limit?: number, offset?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3438
|
-
/**
|
|
3439
|
-
* Get position lots (tax lots for positions). This endpoint returns tax lots for positions, which are used for tax reporting. Each lot tracks when a position was opened/closed and at what prices.
|
|
3440
|
-
* @summary Get Position Lots
|
|
3441
|
-
* @param {string | null} [brokerId] Filter by broker ID
|
|
3442
|
-
* @param {string | null} [connectionId] Filter by connection ID
|
|
3443
|
-
* @param {string | null} [accountId] Filter by broker provided account ID
|
|
3444
|
-
* @param {string | null} [symbol] Filter by symbol
|
|
3445
|
-
* @param {string | null} [positionId] Filter by position ID
|
|
3446
|
-
* @param {number} [limit] Maximum number of position lots to return
|
|
3447
|
-
* @param {number} [offset] Number of position lots to skip for pagination
|
|
3448
|
-
* @param {*} [options] Override http request option.
|
|
3449
|
-
* @throws {RequiredError}
|
|
3450
|
-
*/
|
|
3451
|
-
getPositionLotsApiV1BrokersDataPositionsLotsGet: (brokerId?: string | null, connectionId?: string | null, accountId?: string | null, symbol?: string | null, positionId?: string | null, limit?: number, offset?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3452
|
-
/**
|
|
3453
|
-
* Get positions for all authorized broker connections. This endpoint is accessible from the portal and uses session-only authentication. Returns positions from connections the company has read access to.
|
|
3454
|
-
* @summary Get Positions
|
|
3455
|
-
* @param {string | null} [brokerId] Filter by broker ID
|
|
3456
|
-
* @param {string | null} [connectionId] Filter by connection ID
|
|
3457
|
-
* @param {string | null} [accountId] Filter by broker provided account ID or internal account UUID
|
|
3458
|
-
* @param {string | null} [symbol] Filter by symbol
|
|
3459
|
-
* @param {BrokerDataOrderSideEnum | null} [side] Filter by position side (e.g., \'long\', \'short\')
|
|
3460
|
-
* @param {BrokerDataAssetTypeEnum | null} [assetType] Filter by asset type (e.g., \'stock\', \'option\', \'crypto\', \'future\')
|
|
3461
|
-
* @param {BrokerDataPositionStatusEnum | null} [positionStatus] Filter by position status: \'open\' (quantity > 0) or \'closed\' (quantity = 0)
|
|
3462
|
-
* @param {number} [limit] Maximum number of positions to return
|
|
3463
|
-
* @param {number} [offset] Number of positions to skip for pagination
|
|
3464
|
-
* @param {string | null} [updatedAfter] Filter positions updated after this timestamp
|
|
3465
|
-
* @param {string | null} [updatedBefore] Filter positions updated before this timestamp
|
|
3466
|
-
* @param {boolean} [includeMetadata] Include position metadata in response (excluded by default for FDX compliance)
|
|
3467
|
-
* @param {*} [options] Override http request option.
|
|
3468
|
-
* @throws {RequiredError}
|
|
3469
|
-
*/
|
|
3470
|
-
getPositionsApiV1BrokersDataPositionsGet: (brokerId?: string | null, connectionId?: string | null, accountId?: string | null, symbol?: string | null, side?: BrokerDataOrderSideEnum | null, assetType?: BrokerDataAssetTypeEnum | null, positionStatus?: BrokerDataPositionStatusEnum | null, limit?: number, offset?: number, updatedAfter?: string | null, updatedBefore?: string | null, includeMetadata?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3471
|
-
/**
|
|
3472
|
-
* List all broker connections for the current user with permissions. This endpoint is accessible from the portal and uses session-only authentication. Returns connections that the user has any permissions for, including the current company\'s permissions (read/write) for each connection.
|
|
3473
|
-
* @summary List Broker Connections
|
|
3474
|
-
* @param {*} [options] Override http request option.
|
|
3475
|
-
* @throws {RequiredError}
|
|
3476
|
-
*/
|
|
3477
|
-
listBrokerConnectionsApiV1BrokersConnectionsGet: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3478
|
-
};
|
|
3479
|
-
/**
|
|
3480
|
-
* BrokersApi - functional programming interface
|
|
3481
|
-
*/
|
|
3482
|
-
declare const BrokersApiFp: (configuration?: Configuration) => {
|
|
3483
|
-
/**
|
|
3484
|
-
* Remove a company\'s access to a broker connection. If the company is the only one with access, the entire connection is deleted. If other companies have access, only the company\'s access is removed.
|
|
3485
|
-
* @summary Disconnect Company From Broker
|
|
3486
|
-
* @param {string} connectionId Connection ID
|
|
3487
|
-
* @param {*} [options] Override http request option.
|
|
3488
|
-
* @throws {RequiredError}
|
|
3489
|
-
*/
|
|
3490
|
-
disconnectCompanyFromBrokerApiV1BrokersDisconnectCompanyConnectionIdDelete(connectionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FinaticResponseDisconnectActionResult>>;
|
|
3491
|
-
/**
|
|
3492
|
-
* Get accounts for all authorized broker connections. This endpoint is accessible from the portal and uses session-only authentication. Returns accounts from connections the company has read access to.
|
|
3493
|
-
* @summary Get Accounts
|
|
3494
|
-
* @param {string | null} [brokerId] Filter by broker ID
|
|
3495
|
-
* @param {string | null} [connectionId] Filter by connection ID
|
|
3496
|
-
* @param {BrokerDataAccountTypeEnum | null} [accountType] Filter by account type (e.g., \'margin\', \'cash\', \'crypto_wallet\', \'live\', \'sim\')
|
|
3497
|
-
* @param {AccountStatus | null} [status] Filter by account status (e.g., \'active\', \'inactive\')
|
|
3498
|
-
* @param {string | null} [currency] Filter by currency (e.g., \'USD\', \'EUR\')
|
|
3499
|
-
* @param {number} [limit] Maximum number of accounts to return
|
|
3500
|
-
* @param {number} [offset] Number of accounts to skip for pagination
|
|
3501
|
-
* @param {boolean} [includeMetadata] Include connection metadata in response (excluded by default for FDX compliance)
|
|
3502
|
-
* @param {*} [options] Override http request option.
|
|
3503
|
-
* @throws {RequiredError}
|
|
3504
|
-
*/
|
|
3505
|
-
getAccountsApiV1BrokersDataAccountsGet(brokerId?: string | null, connectionId?: string | null, accountType?: BrokerDataAccountTypeEnum | null, status?: AccountStatus | null, currency?: string | null, limit?: number, offset?: number, includeMetadata?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FinaticResponseListFDXBrokerAccount>>;
|
|
3506
|
-
/**
|
|
3507
|
-
* Get balances for all authorized broker connections. This endpoint is accessible from the portal and uses session-only authentication. Returns balances from connections the company has read access to.
|
|
3508
|
-
* @summary Get Balances
|
|
3509
|
-
* @param {string | null} [brokerId] Filter by broker ID
|
|
3510
|
-
* @param {string | null} [connectionId] Filter by connection ID
|
|
3511
|
-
* @param {string | null} [accountId] Filter by broker provided account ID or internal account UUID
|
|
3512
|
-
* @param {boolean | null} [isEndOfDaySnapshot] Filter by end-of-day snapshot status (true/false)
|
|
3513
|
-
* @param {number} [limit] Maximum number of balances to return
|
|
3514
|
-
* @param {number} [offset] Number of balances to skip for pagination
|
|
3515
|
-
* @param {string | null} [balanceCreatedAfter] Filter balances created after this timestamp
|
|
3516
|
-
* @param {string | null} [balanceCreatedBefore] Filter balances created before this timestamp
|
|
3517
|
-
* @param {boolean} [includeMetadata] Include balance metadata in response (excluded by default for FDX compliance)
|
|
3518
|
-
* @param {*} [options] Override http request option.
|
|
3519
|
-
* @throws {RequiredError}
|
|
3520
|
-
*/
|
|
3521
|
-
getBalancesApiV1BrokersDataBalancesGet(brokerId?: string | null, connectionId?: string | null, accountId?: string | null, isEndOfDaySnapshot?: boolean | null, limit?: number, offset?: number, balanceCreatedAfter?: string | null, balanceCreatedBefore?: string | null, includeMetadata?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FinaticResponseListFDXBrokerBalance>>;
|
|
3522
|
-
/**
|
|
3523
|
-
* Get all available brokers. This is a fast operation that returns a cached list of available brokers. The list is loaded once at startup and never changes during runtime. Returns ------- FinaticResponse[list[BrokerInfo]] list of available brokers with their metadata.
|
|
3524
|
-
* @summary Get Brokers
|
|
3525
|
-
* @param {*} [options] Override http request option.
|
|
3526
|
-
* @throws {RequiredError}
|
|
3527
|
-
*/
|
|
3528
|
-
getBrokersApiV1BrokersGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FinaticResponseListBrokerInfo>>;
|
|
3529
|
-
/**
|
|
3530
|
-
* Get order events for a specific order. This endpoint returns all lifecycle events for the specified order.
|
|
3531
|
-
* @summary Get Order Events
|
|
3532
|
-
* @param {string} orderId Order ID
|
|
3533
|
-
* @param {string | null} [connectionId] Filter by connection ID
|
|
3534
|
-
* @param {number} [limit] Maximum number of events to return
|
|
3535
|
-
* @param {number} [offset] Number of events to skip for pagination
|
|
3536
|
-
* @param {boolean} [includeMetadata] Include event metadata in response (excluded by default for FDX compliance)
|
|
3537
|
-
* @param {*} [options] Override http request option.
|
|
3538
|
-
* @throws {RequiredError}
|
|
3539
|
-
*/
|
|
3540
|
-
getOrderEventsApiV1BrokersDataOrdersOrderIdEventsGet(orderId: string, connectionId?: string | null, limit?: number, offset?: number, includeMetadata?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FinaticResponseListFDXBrokerOrderEvent>>;
|
|
3541
|
-
/**
|
|
3542
|
-
* Get order fills for a specific order. This endpoint returns all execution fills for the specified order.
|
|
3543
|
-
* @summary Get Order Fills
|
|
3544
|
-
* @param {string} orderId Order ID
|
|
3545
|
-
* @param {string | null} [connectionId] Filter by connection ID
|
|
3546
|
-
* @param {number} [limit] Maximum number of fills to return
|
|
3547
|
-
* @param {number} [offset] Number of fills to skip for pagination
|
|
3548
|
-
* @param {boolean} [includeMetadata] Include fill metadata in response (excluded by default for FDX compliance)
|
|
3549
|
-
* @param {*} [options] Override http request option.
|
|
3550
|
-
* @throws {RequiredError}
|
|
3551
|
-
*/
|
|
3552
|
-
getOrderFillsApiV1BrokersDataOrdersOrderIdFillsGet(orderId: string, connectionId?: string | null, limit?: number, offset?: number, includeMetadata?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FinaticResponseListFDXBrokerOrderFill>>;
|
|
3553
|
-
/**
|
|
3554
|
-
* Get order groups. This endpoint returns order groups that contain multiple orders.
|
|
3555
|
-
* @summary Get Order Groups
|
|
3556
|
-
* @param {string | null} [brokerId] Filter by broker ID
|
|
3557
|
-
* @param {string | null} [connectionId] Filter by connection ID
|
|
3558
|
-
* @param {number} [limit] Maximum number of order groups to return
|
|
3559
|
-
* @param {number} [offset] Number of order groups to skip for pagination
|
|
3560
|
-
* @param {string | null} [createdAfter] Filter order groups created after this timestamp
|
|
3561
|
-
* @param {string | null} [createdBefore] Filter order groups created before this timestamp
|
|
3562
|
-
* @param {boolean} [includeMetadata] Include group metadata in response (excluded by default for FDX compliance)
|
|
3563
|
-
* @param {*} [options] Override http request option.
|
|
3564
|
-
* @throws {RequiredError}
|
|
3565
|
-
*/
|
|
3566
|
-
getOrderGroupsApiV1BrokersDataOrdersGroupsGet(brokerId?: string | null, connectionId?: string | null, limit?: number, offset?: number, createdAfter?: string | null, createdBefore?: string | null, includeMetadata?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FinaticResponseListFDXBrokerOrderGroup>>;
|
|
3567
|
-
/**
|
|
3568
|
-
* Get orders for all authorized broker connections. This endpoint is accessible from the portal and uses session-only authentication. Returns orders from connections the company has read access to.
|
|
3569
|
-
* @summary Get Orders
|
|
3570
|
-
* @param {string | null} [brokerId] Filter by broker ID
|
|
3571
|
-
* @param {string | null} [connectionId] Filter by connection ID
|
|
3572
|
-
* @param {string | null} [accountId] Filter by broker provided account ID or internal account UUID
|
|
3573
|
-
* @param {string | null} [symbol] Filter by symbol
|
|
3574
|
-
* @param {string | null} [orderStatus] Filter by order status (e.g., \'filled\', \'pending_new\', \'cancelled\')
|
|
3575
|
-
* @param {BrokerDataOrderSideEnum | null} [side] Filter by order side (e.g., \'buy\', \'sell\')
|
|
3576
|
-
* @param {BrokerDataAssetTypeEnum | null} [assetType] Filter by asset type (e.g., \'stock\', \'option\', \'crypto\', \'future\')
|
|
3577
|
-
* @param {number} [limit] Maximum number of orders to return
|
|
3578
|
-
* @param {number} [offset] Number of orders to skip for pagination
|
|
3579
|
-
* @param {string | null} [createdAfter] Filter orders created after this timestamp
|
|
3580
|
-
* @param {string | null} [createdBefore] Filter orders created before this timestamp
|
|
3581
|
-
* @param {boolean} [includeMetadata] Include order metadata in response (excluded by default for FDX compliance)
|
|
3582
|
-
* @param {*} [options] Override http request option.
|
|
3583
|
-
* @throws {RequiredError}
|
|
3584
|
-
*/
|
|
3585
|
-
getOrdersApiV1BrokersDataOrdersGet(brokerId?: string | null, connectionId?: string | null, accountId?: string | null, symbol?: string | null, orderStatus?: string | null, side?: BrokerDataOrderSideEnum | null, assetType?: BrokerDataAssetTypeEnum | null, limit?: number, offset?: number, createdAfter?: string | null, createdBefore?: string | null, includeMetadata?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FinaticResponseListFDXBrokerOrder>>;
|
|
3586
|
-
/**
|
|
3587
|
-
* Get position lot fills for a specific lot. This endpoint returns all fills associated with a specific position lot.
|
|
3588
|
-
* @summary Get Position Lot Fills
|
|
3589
|
-
* @param {string} lotId Position lot ID
|
|
3590
|
-
* @param {string | null} [connectionId] Filter by connection ID
|
|
3591
|
-
* @param {number} [limit] Maximum number of fills to return
|
|
3592
|
-
* @param {number} [offset] Number of fills to skip for pagination
|
|
3593
|
-
* @param {*} [options] Override http request option.
|
|
3594
|
-
* @throws {RequiredError}
|
|
3595
|
-
*/
|
|
3596
|
-
getPositionLotFillsApiV1BrokersDataPositionsLotsLotIdFillsGet(lotId: string, connectionId?: string | null, limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FinaticResponseListFDXBrokerPositionLotFill>>;
|
|
3597
|
-
/**
|
|
3598
|
-
* Get position lots (tax lots for positions). This endpoint returns tax lots for positions, which are used for tax reporting. Each lot tracks when a position was opened/closed and at what prices.
|
|
3599
|
-
* @summary Get Position Lots
|
|
3600
|
-
* @param {string | null} [brokerId] Filter by broker ID
|
|
3601
|
-
* @param {string | null} [connectionId] Filter by connection ID
|
|
3602
|
-
* @param {string | null} [accountId] Filter by broker provided account ID
|
|
3603
|
-
* @param {string | null} [symbol] Filter by symbol
|
|
3604
|
-
* @param {string | null} [positionId] Filter by position ID
|
|
3605
|
-
* @param {number} [limit] Maximum number of position lots to return
|
|
3606
|
-
* @param {number} [offset] Number of position lots to skip for pagination
|
|
3607
|
-
* @param {*} [options] Override http request option.
|
|
3608
|
-
* @throws {RequiredError}
|
|
3609
|
-
*/
|
|
3610
|
-
getPositionLotsApiV1BrokersDataPositionsLotsGet(brokerId?: string | null, connectionId?: string | null, accountId?: string | null, symbol?: string | null, positionId?: string | null, limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FinaticResponseListFDXBrokerPositionLot>>;
|
|
3611
|
-
/**
|
|
3612
|
-
* Get positions for all authorized broker connections. This endpoint is accessible from the portal and uses session-only authentication. Returns positions from connections the company has read access to.
|
|
3613
|
-
* @summary Get Positions
|
|
3614
|
-
* @param {string | null} [brokerId] Filter by broker ID
|
|
3615
|
-
* @param {string | null} [connectionId] Filter by connection ID
|
|
3616
|
-
* @param {string | null} [accountId] Filter by broker provided account ID or internal account UUID
|
|
3617
|
-
* @param {string | null} [symbol] Filter by symbol
|
|
3618
|
-
* @param {BrokerDataOrderSideEnum | null} [side] Filter by position side (e.g., \'long\', \'short\')
|
|
3619
|
-
* @param {BrokerDataAssetTypeEnum | null} [assetType] Filter by asset type (e.g., \'stock\', \'option\', \'crypto\', \'future\')
|
|
3620
|
-
* @param {BrokerDataPositionStatusEnum | null} [positionStatus] Filter by position status: \'open\' (quantity > 0) or \'closed\' (quantity = 0)
|
|
3621
|
-
* @param {number} [limit] Maximum number of positions to return
|
|
3622
|
-
* @param {number} [offset] Number of positions to skip for pagination
|
|
3623
|
-
* @param {string | null} [updatedAfter] Filter positions updated after this timestamp
|
|
3624
|
-
* @param {string | null} [updatedBefore] Filter positions updated before this timestamp
|
|
3625
|
-
* @param {boolean} [includeMetadata] Include position metadata in response (excluded by default for FDX compliance)
|
|
3626
|
-
* @param {*} [options] Override http request option.
|
|
3627
|
-
* @throws {RequiredError}
|
|
3628
|
-
*/
|
|
3629
|
-
getPositionsApiV1BrokersDataPositionsGet(brokerId?: string | null, connectionId?: string | null, accountId?: string | null, symbol?: string | null, side?: BrokerDataOrderSideEnum | null, assetType?: BrokerDataAssetTypeEnum | null, positionStatus?: BrokerDataPositionStatusEnum | null, limit?: number, offset?: number, updatedAfter?: string | null, updatedBefore?: string | null, includeMetadata?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FinaticResponseListFDXBrokerPosition>>;
|
|
3630
|
-
/**
|
|
3631
|
-
* List all broker connections for the current user with permissions. This endpoint is accessible from the portal and uses session-only authentication. Returns connections that the user has any permissions for, including the current company\'s permissions (read/write) for each connection.
|
|
3632
|
-
* @summary List Broker Connections
|
|
3633
|
-
* @param {*} [options] Override http request option.
|
|
3634
|
-
* @throws {RequiredError}
|
|
3635
|
-
*/
|
|
3636
|
-
listBrokerConnectionsApiV1BrokersConnectionsGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FinaticResponseListUserBrokerConnectionWithPermissions>>;
|
|
3637
|
-
};
|
|
3638
|
-
/**
|
|
3639
|
-
* BrokersApi - factory interface
|
|
3640
|
-
*/
|
|
3641
|
-
declare const BrokersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
3642
|
-
/**
|
|
3643
|
-
* Remove a company\'s access to a broker connection. If the company is the only one with access, the entire connection is deleted. If other companies have access, only the company\'s access is removed.
|
|
3644
|
-
* @summary Disconnect Company From Broker
|
|
3645
|
-
* @param {BrokersApiDisconnectCompanyFromBrokerApiV1BrokersDisconnectCompanyConnectionIdDeleteRequest} requestParameters Request parameters.
|
|
3646
|
-
* @param {*} [options] Override http request option.
|
|
3647
|
-
* @throws {RequiredError}
|
|
3648
|
-
*/
|
|
3649
|
-
disconnectCompanyFromBrokerApiV1BrokersDisconnectCompanyConnectionIdDelete(requestParameters: BrokersApiDisconnectCompanyFromBrokerApiV1BrokersDisconnectCompanyConnectionIdDeleteRequest, options?: RawAxiosRequestConfig): AxiosPromise<FinaticResponseDisconnectActionResult>;
|
|
3650
|
-
/**
|
|
3651
|
-
* Get accounts for all authorized broker connections. This endpoint is accessible from the portal and uses session-only authentication. Returns accounts from connections the company has read access to.
|
|
3652
|
-
* @summary Get Accounts
|
|
3653
|
-
* @param {BrokersApiGetAccountsApiV1BrokersDataAccountsGetRequest} requestParameters Request parameters.
|
|
3654
|
-
* @param {*} [options] Override http request option.
|
|
3655
|
-
* @throws {RequiredError}
|
|
3656
|
-
*/
|
|
3657
|
-
getAccountsApiV1BrokersDataAccountsGet(requestParameters?: BrokersApiGetAccountsApiV1BrokersDataAccountsGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<FinaticResponseListFDXBrokerAccount>;
|
|
3658
|
-
/**
|
|
3659
|
-
* Get balances for all authorized broker connections. This endpoint is accessible from the portal and uses session-only authentication. Returns balances from connections the company has read access to.
|
|
3660
|
-
* @summary Get Balances
|
|
3661
|
-
* @param {BrokersApiGetBalancesApiV1BrokersDataBalancesGetRequest} requestParameters Request parameters.
|
|
3662
|
-
* @param {*} [options] Override http request option.
|
|
3663
|
-
* @throws {RequiredError}
|
|
3664
|
-
*/
|
|
3665
|
-
getBalancesApiV1BrokersDataBalancesGet(requestParameters?: BrokersApiGetBalancesApiV1BrokersDataBalancesGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<FinaticResponseListFDXBrokerBalance>;
|
|
3666
|
-
/**
|
|
3667
|
-
* Get all available brokers. This is a fast operation that returns a cached list of available brokers. The list is loaded once at startup and never changes during runtime. Returns ------- FinaticResponse[list[BrokerInfo]] list of available brokers with their metadata.
|
|
3668
|
-
* @summary Get Brokers
|
|
3669
|
-
* @param {*} [options] Override http request option.
|
|
3670
|
-
* @throws {RequiredError}
|
|
3671
|
-
*/
|
|
3672
|
-
getBrokersApiV1BrokersGet(options?: RawAxiosRequestConfig): AxiosPromise<FinaticResponseListBrokerInfo>;
|
|
3673
|
-
/**
|
|
3674
|
-
* Get order events for a specific order. This endpoint returns all lifecycle events for the specified order.
|
|
3675
|
-
* @summary Get Order Events
|
|
3676
|
-
* @param {BrokersApiGetOrderEventsApiV1BrokersDataOrdersOrderIdEventsGetRequest} requestParameters Request parameters.
|
|
3677
|
-
* @param {*} [options] Override http request option.
|
|
3678
|
-
* @throws {RequiredError}
|
|
3679
|
-
*/
|
|
3680
|
-
getOrderEventsApiV1BrokersDataOrdersOrderIdEventsGet(requestParameters: BrokersApiGetOrderEventsApiV1BrokersDataOrdersOrderIdEventsGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<FinaticResponseListFDXBrokerOrderEvent>;
|
|
3681
|
-
/**
|
|
3682
|
-
* Get order fills for a specific order. This endpoint returns all execution fills for the specified order.
|
|
3683
|
-
* @summary Get Order Fills
|
|
3684
|
-
* @param {BrokersApiGetOrderFillsApiV1BrokersDataOrdersOrderIdFillsGetRequest} requestParameters Request parameters.
|
|
3685
|
-
* @param {*} [options] Override http request option.
|
|
3686
|
-
* @throws {RequiredError}
|
|
3687
|
-
*/
|
|
3688
|
-
getOrderFillsApiV1BrokersDataOrdersOrderIdFillsGet(requestParameters: BrokersApiGetOrderFillsApiV1BrokersDataOrdersOrderIdFillsGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<FinaticResponseListFDXBrokerOrderFill>;
|
|
3689
|
-
/**
|
|
3690
|
-
* Get order groups. This endpoint returns order groups that contain multiple orders.
|
|
3691
|
-
* @summary Get Order Groups
|
|
3692
|
-
* @param {BrokersApiGetOrderGroupsApiV1BrokersDataOrdersGroupsGetRequest} requestParameters Request parameters.
|
|
3693
|
-
* @param {*} [options] Override http request option.
|
|
3694
|
-
* @throws {RequiredError}
|
|
3695
|
-
*/
|
|
3696
|
-
getOrderGroupsApiV1BrokersDataOrdersGroupsGet(requestParameters?: BrokersApiGetOrderGroupsApiV1BrokersDataOrdersGroupsGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<FinaticResponseListFDXBrokerOrderGroup>;
|
|
3697
|
-
/**
|
|
3698
|
-
* Get orders for all authorized broker connections. This endpoint is accessible from the portal and uses session-only authentication. Returns orders from connections the company has read access to.
|
|
3699
|
-
* @summary Get Orders
|
|
3700
|
-
* @param {BrokersApiGetOrdersApiV1BrokersDataOrdersGetRequest} requestParameters Request parameters.
|
|
3701
|
-
* @param {*} [options] Override http request option.
|
|
3702
|
-
* @throws {RequiredError}
|
|
3703
|
-
*/
|
|
3704
|
-
getOrdersApiV1BrokersDataOrdersGet(requestParameters?: BrokersApiGetOrdersApiV1BrokersDataOrdersGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<FinaticResponseListFDXBrokerOrder>;
|
|
3705
|
-
/**
|
|
3706
|
-
* Get position lot fills for a specific lot. This endpoint returns all fills associated with a specific position lot.
|
|
3707
|
-
* @summary Get Position Lot Fills
|
|
3708
|
-
* @param {BrokersApiGetPositionLotFillsApiV1BrokersDataPositionsLotsLotIdFillsGetRequest} requestParameters Request parameters.
|
|
3709
|
-
* @param {*} [options] Override http request option.
|
|
3710
|
-
* @throws {RequiredError}
|
|
3711
|
-
*/
|
|
3712
|
-
getPositionLotFillsApiV1BrokersDataPositionsLotsLotIdFillsGet(requestParameters: BrokersApiGetPositionLotFillsApiV1BrokersDataPositionsLotsLotIdFillsGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<FinaticResponseListFDXBrokerPositionLotFill>;
|
|
3713
|
-
/**
|
|
3714
|
-
* Get position lots (tax lots for positions). This endpoint returns tax lots for positions, which are used for tax reporting. Each lot tracks when a position was opened/closed and at what prices.
|
|
3715
|
-
* @summary Get Position Lots
|
|
3716
|
-
* @param {BrokersApiGetPositionLotsApiV1BrokersDataPositionsLotsGetRequest} requestParameters Request parameters.
|
|
3717
|
-
* @param {*} [options] Override http request option.
|
|
3718
|
-
* @throws {RequiredError}
|
|
3719
|
-
*/
|
|
3720
|
-
getPositionLotsApiV1BrokersDataPositionsLotsGet(requestParameters?: BrokersApiGetPositionLotsApiV1BrokersDataPositionsLotsGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<FinaticResponseListFDXBrokerPositionLot>;
|
|
3721
|
-
/**
|
|
3722
|
-
* Get positions for all authorized broker connections. This endpoint is accessible from the portal and uses session-only authentication. Returns positions from connections the company has read access to.
|
|
3723
|
-
* @summary Get Positions
|
|
3724
|
-
* @param {BrokersApiGetPositionsApiV1BrokersDataPositionsGetRequest} requestParameters Request parameters.
|
|
3725
|
-
* @param {*} [options] Override http request option.
|
|
3726
|
-
* @throws {RequiredError}
|
|
3727
|
-
*/
|
|
3728
|
-
getPositionsApiV1BrokersDataPositionsGet(requestParameters?: BrokersApiGetPositionsApiV1BrokersDataPositionsGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<FinaticResponseListFDXBrokerPosition>;
|
|
3729
|
-
/**
|
|
3730
|
-
* List all broker connections for the current user with permissions. This endpoint is accessible from the portal and uses session-only authentication. Returns connections that the user has any permissions for, including the current company\'s permissions (read/write) for each connection.
|
|
3731
|
-
* @summary List Broker Connections
|
|
3732
|
-
* @param {*} [options] Override http request option.
|
|
3733
|
-
* @throws {RequiredError}
|
|
3734
|
-
*/
|
|
3735
|
-
listBrokerConnectionsApiV1BrokersConnectionsGet(options?: RawAxiosRequestConfig): AxiosPromise<FinaticResponseListUserBrokerConnectionWithPermissions>;
|
|
3736
|
-
};
|
|
3737
3316
|
/**
|
|
3738
3317
|
* BrokersApi - interface
|
|
3739
3318
|
*/
|
|
@@ -5297,69 +4876,6 @@ declare class BrokersWrapper {
|
|
|
5297
4876
|
getPositionLotFills(params: GetPositionLotFillsParams): Promise<FinaticResponse$2<PaginatedData<FDXBrokerPositionLotFill>>>;
|
|
5298
4877
|
}
|
|
5299
4878
|
|
|
5300
|
-
/**
|
|
5301
|
-
* CompanyApi - axios parameter creator
|
|
5302
|
-
*/
|
|
5303
|
-
declare const CompanyApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
5304
|
-
/**
|
|
5305
|
-
* Get public company details by ID (no user check, no sensitive data).
|
|
5306
|
-
* @summary Get Company
|
|
5307
|
-
* @param {string} companyId Company ID
|
|
5308
|
-
* @param {*} [options] Override http request option.
|
|
5309
|
-
* @throws {RequiredError}
|
|
5310
|
-
*/
|
|
5311
|
-
getCompanyApiV1CompanyCompanyIdGet: (companyId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5312
|
-
/**
|
|
5313
|
-
* Get public company details by ID (no user check, no sensitive data).
|
|
5314
|
-
* @summary Get Company
|
|
5315
|
-
* @param {string} companyId Company ID
|
|
5316
|
-
* @param {*} [options] Override http request option.
|
|
5317
|
-
* @throws {RequiredError}
|
|
5318
|
-
*/
|
|
5319
|
-
getCompanyApiV1CompanyCompanyIdGet_1: (companyId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5320
|
-
};
|
|
5321
|
-
/**
|
|
5322
|
-
* CompanyApi - functional programming interface
|
|
5323
|
-
*/
|
|
5324
|
-
declare const CompanyApiFp: (configuration?: Configuration) => {
|
|
5325
|
-
/**
|
|
5326
|
-
* Get public company details by ID (no user check, no sensitive data).
|
|
5327
|
-
* @summary Get Company
|
|
5328
|
-
* @param {string} companyId Company ID
|
|
5329
|
-
* @param {*} [options] Override http request option.
|
|
5330
|
-
* @throws {RequiredError}
|
|
5331
|
-
*/
|
|
5332
|
-
getCompanyApiV1CompanyCompanyIdGet(companyId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FinaticResponseCompanyResponse>>;
|
|
5333
|
-
/**
|
|
5334
|
-
* Get public company details by ID (no user check, no sensitive data).
|
|
5335
|
-
* @summary Get Company
|
|
5336
|
-
* @param {string} companyId Company ID
|
|
5337
|
-
* @param {*} [options] Override http request option.
|
|
5338
|
-
* @throws {RequiredError}
|
|
5339
|
-
*/
|
|
5340
|
-
getCompanyApiV1CompanyCompanyIdGet_1(companyId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FinaticResponseCompanyResponse>>;
|
|
5341
|
-
};
|
|
5342
|
-
/**
|
|
5343
|
-
* CompanyApi - factory interface
|
|
5344
|
-
*/
|
|
5345
|
-
declare const CompanyApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
5346
|
-
/**
|
|
5347
|
-
* Get public company details by ID (no user check, no sensitive data).
|
|
5348
|
-
* @summary Get Company
|
|
5349
|
-
* @param {CompanyApiGetCompanyApiV1CompanyCompanyIdGetRequest} requestParameters Request parameters.
|
|
5350
|
-
* @param {*} [options] Override http request option.
|
|
5351
|
-
* @throws {RequiredError}
|
|
5352
|
-
*/
|
|
5353
|
-
getCompanyApiV1CompanyCompanyIdGet(requestParameters: CompanyApiGetCompanyApiV1CompanyCompanyIdGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<FinaticResponseCompanyResponse>;
|
|
5354
|
-
/**
|
|
5355
|
-
* Get public company details by ID (no user check, no sensitive data).
|
|
5356
|
-
* @summary Get Company
|
|
5357
|
-
* @param {CompanyApiGetCompanyApiV1CompanyCompanyIdGet0Request} requestParameters Request parameters.
|
|
5358
|
-
* @param {*} [options] Override http request option.
|
|
5359
|
-
* @throws {RequiredError}
|
|
5360
|
-
*/
|
|
5361
|
-
getCompanyApiV1CompanyCompanyIdGet_1(requestParameters: CompanyApiGetCompanyApiV1CompanyCompanyIdGet0Request, options?: RawAxiosRequestConfig): AxiosPromise<FinaticResponseCompanyResponse>;
|
|
5362
|
-
};
|
|
5363
4879
|
/**
|
|
5364
4880
|
* CompanyApi - interface
|
|
5365
4881
|
*/
|
|
@@ -5500,121 +5016,6 @@ declare class CompanyWrapper {
|
|
|
5500
5016
|
getCompany(params: GetCompanyParams): Promise<FinaticResponse$1<CompanyResponse>>;
|
|
5501
5017
|
}
|
|
5502
5018
|
|
|
5503
|
-
/**
|
|
5504
|
-
* SessionApi - axios parameter creator
|
|
5505
|
-
*/
|
|
5506
|
-
declare const SessionApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
5507
|
-
/**
|
|
5508
|
-
* Get a portal URL with token for a session. The session must be in ACTIVE or AUTHENTICATING state and the request must come from the same device that initiated the session. Device info is automatically validated from the request.
|
|
5509
|
-
* @summary Get Portal Url
|
|
5510
|
-
* @param {string} sessionId Session ID
|
|
5511
|
-
* @param {*} [options] Override http request option.
|
|
5512
|
-
* @throws {RequiredError}
|
|
5513
|
-
*/
|
|
5514
|
-
getPortalUrlApiV1SessionPortalGet: (sessionId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5515
|
-
/**
|
|
5516
|
-
* Get user information and fresh tokens for a completed session. This endpoint is designed for server SDKs to retrieve user information and authentication tokens after successful OTP verification. Security: - Requires valid session in ACTIVE state - Validates device fingerprint binding - Generates fresh tokens (not returning stored ones) - Only accessible to authenticated sessions with user_id - Validates that header session_id matches path session_id
|
|
5517
|
-
* @summary Get Session User
|
|
5518
|
-
* @param {string} sessionId Session ID
|
|
5519
|
-
* @param {string} xSessionId Session ID from header (must match path parameter)
|
|
5520
|
-
* @param {*} [options] Override http request option.
|
|
5521
|
-
* @throws {RequiredError}
|
|
5522
|
-
*/
|
|
5523
|
-
getSessionUserApiV1SessionSessionIdUserGet: (sessionId: string, xSessionId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5524
|
-
/**
|
|
5525
|
-
* Initialize a new session with company API key.
|
|
5526
|
-
* @summary Init Session
|
|
5527
|
-
* @param {string} xApiKey Company API key
|
|
5528
|
-
* @param {*} [options] Override http request option.
|
|
5529
|
-
* @throws {RequiredError}
|
|
5530
|
-
*/
|
|
5531
|
-
initSessionApiV1SessionInitPost: (xApiKey: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5532
|
-
/**
|
|
5533
|
-
* Start a session with a one-time token.
|
|
5534
|
-
* @summary Start Session
|
|
5535
|
-
* @param {string} oneTimeToken One-time use token obtained from init_session endpoint to authenticate and start the session
|
|
5536
|
-
* @param {SessionStartRequest} sessionStartRequest Session start request containing optional user ID to associate with the session
|
|
5537
|
-
* @param {*} [options] Override http request option.
|
|
5538
|
-
* @throws {RequiredError}
|
|
5539
|
-
*/
|
|
5540
|
-
startSessionApiV1SessionStartPost: (oneTimeToken: string, sessionStartRequest: SessionStartRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5541
|
-
};
|
|
5542
|
-
/**
|
|
5543
|
-
* SessionApi - functional programming interface
|
|
5544
|
-
*/
|
|
5545
|
-
declare const SessionApiFp: (configuration?: Configuration) => {
|
|
5546
|
-
/**
|
|
5547
|
-
* Get a portal URL with token for a session. The session must be in ACTIVE or AUTHENTICATING state and the request must come from the same device that initiated the session. Device info is automatically validated from the request.
|
|
5548
|
-
* @summary Get Portal Url
|
|
5549
|
-
* @param {string} sessionId Session ID
|
|
5550
|
-
* @param {*} [options] Override http request option.
|
|
5551
|
-
* @throws {RequiredError}
|
|
5552
|
-
*/
|
|
5553
|
-
getPortalUrlApiV1SessionPortalGet(sessionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FinaticResponsePortalUrlResponse>>;
|
|
5554
|
-
/**
|
|
5555
|
-
* Get user information and fresh tokens for a completed session. This endpoint is designed for server SDKs to retrieve user information and authentication tokens after successful OTP verification. Security: - Requires valid session in ACTIVE state - Validates device fingerprint binding - Generates fresh tokens (not returning stored ones) - Only accessible to authenticated sessions with user_id - Validates that header session_id matches path session_id
|
|
5556
|
-
* @summary Get Session User
|
|
5557
|
-
* @param {string} sessionId Session ID
|
|
5558
|
-
* @param {string} xSessionId Session ID from header (must match path parameter)
|
|
5559
|
-
* @param {*} [options] Override http request option.
|
|
5560
|
-
* @throws {RequiredError}
|
|
5561
|
-
*/
|
|
5562
|
-
getSessionUserApiV1SessionSessionIdUserGet(sessionId: string, xSessionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FinaticResponseSessionUserResponse>>;
|
|
5563
|
-
/**
|
|
5564
|
-
* Initialize a new session with company API key.
|
|
5565
|
-
* @summary Init Session
|
|
5566
|
-
* @param {string} xApiKey Company API key
|
|
5567
|
-
* @param {*} [options] Override http request option.
|
|
5568
|
-
* @throws {RequiredError}
|
|
5569
|
-
*/
|
|
5570
|
-
initSessionApiV1SessionInitPost(xApiKey: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FinaticResponseTokenResponseData>>;
|
|
5571
|
-
/**
|
|
5572
|
-
* Start a session with a one-time token.
|
|
5573
|
-
* @summary Start Session
|
|
5574
|
-
* @param {string} oneTimeToken One-time use token obtained from init_session endpoint to authenticate and start the session
|
|
5575
|
-
* @param {SessionStartRequest} sessionStartRequest Session start request containing optional user ID to associate with the session
|
|
5576
|
-
* @param {*} [options] Override http request option.
|
|
5577
|
-
* @throws {RequiredError}
|
|
5578
|
-
*/
|
|
5579
|
-
startSessionApiV1SessionStartPost(oneTimeToken: string, sessionStartRequest: SessionStartRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FinaticResponseSessionResponseData>>;
|
|
5580
|
-
};
|
|
5581
|
-
/**
|
|
5582
|
-
* SessionApi - factory interface
|
|
5583
|
-
*/
|
|
5584
|
-
declare const SessionApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
5585
|
-
/**
|
|
5586
|
-
* Get a portal URL with token for a session. The session must be in ACTIVE or AUTHENTICATING state and the request must come from the same device that initiated the session. Device info is automatically validated from the request.
|
|
5587
|
-
* @summary Get Portal Url
|
|
5588
|
-
* @param {SessionApiGetPortalUrlApiV1SessionPortalGetRequest} requestParameters Request parameters.
|
|
5589
|
-
* @param {*} [options] Override http request option.
|
|
5590
|
-
* @throws {RequiredError}
|
|
5591
|
-
*/
|
|
5592
|
-
getPortalUrlApiV1SessionPortalGet(requestParameters: SessionApiGetPortalUrlApiV1SessionPortalGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<FinaticResponsePortalUrlResponse>;
|
|
5593
|
-
/**
|
|
5594
|
-
* Get user information and fresh tokens for a completed session. This endpoint is designed for server SDKs to retrieve user information and authentication tokens after successful OTP verification. Security: - Requires valid session in ACTIVE state - Validates device fingerprint binding - Generates fresh tokens (not returning stored ones) - Only accessible to authenticated sessions with user_id - Validates that header session_id matches path session_id
|
|
5595
|
-
* @summary Get Session User
|
|
5596
|
-
* @param {SessionApiGetSessionUserApiV1SessionSessionIdUserGetRequest} requestParameters Request parameters.
|
|
5597
|
-
* @param {*} [options] Override http request option.
|
|
5598
|
-
* @throws {RequiredError}
|
|
5599
|
-
*/
|
|
5600
|
-
getSessionUserApiV1SessionSessionIdUserGet(requestParameters: SessionApiGetSessionUserApiV1SessionSessionIdUserGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<FinaticResponseSessionUserResponse>;
|
|
5601
|
-
/**
|
|
5602
|
-
* Initialize a new session with company API key.
|
|
5603
|
-
* @summary Init Session
|
|
5604
|
-
* @param {SessionApiInitSessionApiV1SessionInitPostRequest} requestParameters Request parameters.
|
|
5605
|
-
* @param {*} [options] Override http request option.
|
|
5606
|
-
* @throws {RequiredError}
|
|
5607
|
-
*/
|
|
5608
|
-
initSessionApiV1SessionInitPost(requestParameters: SessionApiInitSessionApiV1SessionInitPostRequest, options?: RawAxiosRequestConfig): AxiosPromise<FinaticResponseTokenResponseData>;
|
|
5609
|
-
/**
|
|
5610
|
-
* Start a session with a one-time token.
|
|
5611
|
-
* @summary Start Session
|
|
5612
|
-
* @param {SessionApiStartSessionApiV1SessionStartPostRequest} requestParameters Request parameters.
|
|
5613
|
-
* @param {*} [options] Override http request option.
|
|
5614
|
-
* @throws {RequiredError}
|
|
5615
|
-
*/
|
|
5616
|
-
startSessionApiV1SessionStartPost(requestParameters: SessionApiStartSessionApiV1SessionStartPostRequest, options?: RawAxiosRequestConfig): AxiosPromise<FinaticResponseSessionResponseData>;
|
|
5617
|
-
};
|
|
5618
5019
|
/**
|
|
5619
5020
|
* SessionApi - interface
|
|
5620
5021
|
*/
|
|
@@ -5951,17 +5352,17 @@ interface ParsedFinaticError {
|
|
|
5951
5352
|
code?: string;
|
|
5952
5353
|
}>;
|
|
5953
5354
|
}
|
|
5954
|
-
declare class FinaticError
|
|
5355
|
+
declare class FinaticError extends Error {
|
|
5955
5356
|
statusCode?: number | undefined;
|
|
5956
5357
|
requestId?: string | undefined;
|
|
5957
5358
|
originalError?: any | undefined;
|
|
5958
5359
|
finatic?: ParsedFinaticError | undefined;
|
|
5959
5360
|
constructor(message: string, statusCode?: number | undefined, requestId?: string | undefined, originalError?: any | undefined, finatic?: ParsedFinaticError | undefined);
|
|
5960
5361
|
}
|
|
5961
|
-
declare class ApiError extends FinaticError
|
|
5362
|
+
declare class ApiError extends FinaticError {
|
|
5962
5363
|
constructor(message: string, statusCode: number, requestId?: string, originalError?: any, finatic?: ParsedFinaticError);
|
|
5963
5364
|
}
|
|
5964
|
-
declare class ValidationError extends FinaticError
|
|
5365
|
+
declare class ValidationError extends FinaticError {
|
|
5965
5366
|
constructor(message: string, requestId?: string, originalError?: any, finatic?: ParsedFinaticError);
|
|
5966
5367
|
}
|
|
5967
5368
|
/**
|
|
@@ -7852,31 +7253,5 @@ declare class FinaticConnect extends FinaticConnect$1 {
|
|
|
7852
7253
|
static readonly __CUSTOM_CLASS__ = true;
|
|
7853
7254
|
}
|
|
7854
7255
|
|
|
7855
|
-
|
|
7856
|
-
|
|
7857
|
-
* FinaticAPI REST API
|
|
7858
|
-
*
|
|
7859
|
-
* The version of the OpenAPI document: 1.0.0
|
|
7860
|
-
*
|
|
7861
|
-
*
|
|
7862
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
7863
|
-
* https://openapi-generator.tech
|
|
7864
|
-
* Do not edit the class manually.
|
|
7865
|
-
*/
|
|
7866
|
-
/**
|
|
7867
|
-
* Standard error response envelope for API non-2xx responses.
|
|
7868
|
-
*/
|
|
7869
|
-
interface FinaticError {
|
|
7870
|
-
/**
|
|
7871
|
-
* Error details including type, code, message, and trace_id. Shape: { type: FinaticErrorType, code: string, message: string, trace_id: string, details?: any, fields?: FinaticErrorField[] }
|
|
7872
|
-
*/
|
|
7873
|
-
'error': {
|
|
7874
|
-
[key: string]: any;
|
|
7875
|
-
};
|
|
7876
|
-
'meta'?: {
|
|
7877
|
-
[key: string]: any;
|
|
7878
|
-
} | null;
|
|
7879
|
-
}
|
|
7880
|
-
|
|
7881
|
-
export { AccountStatus, ApiError, BrokerDataAccountTypeEnum, BrokerDataAssetTypeEnum, BrokerDataOrderSideEnum, BrokerDataPositionStatusEnum, BrokersApi, BrokersApiAxiosParamCreator, BrokersApiFactory, BrokersApiFp, BrokersWrapper, CompanyApi, CompanyApiAxiosParamCreator, CompanyApiFactory, CompanyApiFp, CompanyWrapper, Configuration, EventEmitter, FDXAccountStatus, FDXAccountType, FDXAssetType, FDXBalanceType, FDXOrderClass, FDXOrderEventType, FDXOrderGroupType, FDXOrderSide, FDXOrderStatus, FDXOrderType, FDXPositionSide, FDXPositionStatus, FDXSecurityIdType, FDXTimeInForce, FinaticConnect, FinaticError$1 as FinaticError, PaginatedData, SessionApi, SessionApiAxiosParamCreator, SessionApiFactory, SessionApiFp, SessionStatus, SessionWrapper, ValidationError, addErrorInterceptor, addRequestInterceptor, addResponseInterceptor, appendBrokerFilterToURL, appendThemeToURL, applyErrorInterceptors, applyRequestInterceptors, applyResponseInterceptors, coerceEnumValue, convertToPlainObject, defaultConfig, generateCacheKey, generateRequestId, getCache, getConfig, getLogger, handleError, numberSchema, retryApiCall, stringSchema, unwrapAxiosResponse, validateParams };
|
|
7882
|
-
export type { Accounttype, ValidationError$1 as ApiValidationError, Assettype, Availablebalance, Availabletowithdraw, Averagebuyprice, Averagefillprice, Averagesellprice, Balancetype, BrokerInfo, BrokersApiDisconnectCompanyFromBrokerApiV1BrokersDisconnectCompanyConnectionIdDeleteRequest, BrokersApiGetAccountsApiV1BrokersDataAccountsGetRequest, BrokersApiGetBalancesApiV1BrokersDataBalancesGetRequest, BrokersApiGetOrderEventsApiV1BrokersDataOrdersOrderIdEventsGetRequest, BrokersApiGetOrderFillsApiV1BrokersDataOrdersOrderIdFillsGetRequest, BrokersApiGetOrderGroupsApiV1BrokersDataOrdersGroupsGetRequest, BrokersApiGetOrdersApiV1BrokersDataOrdersGetRequest, BrokersApiGetPositionLotFillsApiV1BrokersDataPositionsLotsLotIdFillsGetRequest, BrokersApiGetPositionLotsApiV1BrokersDataPositionsLotsGetRequest, BrokersApiGetPositionsApiV1BrokersDataPositionsGetRequest, BrokersApiInterface, Buyingpower, Cashbalance, Closedquantity, Closepriceavg, Commission, Commissionshare, CompanyApiGetCompanyApiV1CompanyCompanyIdGet0Request, CompanyApiGetCompanyApiV1CompanyCompanyIdGetRequest, CompanyApiInterface, CompanyResponse, ConfigurationParameters, Costbasis, Costbasis1, Costbasiswithcommission, Costbasiswithcommission1, Currentbalance, Currentprice, DisconnectActionResult, ErrorInterceptor, Eventtype, FDXBrokerAccount, FDXBrokerBalance, FDXBrokerOrder, FDXBrokerOrderEvent, FDXBrokerOrderFill, FDXBrokerOrderGroup, FDXBrokerPosition, FDXBrokerPositionLot, FDXBrokerPositionLotFill, FDXOrderGroupOrder, FDXOrderLeg, Filledquantity, Fillprice, Fillquantity, FinaticConnectOptions, FinaticError as FinaticErrorInterface, FinaticResponse$3 as FinaticResponse, FinaticResponseCompanyResponse, FinaticResponseDisconnectActionResult, FinaticResponseListBrokerInfo, FinaticResponseListFDXBrokerAccount, FinaticResponseListFDXBrokerBalance, FinaticResponseListFDXBrokerOrder, FinaticResponseListFDXBrokerOrderEvent, FinaticResponseListFDXBrokerOrderFill, FinaticResponseListFDXBrokerOrderGroup, FinaticResponseListFDXBrokerPosition, FinaticResponseListFDXBrokerPositionLot, FinaticResponseListFDXBrokerPositionLotFill, FinaticResponseListUserBrokerConnectionWithPermissions, FinaticResponsePortalUrlResponse, FinaticResponseSessionResponseData, FinaticResponseSessionUserResponse, FinaticResponseTokenResponseData, Futureunderlyingassettype, Grouptype, HTTPValidationError, Initialmargin, InterceptorChain, Limitprice, LogLevel, Logger, Maintenancemargin, Marketvalue, Netliquidationvalue, Openprice, Openquantity, Orderclass, Orderstatus, Ordertype, PaginationMeta, ParsedFinaticError, Pendingbalance, PortalUrlResponse, Previousstatus, Price, Quantity, Quantity1, Quantity2, Realizedprofitloss, Realizedprofitloss1, Realizedprofitlosspercent, Realizedprofitlosswithcommission, Realizedprofitlosswithcommission1, Remainingquantity, Remainingquantity1, RequestInterceptor, ResponseInterceptor, RetryOptions, SdkConfig, Securityidtype, SessionApiGetPortalUrlApiV1SessionPortalGetRequest, SessionApiGetSessionUserApiV1SessionSessionIdUserGetRequest, SessionApiInitSessionApiV1SessionInitPostRequest, SessionApiInterface, SessionApiStartSessionApiV1SessionStartPostRequest, SessionResponseData, SessionStartRequest, SessionUserResponse, Side, Side1, Side2, Side3, Status, Status1, Stopprice, Strikeprice, SuccessPayloadCompanyResponse, SuccessPayloadDisconnectActionResult, SuccessPayloadListBrokerInfo, SuccessPayloadListFDXBrokerAccount, SuccessPayloadListFDXBrokerBalance, SuccessPayloadListFDXBrokerOrder, SuccessPayloadListFDXBrokerOrderEvent, SuccessPayloadListFDXBrokerOrderFill, SuccessPayloadListFDXBrokerOrderGroup, SuccessPayloadListFDXBrokerPosition, SuccessPayloadListFDXBrokerPositionLot, SuccessPayloadListFDXBrokerPositionLotFill, SuccessPayloadListUserBrokerConnectionWithPermissions, SuccessPayloadPortalUrlResponse, SuccessPayloadSessionResponseData, SuccessPayloadSessionUserResponse, SuccessPayloadTokenResponseData, Timeinforce, TokenResponseData, Totalcashvalue, Totalrealizedpnl, Units, Unrealizedprofitloss, Unrealizedprofitlosspercent, UserBrokerConnectionWithPermissions, ValidationErrorLocInner };
|
|
7256
|
+
export { AccountStatus, ApiError, BrokerDataAccountTypeEnum, BrokerDataAssetTypeEnum, BrokerDataOrderSideEnum, BrokerDataPositionStatusEnum, BrokersWrapper, CompanyWrapper, Configuration, EventEmitter, FDXAccountStatus, FDXAccountType, FDXAssetType, FDXBalanceType, FDXOrderClass, FDXOrderEventType, FDXOrderGroupType, FDXOrderSide, FDXOrderStatus, FDXOrderType, FDXPositionSide, FDXPositionStatus, FDXSecurityIdType, FDXTimeInForce, FinaticConnect, FinaticError, PaginatedData, SessionStatus, SessionWrapper, ValidationError, addErrorInterceptor, addRequestInterceptor, addResponseInterceptor, appendBrokerFilterToURL, appendThemeToURL, applyErrorInterceptors, applyRequestInterceptors, applyResponseInterceptors, coerceEnumValue, convertToPlainObject, defaultConfig, generateCacheKey, generateRequestId, getCache, getConfig, getLogger, handleError, numberSchema, retryApiCall, stringSchema, unwrapAxiosResponse, validateParams };
|
|
7257
|
+
export type { Accounttype, ValidationError$1 as ApiValidationError, Assettype, Availablebalance, Availabletowithdraw, Averagebuyprice, Averagefillprice, Averagesellprice, Balancetype, BrokerInfo, Buyingpower, Cashbalance, Closedquantity, Closepriceavg, Commission, Commissionshare, CompanyResponse, ConfigurationParameters, Costbasis, Costbasis1, Costbasiswithcommission, Costbasiswithcommission1, Currentbalance, Currentprice, DisconnectActionResult, ErrorInterceptor, Eventtype, FDXBrokerAccount, FDXBrokerBalance, FDXBrokerOrder, FDXBrokerOrderEvent, FDXBrokerOrderFill, FDXBrokerOrderGroup, FDXBrokerPosition, FDXBrokerPositionLot, FDXBrokerPositionLotFill, FDXOrderGroupOrder, FDXOrderLeg, Filledquantity, Fillprice, Fillquantity, FinaticConnectOptions, FinaticResponse$3 as FinaticResponse, FinaticResponseCompanyResponse, FinaticResponseDisconnectActionResult, FinaticResponseListBrokerInfo, FinaticResponseListFDXBrokerAccount, FinaticResponseListFDXBrokerBalance, FinaticResponseListFDXBrokerOrder, FinaticResponseListFDXBrokerOrderEvent, FinaticResponseListFDXBrokerOrderFill, FinaticResponseListFDXBrokerOrderGroup, FinaticResponseListFDXBrokerPosition, FinaticResponseListFDXBrokerPositionLot, FinaticResponseListFDXBrokerPositionLotFill, FinaticResponseListUserBrokerConnectionWithPermissions, FinaticResponsePortalUrlResponse, FinaticResponseSessionResponseData, FinaticResponseSessionUserResponse, FinaticResponseTokenResponseData, Futureunderlyingassettype, Grouptype, HTTPValidationError, Initialmargin, InterceptorChain, Limitprice, LogLevel, Logger, Maintenancemargin, Marketvalue, Netliquidationvalue, Openprice, Openquantity, Orderclass, Orderstatus, Ordertype, PaginationMeta, ParsedFinaticError, Pendingbalance, PortalUrlResponse, Previousstatus, Price, Quantity, Quantity1, Quantity2, Realizedprofitloss, Realizedprofitloss1, Realizedprofitlosspercent, Realizedprofitlosswithcommission, Realizedprofitlosswithcommission1, Remainingquantity, Remainingquantity1, RequestInterceptor, ResponseInterceptor, RetryOptions, SdkConfig, Securityidtype, SessionResponseData, SessionStartRequest, SessionUserResponse, Side, Side1, Side2, Side3, Status, Status1, Stopprice, Strikeprice, SuccessPayloadCompanyResponse, SuccessPayloadDisconnectActionResult, SuccessPayloadListBrokerInfo, SuccessPayloadListFDXBrokerAccount, SuccessPayloadListFDXBrokerBalance, SuccessPayloadListFDXBrokerOrder, SuccessPayloadListFDXBrokerOrderEvent, SuccessPayloadListFDXBrokerOrderFill, SuccessPayloadListFDXBrokerOrderGroup, SuccessPayloadListFDXBrokerPosition, SuccessPayloadListFDXBrokerPositionLot, SuccessPayloadListFDXBrokerPositionLotFill, SuccessPayloadListUserBrokerConnectionWithPermissions, SuccessPayloadPortalUrlResponse, SuccessPayloadSessionResponseData, SuccessPayloadSessionUserResponse, SuccessPayloadTokenResponseData, Timeinforce, TokenResponseData, Totalcashvalue, Totalrealizedpnl, Units, Unrealizedprofitloss, Unrealizedprofitlosspercent, UserBrokerConnectionWithPermissions, ValidationErrorLocInner };
|