@finatic/client 0.9.4 → 0.9.6
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 +8 -606
- package/dist/index.js +3281 -380
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +3287 -355
- package/dist/index.mjs.map +1 -1
- package/package.json +16 -20
package/dist/index.d.ts
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import * as axios from 'axios';
|
|
2
2
|
import { AxiosInstance, RawAxiosRequestConfig, AxiosPromise, AxiosRequestConfig, AxiosResponse } from 'axios';
|
|
3
|
+
import { RetryContext } from 'p-retry';
|
|
3
4
|
import * as z from 'zod';
|
|
4
5
|
|
|
5
6
|
/**
|
|
@@ -112,10 +113,6 @@ declare class Configuration {
|
|
|
112
113
|
* Do not edit the class manually.
|
|
113
114
|
*/
|
|
114
115
|
|
|
115
|
-
interface RequestArgs {
|
|
116
|
-
url: string;
|
|
117
|
-
options: RawAxiosRequestConfig;
|
|
118
|
-
}
|
|
119
116
|
declare class BaseAPI {
|
|
120
117
|
protected basePath: string;
|
|
121
118
|
protected axios: AxiosInstance;
|
|
@@ -3316,423 +3313,6 @@ interface SessionStartRequest {
|
|
|
3316
3313
|
'user_id'?: string | null;
|
|
3317
3314
|
}
|
|
3318
3315
|
|
|
3319
|
-
/**
|
|
3320
|
-
* BrokersApi - axios parameter creator
|
|
3321
|
-
*/
|
|
3322
|
-
declare const BrokersApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
3323
|
-
/**
|
|
3324
|
-
* 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.
|
|
3325
|
-
* @summary Disconnect Company From Broker
|
|
3326
|
-
* @param {string} connectionId Connection ID
|
|
3327
|
-
* @param {*} [options] Override http request option.
|
|
3328
|
-
* @throws {RequiredError}
|
|
3329
|
-
*/
|
|
3330
|
-
disconnectCompanyFromBrokerApiV1BrokersDisconnectCompanyConnectionIdDelete: (connectionId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3331
|
-
/**
|
|
3332
|
-
* 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.
|
|
3333
|
-
* @summary Get Accounts
|
|
3334
|
-
* @param {string | null} [brokerId] Filter by broker ID
|
|
3335
|
-
* @param {string | null} [connectionId] Filter by connection ID
|
|
3336
|
-
* @param {BrokerDataAccountTypeEnum | null} [accountType] Filter by account type (e.g., \'margin\', \'cash\', \'crypto_wallet\', \'live\', \'sim\')
|
|
3337
|
-
* @param {AccountStatus | null} [status] Filter by account status (e.g., \'active\', \'inactive\')
|
|
3338
|
-
* @param {string | null} [currency] Filter by currency (e.g., \'USD\', \'EUR\')
|
|
3339
|
-
* @param {number} [limit] Maximum number of accounts to return
|
|
3340
|
-
* @param {number} [offset] Number of accounts to skip for pagination
|
|
3341
|
-
* @param {boolean} [includeMetadata] Include connection metadata in response (excluded by default for FDX compliance)
|
|
3342
|
-
* @param {*} [options] Override http request option.
|
|
3343
|
-
* @throws {RequiredError}
|
|
3344
|
-
*/
|
|
3345
|
-
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>;
|
|
3346
|
-
/**
|
|
3347
|
-
* 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.
|
|
3348
|
-
* @summary Get Balances
|
|
3349
|
-
* @param {string | null} [brokerId] Filter by broker ID
|
|
3350
|
-
* @param {string | null} [connectionId] Filter by connection ID
|
|
3351
|
-
* @param {string | null} [accountId] Filter by broker provided account ID or internal account UUID
|
|
3352
|
-
* @param {boolean | null} [isEndOfDaySnapshot] Filter by end-of-day snapshot status (true/false)
|
|
3353
|
-
* @param {number} [limit] Maximum number of balances to return
|
|
3354
|
-
* @param {number} [offset] Number of balances to skip for pagination
|
|
3355
|
-
* @param {string | null} [balanceCreatedAfter] Filter balances created after this timestamp
|
|
3356
|
-
* @param {string | null} [balanceCreatedBefore] Filter balances created before this timestamp
|
|
3357
|
-
* @param {boolean} [includeMetadata] Include balance metadata in response (excluded by default for FDX compliance)
|
|
3358
|
-
* @param {*} [options] Override http request option.
|
|
3359
|
-
* @throws {RequiredError}
|
|
3360
|
-
*/
|
|
3361
|
-
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>;
|
|
3362
|
-
/**
|
|
3363
|
-
* 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.
|
|
3364
|
-
* @summary Get Brokers
|
|
3365
|
-
* @param {*} [options] Override http request option.
|
|
3366
|
-
* @throws {RequiredError}
|
|
3367
|
-
*/
|
|
3368
|
-
getBrokersApiV1BrokersGet: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3369
|
-
/**
|
|
3370
|
-
* Get order events for a specific order. This endpoint returns all lifecycle events for the specified order.
|
|
3371
|
-
* @summary Get Order Events
|
|
3372
|
-
* @param {string} orderId Order ID
|
|
3373
|
-
* @param {string | null} [connectionId] Filter by connection ID
|
|
3374
|
-
* @param {number} [limit] Maximum number of events to return
|
|
3375
|
-
* @param {number} [offset] Number of events to skip for pagination
|
|
3376
|
-
* @param {boolean} [includeMetadata] Include event metadata in response (excluded by default for FDX compliance)
|
|
3377
|
-
* @param {*} [options] Override http request option.
|
|
3378
|
-
* @throws {RequiredError}
|
|
3379
|
-
*/
|
|
3380
|
-
getOrderEventsApiV1BrokersDataOrdersOrderIdEventsGet: (orderId: string, connectionId?: string | null, limit?: number, offset?: number, includeMetadata?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3381
|
-
/**
|
|
3382
|
-
* Get order fills for a specific order. This endpoint returns all execution fills for the specified order.
|
|
3383
|
-
* @summary Get Order Fills
|
|
3384
|
-
* @param {string} orderId Order ID
|
|
3385
|
-
* @param {string | null} [connectionId] Filter by connection ID
|
|
3386
|
-
* @param {number} [limit] Maximum number of fills to return
|
|
3387
|
-
* @param {number} [offset] Number of fills to skip for pagination
|
|
3388
|
-
* @param {boolean} [includeMetadata] Include fill metadata in response (excluded by default for FDX compliance)
|
|
3389
|
-
* @param {*} [options] Override http request option.
|
|
3390
|
-
* @throws {RequiredError}
|
|
3391
|
-
*/
|
|
3392
|
-
getOrderFillsApiV1BrokersDataOrdersOrderIdFillsGet: (orderId: string, connectionId?: string | null, limit?: number, offset?: number, includeMetadata?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3393
|
-
/**
|
|
3394
|
-
* Get order groups. This endpoint returns order groups that contain multiple orders.
|
|
3395
|
-
* @summary Get Order Groups
|
|
3396
|
-
* @param {string | null} [brokerId] Filter by broker ID
|
|
3397
|
-
* @param {string | null} [connectionId] Filter by connection ID
|
|
3398
|
-
* @param {number} [limit] Maximum number of order groups to return
|
|
3399
|
-
* @param {number} [offset] Number of order groups to skip for pagination
|
|
3400
|
-
* @param {string | null} [createdAfter] Filter order groups created after this timestamp
|
|
3401
|
-
* @param {string | null} [createdBefore] Filter order groups created before this timestamp
|
|
3402
|
-
* @param {boolean} [includeMetadata] Include group metadata in response (excluded by default for FDX compliance)
|
|
3403
|
-
* @param {*} [options] Override http request option.
|
|
3404
|
-
* @throws {RequiredError}
|
|
3405
|
-
*/
|
|
3406
|
-
getOrderGroupsApiV1BrokersDataOrdersGroupsGet: (brokerId?: string | null, connectionId?: string | null, limit?: number, offset?: number, createdAfter?: string | null, createdBefore?: string | null, includeMetadata?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3407
|
-
/**
|
|
3408
|
-
* 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.
|
|
3409
|
-
* @summary Get Orders
|
|
3410
|
-
* @param {string | null} [brokerId] Filter by broker ID
|
|
3411
|
-
* @param {string | null} [connectionId] Filter by connection ID
|
|
3412
|
-
* @param {string | null} [accountId] Filter by broker provided account ID or internal account UUID
|
|
3413
|
-
* @param {string | null} [symbol] Filter by symbol
|
|
3414
|
-
* @param {string | null} [orderStatus] Filter by order status (e.g., \'filled\', \'pending_new\', \'cancelled\')
|
|
3415
|
-
* @param {BrokerDataOrderSideEnum | null} [side] Filter by order side (e.g., \'buy\', \'sell\')
|
|
3416
|
-
* @param {BrokerDataAssetTypeEnum | null} [assetType] Filter by asset type (e.g., \'stock\', \'option\', \'crypto\', \'future\')
|
|
3417
|
-
* @param {number} [limit] Maximum number of orders to return
|
|
3418
|
-
* @param {number} [offset] Number of orders to skip for pagination
|
|
3419
|
-
* @param {string | null} [createdAfter] Filter orders created after this timestamp
|
|
3420
|
-
* @param {string | null} [createdBefore] Filter orders created before this timestamp
|
|
3421
|
-
* @param {boolean} [includeMetadata] Include order metadata in response (excluded by default for FDX compliance)
|
|
3422
|
-
* @param {*} [options] Override http request option.
|
|
3423
|
-
* @throws {RequiredError}
|
|
3424
|
-
*/
|
|
3425
|
-
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>;
|
|
3426
|
-
/**
|
|
3427
|
-
* Get position lot fills for a specific lot. This endpoint returns all fills associated with a specific position lot.
|
|
3428
|
-
* @summary Get Position Lot Fills
|
|
3429
|
-
* @param {string} lotId Position lot ID
|
|
3430
|
-
* @param {string | null} [connectionId] Filter by connection ID
|
|
3431
|
-
* @param {number} [limit] Maximum number of fills to return
|
|
3432
|
-
* @param {number} [offset] Number of fills to skip for pagination
|
|
3433
|
-
* @param {*} [options] Override http request option.
|
|
3434
|
-
* @throws {RequiredError}
|
|
3435
|
-
*/
|
|
3436
|
-
getPositionLotFillsApiV1BrokersDataPositionsLotsLotIdFillsGet: (lotId: string, connectionId?: string | null, limit?: number, offset?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3437
|
-
/**
|
|
3438
|
-
* 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.
|
|
3439
|
-
* @summary Get Position Lots
|
|
3440
|
-
* @param {string | null} [brokerId] Filter by broker ID
|
|
3441
|
-
* @param {string | null} [connectionId] Filter by connection ID
|
|
3442
|
-
* @param {string | null} [accountId] Filter by broker provided account ID
|
|
3443
|
-
* @param {string | null} [symbol] Filter by symbol
|
|
3444
|
-
* @param {string | null} [positionId] Filter by position ID
|
|
3445
|
-
* @param {number} [limit] Maximum number of position lots to return
|
|
3446
|
-
* @param {number} [offset] Number of position lots to skip for pagination
|
|
3447
|
-
* @param {*} [options] Override http request option.
|
|
3448
|
-
* @throws {RequiredError}
|
|
3449
|
-
*/
|
|
3450
|
-
getPositionLotsApiV1BrokersDataPositionsLotsGet: (brokerId?: string | null, connectionId?: string | null, accountId?: string | null, symbol?: string | null, positionId?: string | null, limit?: number, offset?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3451
|
-
/**
|
|
3452
|
-
* 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.
|
|
3453
|
-
* @summary Get Positions
|
|
3454
|
-
* @param {string | null} [brokerId] Filter by broker ID
|
|
3455
|
-
* @param {string | null} [connectionId] Filter by connection ID
|
|
3456
|
-
* @param {string | null} [accountId] Filter by broker provided account ID or internal account UUID
|
|
3457
|
-
* @param {string | null} [symbol] Filter by symbol
|
|
3458
|
-
* @param {BrokerDataOrderSideEnum | null} [side] Filter by position side (e.g., \'long\', \'short\')
|
|
3459
|
-
* @param {BrokerDataAssetTypeEnum | null} [assetType] Filter by asset type (e.g., \'stock\', \'option\', \'crypto\', \'future\')
|
|
3460
|
-
* @param {BrokerDataPositionStatusEnum | null} [positionStatus] Filter by position status: \'open\' (quantity > 0) or \'closed\' (quantity = 0)
|
|
3461
|
-
* @param {number} [limit] Maximum number of positions to return
|
|
3462
|
-
* @param {number} [offset] Number of positions to skip for pagination
|
|
3463
|
-
* @param {string | null} [updatedAfter] Filter positions updated after this timestamp
|
|
3464
|
-
* @param {string | null} [updatedBefore] Filter positions updated before this timestamp
|
|
3465
|
-
* @param {boolean} [includeMetadata] Include position metadata in response (excluded by default for FDX compliance)
|
|
3466
|
-
* @param {*} [options] Override http request option.
|
|
3467
|
-
* @throws {RequiredError}
|
|
3468
|
-
*/
|
|
3469
|
-
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>;
|
|
3470
|
-
/**
|
|
3471
|
-
* 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.
|
|
3472
|
-
* @summary List Broker Connections
|
|
3473
|
-
* @param {*} [options] Override http request option.
|
|
3474
|
-
* @throws {RequiredError}
|
|
3475
|
-
*/
|
|
3476
|
-
listBrokerConnectionsApiV1BrokersConnectionsGet: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3477
|
-
};
|
|
3478
|
-
/**
|
|
3479
|
-
* BrokersApi - functional programming interface
|
|
3480
|
-
*/
|
|
3481
|
-
declare const BrokersApiFp: (configuration?: Configuration) => {
|
|
3482
|
-
/**
|
|
3483
|
-
* 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.
|
|
3484
|
-
* @summary Disconnect Company From Broker
|
|
3485
|
-
* @param {string} connectionId Connection ID
|
|
3486
|
-
* @param {*} [options] Override http request option.
|
|
3487
|
-
* @throws {RequiredError}
|
|
3488
|
-
*/
|
|
3489
|
-
disconnectCompanyFromBrokerApiV1BrokersDisconnectCompanyConnectionIdDelete(connectionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FinaticResponseDisconnectActionResult>>;
|
|
3490
|
-
/**
|
|
3491
|
-
* 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.
|
|
3492
|
-
* @summary Get Accounts
|
|
3493
|
-
* @param {string | null} [brokerId] Filter by broker ID
|
|
3494
|
-
* @param {string | null} [connectionId] Filter by connection ID
|
|
3495
|
-
* @param {BrokerDataAccountTypeEnum | null} [accountType] Filter by account type (e.g., \'margin\', \'cash\', \'crypto_wallet\', \'live\', \'sim\')
|
|
3496
|
-
* @param {AccountStatus | null} [status] Filter by account status (e.g., \'active\', \'inactive\')
|
|
3497
|
-
* @param {string | null} [currency] Filter by currency (e.g., \'USD\', \'EUR\')
|
|
3498
|
-
* @param {number} [limit] Maximum number of accounts to return
|
|
3499
|
-
* @param {number} [offset] Number of accounts to skip for pagination
|
|
3500
|
-
* @param {boolean} [includeMetadata] Include connection metadata in response (excluded by default for FDX compliance)
|
|
3501
|
-
* @param {*} [options] Override http request option.
|
|
3502
|
-
* @throws {RequiredError}
|
|
3503
|
-
*/
|
|
3504
|
-
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>>;
|
|
3505
|
-
/**
|
|
3506
|
-
* 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.
|
|
3507
|
-
* @summary Get Balances
|
|
3508
|
-
* @param {string | null} [brokerId] Filter by broker ID
|
|
3509
|
-
* @param {string | null} [connectionId] Filter by connection ID
|
|
3510
|
-
* @param {string | null} [accountId] Filter by broker provided account ID or internal account UUID
|
|
3511
|
-
* @param {boolean | null} [isEndOfDaySnapshot] Filter by end-of-day snapshot status (true/false)
|
|
3512
|
-
* @param {number} [limit] Maximum number of balances to return
|
|
3513
|
-
* @param {number} [offset] Number of balances to skip for pagination
|
|
3514
|
-
* @param {string | null} [balanceCreatedAfter] Filter balances created after this timestamp
|
|
3515
|
-
* @param {string | null} [balanceCreatedBefore] Filter balances created before this timestamp
|
|
3516
|
-
* @param {boolean} [includeMetadata] Include balance metadata in response (excluded by default for FDX compliance)
|
|
3517
|
-
* @param {*} [options] Override http request option.
|
|
3518
|
-
* @throws {RequiredError}
|
|
3519
|
-
*/
|
|
3520
|
-
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>>;
|
|
3521
|
-
/**
|
|
3522
|
-
* 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.
|
|
3523
|
-
* @summary Get Brokers
|
|
3524
|
-
* @param {*} [options] Override http request option.
|
|
3525
|
-
* @throws {RequiredError}
|
|
3526
|
-
*/
|
|
3527
|
-
getBrokersApiV1BrokersGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FinaticResponseListBrokerInfo>>;
|
|
3528
|
-
/**
|
|
3529
|
-
* Get order events for a specific order. This endpoint returns all lifecycle events for the specified order.
|
|
3530
|
-
* @summary Get Order Events
|
|
3531
|
-
* @param {string} orderId Order ID
|
|
3532
|
-
* @param {string | null} [connectionId] Filter by connection ID
|
|
3533
|
-
* @param {number} [limit] Maximum number of events to return
|
|
3534
|
-
* @param {number} [offset] Number of events to skip for pagination
|
|
3535
|
-
* @param {boolean} [includeMetadata] Include event metadata in response (excluded by default for FDX compliance)
|
|
3536
|
-
* @param {*} [options] Override http request option.
|
|
3537
|
-
* @throws {RequiredError}
|
|
3538
|
-
*/
|
|
3539
|
-
getOrderEventsApiV1BrokersDataOrdersOrderIdEventsGet(orderId: string, connectionId?: string | null, limit?: number, offset?: number, includeMetadata?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FinaticResponseListFDXBrokerOrderEvent>>;
|
|
3540
|
-
/**
|
|
3541
|
-
* Get order fills for a specific order. This endpoint returns all execution fills for the specified order.
|
|
3542
|
-
* @summary Get Order Fills
|
|
3543
|
-
* @param {string} orderId Order ID
|
|
3544
|
-
* @param {string | null} [connectionId] Filter by connection ID
|
|
3545
|
-
* @param {number} [limit] Maximum number of fills to return
|
|
3546
|
-
* @param {number} [offset] Number of fills to skip for pagination
|
|
3547
|
-
* @param {boolean} [includeMetadata] Include fill metadata in response (excluded by default for FDX compliance)
|
|
3548
|
-
* @param {*} [options] Override http request option.
|
|
3549
|
-
* @throws {RequiredError}
|
|
3550
|
-
*/
|
|
3551
|
-
getOrderFillsApiV1BrokersDataOrdersOrderIdFillsGet(orderId: string, connectionId?: string | null, limit?: number, offset?: number, includeMetadata?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FinaticResponseListFDXBrokerOrderFill>>;
|
|
3552
|
-
/**
|
|
3553
|
-
* Get order groups. This endpoint returns order groups that contain multiple orders.
|
|
3554
|
-
* @summary Get Order Groups
|
|
3555
|
-
* @param {string | null} [brokerId] Filter by broker ID
|
|
3556
|
-
* @param {string | null} [connectionId] Filter by connection ID
|
|
3557
|
-
* @param {number} [limit] Maximum number of order groups to return
|
|
3558
|
-
* @param {number} [offset] Number of order groups to skip for pagination
|
|
3559
|
-
* @param {string | null} [createdAfter] Filter order groups created after this timestamp
|
|
3560
|
-
* @param {string | null} [createdBefore] Filter order groups created before this timestamp
|
|
3561
|
-
* @param {boolean} [includeMetadata] Include group metadata in response (excluded by default for FDX compliance)
|
|
3562
|
-
* @param {*} [options] Override http request option.
|
|
3563
|
-
* @throws {RequiredError}
|
|
3564
|
-
*/
|
|
3565
|
-
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>>;
|
|
3566
|
-
/**
|
|
3567
|
-
* 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.
|
|
3568
|
-
* @summary Get Orders
|
|
3569
|
-
* @param {string | null} [brokerId] Filter by broker ID
|
|
3570
|
-
* @param {string | null} [connectionId] Filter by connection ID
|
|
3571
|
-
* @param {string | null} [accountId] Filter by broker provided account ID or internal account UUID
|
|
3572
|
-
* @param {string | null} [symbol] Filter by symbol
|
|
3573
|
-
* @param {string | null} [orderStatus] Filter by order status (e.g., \'filled\', \'pending_new\', \'cancelled\')
|
|
3574
|
-
* @param {BrokerDataOrderSideEnum | null} [side] Filter by order side (e.g., \'buy\', \'sell\')
|
|
3575
|
-
* @param {BrokerDataAssetTypeEnum | null} [assetType] Filter by asset type (e.g., \'stock\', \'option\', \'crypto\', \'future\')
|
|
3576
|
-
* @param {number} [limit] Maximum number of orders to return
|
|
3577
|
-
* @param {number} [offset] Number of orders to skip for pagination
|
|
3578
|
-
* @param {string | null} [createdAfter] Filter orders created after this timestamp
|
|
3579
|
-
* @param {string | null} [createdBefore] Filter orders created before this timestamp
|
|
3580
|
-
* @param {boolean} [includeMetadata] Include order metadata in response (excluded by default for FDX compliance)
|
|
3581
|
-
* @param {*} [options] Override http request option.
|
|
3582
|
-
* @throws {RequiredError}
|
|
3583
|
-
*/
|
|
3584
|
-
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>>;
|
|
3585
|
-
/**
|
|
3586
|
-
* Get position lot fills for a specific lot. This endpoint returns all fills associated with a specific position lot.
|
|
3587
|
-
* @summary Get Position Lot Fills
|
|
3588
|
-
* @param {string} lotId Position lot ID
|
|
3589
|
-
* @param {string | null} [connectionId] Filter by connection ID
|
|
3590
|
-
* @param {number} [limit] Maximum number of fills to return
|
|
3591
|
-
* @param {number} [offset] Number of fills to skip for pagination
|
|
3592
|
-
* @param {*} [options] Override http request option.
|
|
3593
|
-
* @throws {RequiredError}
|
|
3594
|
-
*/
|
|
3595
|
-
getPositionLotFillsApiV1BrokersDataPositionsLotsLotIdFillsGet(lotId: string, connectionId?: string | null, limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FinaticResponseListFDXBrokerPositionLotFill>>;
|
|
3596
|
-
/**
|
|
3597
|
-
* 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.
|
|
3598
|
-
* @summary Get Position Lots
|
|
3599
|
-
* @param {string | null} [brokerId] Filter by broker ID
|
|
3600
|
-
* @param {string | null} [connectionId] Filter by connection ID
|
|
3601
|
-
* @param {string | null} [accountId] Filter by broker provided account ID
|
|
3602
|
-
* @param {string | null} [symbol] Filter by symbol
|
|
3603
|
-
* @param {string | null} [positionId] Filter by position ID
|
|
3604
|
-
* @param {number} [limit] Maximum number of position lots to return
|
|
3605
|
-
* @param {number} [offset] Number of position lots to skip for pagination
|
|
3606
|
-
* @param {*} [options] Override http request option.
|
|
3607
|
-
* @throws {RequiredError}
|
|
3608
|
-
*/
|
|
3609
|
-
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>>;
|
|
3610
|
-
/**
|
|
3611
|
-
* 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.
|
|
3612
|
-
* @summary Get Positions
|
|
3613
|
-
* @param {string | null} [brokerId] Filter by broker ID
|
|
3614
|
-
* @param {string | null} [connectionId] Filter by connection ID
|
|
3615
|
-
* @param {string | null} [accountId] Filter by broker provided account ID or internal account UUID
|
|
3616
|
-
* @param {string | null} [symbol] Filter by symbol
|
|
3617
|
-
* @param {BrokerDataOrderSideEnum | null} [side] Filter by position side (e.g., \'long\', \'short\')
|
|
3618
|
-
* @param {BrokerDataAssetTypeEnum | null} [assetType] Filter by asset type (e.g., \'stock\', \'option\', \'crypto\', \'future\')
|
|
3619
|
-
* @param {BrokerDataPositionStatusEnum | null} [positionStatus] Filter by position status: \'open\' (quantity > 0) or \'closed\' (quantity = 0)
|
|
3620
|
-
* @param {number} [limit] Maximum number of positions to return
|
|
3621
|
-
* @param {number} [offset] Number of positions to skip for pagination
|
|
3622
|
-
* @param {string | null} [updatedAfter] Filter positions updated after this timestamp
|
|
3623
|
-
* @param {string | null} [updatedBefore] Filter positions updated before this timestamp
|
|
3624
|
-
* @param {boolean} [includeMetadata] Include position metadata in response (excluded by default for FDX compliance)
|
|
3625
|
-
* @param {*} [options] Override http request option.
|
|
3626
|
-
* @throws {RequiredError}
|
|
3627
|
-
*/
|
|
3628
|
-
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>>;
|
|
3629
|
-
/**
|
|
3630
|
-
* 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.
|
|
3631
|
-
* @summary List Broker Connections
|
|
3632
|
-
* @param {*} [options] Override http request option.
|
|
3633
|
-
* @throws {RequiredError}
|
|
3634
|
-
*/
|
|
3635
|
-
listBrokerConnectionsApiV1BrokersConnectionsGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FinaticResponseListUserBrokerConnectionWithPermissions>>;
|
|
3636
|
-
};
|
|
3637
|
-
/**
|
|
3638
|
-
* BrokersApi - factory interface
|
|
3639
|
-
*/
|
|
3640
|
-
declare const BrokersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
3641
|
-
/**
|
|
3642
|
-
* 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.
|
|
3643
|
-
* @summary Disconnect Company From Broker
|
|
3644
|
-
* @param {BrokersApiDisconnectCompanyFromBrokerApiV1BrokersDisconnectCompanyConnectionIdDeleteRequest} requestParameters Request parameters.
|
|
3645
|
-
* @param {*} [options] Override http request option.
|
|
3646
|
-
* @throws {RequiredError}
|
|
3647
|
-
*/
|
|
3648
|
-
disconnectCompanyFromBrokerApiV1BrokersDisconnectCompanyConnectionIdDelete(requestParameters: BrokersApiDisconnectCompanyFromBrokerApiV1BrokersDisconnectCompanyConnectionIdDeleteRequest, options?: RawAxiosRequestConfig): AxiosPromise<FinaticResponseDisconnectActionResult>;
|
|
3649
|
-
/**
|
|
3650
|
-
* 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.
|
|
3651
|
-
* @summary Get Accounts
|
|
3652
|
-
* @param {BrokersApiGetAccountsApiV1BrokersDataAccountsGetRequest} requestParameters Request parameters.
|
|
3653
|
-
* @param {*} [options] Override http request option.
|
|
3654
|
-
* @throws {RequiredError}
|
|
3655
|
-
*/
|
|
3656
|
-
getAccountsApiV1BrokersDataAccountsGet(requestParameters?: BrokersApiGetAccountsApiV1BrokersDataAccountsGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<FinaticResponseListFDXBrokerAccount>;
|
|
3657
|
-
/**
|
|
3658
|
-
* 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.
|
|
3659
|
-
* @summary Get Balances
|
|
3660
|
-
* @param {BrokersApiGetBalancesApiV1BrokersDataBalancesGetRequest} requestParameters Request parameters.
|
|
3661
|
-
* @param {*} [options] Override http request option.
|
|
3662
|
-
* @throws {RequiredError}
|
|
3663
|
-
*/
|
|
3664
|
-
getBalancesApiV1BrokersDataBalancesGet(requestParameters?: BrokersApiGetBalancesApiV1BrokersDataBalancesGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<FinaticResponseListFDXBrokerBalance>;
|
|
3665
|
-
/**
|
|
3666
|
-
* 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.
|
|
3667
|
-
* @summary Get Brokers
|
|
3668
|
-
* @param {*} [options] Override http request option.
|
|
3669
|
-
* @throws {RequiredError}
|
|
3670
|
-
*/
|
|
3671
|
-
getBrokersApiV1BrokersGet(options?: RawAxiosRequestConfig): AxiosPromise<FinaticResponseListBrokerInfo>;
|
|
3672
|
-
/**
|
|
3673
|
-
* Get order events for a specific order. This endpoint returns all lifecycle events for the specified order.
|
|
3674
|
-
* @summary Get Order Events
|
|
3675
|
-
* @param {BrokersApiGetOrderEventsApiV1BrokersDataOrdersOrderIdEventsGetRequest} requestParameters Request parameters.
|
|
3676
|
-
* @param {*} [options] Override http request option.
|
|
3677
|
-
* @throws {RequiredError}
|
|
3678
|
-
*/
|
|
3679
|
-
getOrderEventsApiV1BrokersDataOrdersOrderIdEventsGet(requestParameters: BrokersApiGetOrderEventsApiV1BrokersDataOrdersOrderIdEventsGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<FinaticResponseListFDXBrokerOrderEvent>;
|
|
3680
|
-
/**
|
|
3681
|
-
* Get order fills for a specific order. This endpoint returns all execution fills for the specified order.
|
|
3682
|
-
* @summary Get Order Fills
|
|
3683
|
-
* @param {BrokersApiGetOrderFillsApiV1BrokersDataOrdersOrderIdFillsGetRequest} requestParameters Request parameters.
|
|
3684
|
-
* @param {*} [options] Override http request option.
|
|
3685
|
-
* @throws {RequiredError}
|
|
3686
|
-
*/
|
|
3687
|
-
getOrderFillsApiV1BrokersDataOrdersOrderIdFillsGet(requestParameters: BrokersApiGetOrderFillsApiV1BrokersDataOrdersOrderIdFillsGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<FinaticResponseListFDXBrokerOrderFill>;
|
|
3688
|
-
/**
|
|
3689
|
-
* Get order groups. This endpoint returns order groups that contain multiple orders.
|
|
3690
|
-
* @summary Get Order Groups
|
|
3691
|
-
* @param {BrokersApiGetOrderGroupsApiV1BrokersDataOrdersGroupsGetRequest} requestParameters Request parameters.
|
|
3692
|
-
* @param {*} [options] Override http request option.
|
|
3693
|
-
* @throws {RequiredError}
|
|
3694
|
-
*/
|
|
3695
|
-
getOrderGroupsApiV1BrokersDataOrdersGroupsGet(requestParameters?: BrokersApiGetOrderGroupsApiV1BrokersDataOrdersGroupsGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<FinaticResponseListFDXBrokerOrderGroup>;
|
|
3696
|
-
/**
|
|
3697
|
-
* 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.
|
|
3698
|
-
* @summary Get Orders
|
|
3699
|
-
* @param {BrokersApiGetOrdersApiV1BrokersDataOrdersGetRequest} requestParameters Request parameters.
|
|
3700
|
-
* @param {*} [options] Override http request option.
|
|
3701
|
-
* @throws {RequiredError}
|
|
3702
|
-
*/
|
|
3703
|
-
getOrdersApiV1BrokersDataOrdersGet(requestParameters?: BrokersApiGetOrdersApiV1BrokersDataOrdersGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<FinaticResponseListFDXBrokerOrder>;
|
|
3704
|
-
/**
|
|
3705
|
-
* Get position lot fills for a specific lot. This endpoint returns all fills associated with a specific position lot.
|
|
3706
|
-
* @summary Get Position Lot Fills
|
|
3707
|
-
* @param {BrokersApiGetPositionLotFillsApiV1BrokersDataPositionsLotsLotIdFillsGetRequest} requestParameters Request parameters.
|
|
3708
|
-
* @param {*} [options] Override http request option.
|
|
3709
|
-
* @throws {RequiredError}
|
|
3710
|
-
*/
|
|
3711
|
-
getPositionLotFillsApiV1BrokersDataPositionsLotsLotIdFillsGet(requestParameters: BrokersApiGetPositionLotFillsApiV1BrokersDataPositionsLotsLotIdFillsGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<FinaticResponseListFDXBrokerPositionLotFill>;
|
|
3712
|
-
/**
|
|
3713
|
-
* 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.
|
|
3714
|
-
* @summary Get Position Lots
|
|
3715
|
-
* @param {BrokersApiGetPositionLotsApiV1BrokersDataPositionsLotsGetRequest} requestParameters Request parameters.
|
|
3716
|
-
* @param {*} [options] Override http request option.
|
|
3717
|
-
* @throws {RequiredError}
|
|
3718
|
-
*/
|
|
3719
|
-
getPositionLotsApiV1BrokersDataPositionsLotsGet(requestParameters?: BrokersApiGetPositionLotsApiV1BrokersDataPositionsLotsGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<FinaticResponseListFDXBrokerPositionLot>;
|
|
3720
|
-
/**
|
|
3721
|
-
* 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.
|
|
3722
|
-
* @summary Get Positions
|
|
3723
|
-
* @param {BrokersApiGetPositionsApiV1BrokersDataPositionsGetRequest} requestParameters Request parameters.
|
|
3724
|
-
* @param {*} [options] Override http request option.
|
|
3725
|
-
* @throws {RequiredError}
|
|
3726
|
-
*/
|
|
3727
|
-
getPositionsApiV1BrokersDataPositionsGet(requestParameters?: BrokersApiGetPositionsApiV1BrokersDataPositionsGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<FinaticResponseListFDXBrokerPosition>;
|
|
3728
|
-
/**
|
|
3729
|
-
* 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.
|
|
3730
|
-
* @summary List Broker Connections
|
|
3731
|
-
* @param {*} [options] Override http request option.
|
|
3732
|
-
* @throws {RequiredError}
|
|
3733
|
-
*/
|
|
3734
|
-
listBrokerConnectionsApiV1BrokersConnectionsGet(options?: RawAxiosRequestConfig): AxiosPromise<FinaticResponseListUserBrokerConnectionWithPermissions>;
|
|
3735
|
-
};
|
|
3736
3316
|
/**
|
|
3737
3317
|
* BrokersApi - interface
|
|
3738
3318
|
*/
|
|
@@ -4565,7 +4145,7 @@ interface FinaticResponse$2<T> {
|
|
|
4565
4145
|
[key: string]: any;
|
|
4566
4146
|
}> | null;
|
|
4567
4147
|
}
|
|
4568
|
-
interface DisconnectCompanyFromBrokerParams
|
|
4148
|
+
interface DisconnectCompanyFromBrokerParams {
|
|
4569
4149
|
/** Connection ID */
|
|
4570
4150
|
connectionId: string;
|
|
4571
4151
|
}
|
|
@@ -4826,7 +4406,7 @@ declare class BrokersWrapper {
|
|
|
4826
4406
|
* }
|
|
4827
4407
|
* ```
|
|
4828
4408
|
*/
|
|
4829
|
-
disconnectCompanyFromBroker(params: DisconnectCompanyFromBrokerParams
|
|
4409
|
+
disconnectCompanyFromBroker(params: DisconnectCompanyFromBrokerParams): Promise<FinaticResponse$2<DisconnectActionResult>>;
|
|
4830
4410
|
/**
|
|
4831
4411
|
* Get Orders
|
|
4832
4412
|
*
|
|
@@ -5296,69 +4876,6 @@ declare class BrokersWrapper {
|
|
|
5296
4876
|
getPositionLotFills(params: GetPositionLotFillsParams): Promise<FinaticResponse$2<PaginatedData<FDXBrokerPositionLotFill>>>;
|
|
5297
4877
|
}
|
|
5298
4878
|
|
|
5299
|
-
/**
|
|
5300
|
-
* CompanyApi - axios parameter creator
|
|
5301
|
-
*/
|
|
5302
|
-
declare const CompanyApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
5303
|
-
/**
|
|
5304
|
-
* Get public company details by ID (no user check, no sensitive data).
|
|
5305
|
-
* @summary Get Company
|
|
5306
|
-
* @param {string} companyId Company ID
|
|
5307
|
-
* @param {*} [options] Override http request option.
|
|
5308
|
-
* @throws {RequiredError}
|
|
5309
|
-
*/
|
|
5310
|
-
getCompanyApiV1CompanyCompanyIdGet: (companyId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5311
|
-
/**
|
|
5312
|
-
* Get public company details by ID (no user check, no sensitive data).
|
|
5313
|
-
* @summary Get Company
|
|
5314
|
-
* @param {string} companyId Company ID
|
|
5315
|
-
* @param {*} [options] Override http request option.
|
|
5316
|
-
* @throws {RequiredError}
|
|
5317
|
-
*/
|
|
5318
|
-
getCompanyApiV1CompanyCompanyIdGet_1: (companyId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5319
|
-
};
|
|
5320
|
-
/**
|
|
5321
|
-
* CompanyApi - functional programming interface
|
|
5322
|
-
*/
|
|
5323
|
-
declare const CompanyApiFp: (configuration?: Configuration) => {
|
|
5324
|
-
/**
|
|
5325
|
-
* Get public company details by ID (no user check, no sensitive data).
|
|
5326
|
-
* @summary Get Company
|
|
5327
|
-
* @param {string} companyId Company ID
|
|
5328
|
-
* @param {*} [options] Override http request option.
|
|
5329
|
-
* @throws {RequiredError}
|
|
5330
|
-
*/
|
|
5331
|
-
getCompanyApiV1CompanyCompanyIdGet(companyId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FinaticResponseCompanyResponse>>;
|
|
5332
|
-
/**
|
|
5333
|
-
* Get public company details by ID (no user check, no sensitive data).
|
|
5334
|
-
* @summary Get Company
|
|
5335
|
-
* @param {string} companyId Company ID
|
|
5336
|
-
* @param {*} [options] Override http request option.
|
|
5337
|
-
* @throws {RequiredError}
|
|
5338
|
-
*/
|
|
5339
|
-
getCompanyApiV1CompanyCompanyIdGet_1(companyId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FinaticResponseCompanyResponse>>;
|
|
5340
|
-
};
|
|
5341
|
-
/**
|
|
5342
|
-
* CompanyApi - factory interface
|
|
5343
|
-
*/
|
|
5344
|
-
declare const CompanyApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
5345
|
-
/**
|
|
5346
|
-
* Get public company details by ID (no user check, no sensitive data).
|
|
5347
|
-
* @summary Get Company
|
|
5348
|
-
* @param {CompanyApiGetCompanyApiV1CompanyCompanyIdGetRequest} requestParameters Request parameters.
|
|
5349
|
-
* @param {*} [options] Override http request option.
|
|
5350
|
-
* @throws {RequiredError}
|
|
5351
|
-
*/
|
|
5352
|
-
getCompanyApiV1CompanyCompanyIdGet(requestParameters: CompanyApiGetCompanyApiV1CompanyCompanyIdGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<FinaticResponseCompanyResponse>;
|
|
5353
|
-
/**
|
|
5354
|
-
* Get public company details by ID (no user check, no sensitive data).
|
|
5355
|
-
* @summary Get Company
|
|
5356
|
-
* @param {CompanyApiGetCompanyApiV1CompanyCompanyIdGet0Request} requestParameters Request parameters.
|
|
5357
|
-
* @param {*} [options] Override http request option.
|
|
5358
|
-
* @throws {RequiredError}
|
|
5359
|
-
*/
|
|
5360
|
-
getCompanyApiV1CompanyCompanyIdGet_1(requestParameters: CompanyApiGetCompanyApiV1CompanyCompanyIdGet0Request, options?: RawAxiosRequestConfig): AxiosPromise<FinaticResponseCompanyResponse>;
|
|
5361
|
-
};
|
|
5362
4879
|
/**
|
|
5363
4880
|
* CompanyApi - interface
|
|
5364
4881
|
*/
|
|
@@ -5450,7 +4967,7 @@ interface FinaticResponse$1<T> {
|
|
|
5450
4967
|
[key: string]: any;
|
|
5451
4968
|
}> | null;
|
|
5452
4969
|
}
|
|
5453
|
-
interface GetCompanyParams
|
|
4970
|
+
interface GetCompanyParams {
|
|
5454
4971
|
/** Company ID */
|
|
5455
4972
|
companyId: string;
|
|
5456
4973
|
}
|
|
@@ -5496,124 +5013,9 @@ declare class CompanyWrapper {
|
|
|
5496
5013
|
* }
|
|
5497
5014
|
* ```
|
|
5498
5015
|
*/
|
|
5499
|
-
getCompany(params: GetCompanyParams
|
|
5016
|
+
getCompany(params: GetCompanyParams): Promise<FinaticResponse$1<CompanyResponse>>;
|
|
5500
5017
|
}
|
|
5501
5018
|
|
|
5502
|
-
/**
|
|
5503
|
-
* SessionApi - axios parameter creator
|
|
5504
|
-
*/
|
|
5505
|
-
declare const SessionApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
5506
|
-
/**
|
|
5507
|
-
* 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.
|
|
5508
|
-
* @summary Get Portal Url
|
|
5509
|
-
* @param {string} sessionId Session ID
|
|
5510
|
-
* @param {*} [options] Override http request option.
|
|
5511
|
-
* @throws {RequiredError}
|
|
5512
|
-
*/
|
|
5513
|
-
getPortalUrlApiV1SessionPortalGet: (sessionId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5514
|
-
/**
|
|
5515
|
-
* 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
|
|
5516
|
-
* @summary Get Session User
|
|
5517
|
-
* @param {string} sessionId Session ID
|
|
5518
|
-
* @param {string} xSessionId Session ID from header (must match path parameter)
|
|
5519
|
-
* @param {*} [options] Override http request option.
|
|
5520
|
-
* @throws {RequiredError}
|
|
5521
|
-
*/
|
|
5522
|
-
getSessionUserApiV1SessionSessionIdUserGet: (sessionId: string, xSessionId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5523
|
-
/**
|
|
5524
|
-
* Initialize a new session with company API key.
|
|
5525
|
-
* @summary Init Session
|
|
5526
|
-
* @param {string} xApiKey Company API key
|
|
5527
|
-
* @param {*} [options] Override http request option.
|
|
5528
|
-
* @throws {RequiredError}
|
|
5529
|
-
*/
|
|
5530
|
-
initSessionApiV1SessionInitPost: (xApiKey: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5531
|
-
/**
|
|
5532
|
-
* Start a session with a one-time token.
|
|
5533
|
-
* @summary Start Session
|
|
5534
|
-
* @param {string} oneTimeToken One-time use token obtained from init_session endpoint to authenticate and start the session
|
|
5535
|
-
* @param {SessionStartRequest} sessionStartRequest Session start request containing optional user ID to associate with the session
|
|
5536
|
-
* @param {*} [options] Override http request option.
|
|
5537
|
-
* @throws {RequiredError}
|
|
5538
|
-
*/
|
|
5539
|
-
startSessionApiV1SessionStartPost: (oneTimeToken: string, sessionStartRequest: SessionStartRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5540
|
-
};
|
|
5541
|
-
/**
|
|
5542
|
-
* SessionApi - functional programming interface
|
|
5543
|
-
*/
|
|
5544
|
-
declare const SessionApiFp: (configuration?: Configuration) => {
|
|
5545
|
-
/**
|
|
5546
|
-
* 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.
|
|
5547
|
-
* @summary Get Portal Url
|
|
5548
|
-
* @param {string} sessionId Session ID
|
|
5549
|
-
* @param {*} [options] Override http request option.
|
|
5550
|
-
* @throws {RequiredError}
|
|
5551
|
-
*/
|
|
5552
|
-
getPortalUrlApiV1SessionPortalGet(sessionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FinaticResponsePortalUrlResponse>>;
|
|
5553
|
-
/**
|
|
5554
|
-
* 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
|
|
5555
|
-
* @summary Get Session User
|
|
5556
|
-
* @param {string} sessionId Session ID
|
|
5557
|
-
* @param {string} xSessionId Session ID from header (must match path parameter)
|
|
5558
|
-
* @param {*} [options] Override http request option.
|
|
5559
|
-
* @throws {RequiredError}
|
|
5560
|
-
*/
|
|
5561
|
-
getSessionUserApiV1SessionSessionIdUserGet(sessionId: string, xSessionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FinaticResponseSessionUserResponse>>;
|
|
5562
|
-
/**
|
|
5563
|
-
* Initialize a new session with company API key.
|
|
5564
|
-
* @summary Init Session
|
|
5565
|
-
* @param {string} xApiKey Company API key
|
|
5566
|
-
* @param {*} [options] Override http request option.
|
|
5567
|
-
* @throws {RequiredError}
|
|
5568
|
-
*/
|
|
5569
|
-
initSessionApiV1SessionInitPost(xApiKey: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FinaticResponseTokenResponseData>>;
|
|
5570
|
-
/**
|
|
5571
|
-
* Start a session with a one-time token.
|
|
5572
|
-
* @summary Start Session
|
|
5573
|
-
* @param {string} oneTimeToken One-time use token obtained from init_session endpoint to authenticate and start the session
|
|
5574
|
-
* @param {SessionStartRequest} sessionStartRequest Session start request containing optional user ID to associate with the session
|
|
5575
|
-
* @param {*} [options] Override http request option.
|
|
5576
|
-
* @throws {RequiredError}
|
|
5577
|
-
*/
|
|
5578
|
-
startSessionApiV1SessionStartPost(oneTimeToken: string, sessionStartRequest: SessionStartRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FinaticResponseSessionResponseData>>;
|
|
5579
|
-
};
|
|
5580
|
-
/**
|
|
5581
|
-
* SessionApi - factory interface
|
|
5582
|
-
*/
|
|
5583
|
-
declare const SessionApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
5584
|
-
/**
|
|
5585
|
-
* 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.
|
|
5586
|
-
* @summary Get Portal Url
|
|
5587
|
-
* @param {SessionApiGetPortalUrlApiV1SessionPortalGetRequest} requestParameters Request parameters.
|
|
5588
|
-
* @param {*} [options] Override http request option.
|
|
5589
|
-
* @throws {RequiredError}
|
|
5590
|
-
*/
|
|
5591
|
-
getPortalUrlApiV1SessionPortalGet(requestParameters: SessionApiGetPortalUrlApiV1SessionPortalGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<FinaticResponsePortalUrlResponse>;
|
|
5592
|
-
/**
|
|
5593
|
-
* 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
|
|
5594
|
-
* @summary Get Session User
|
|
5595
|
-
* @param {SessionApiGetSessionUserApiV1SessionSessionIdUserGetRequest} requestParameters Request parameters.
|
|
5596
|
-
* @param {*} [options] Override http request option.
|
|
5597
|
-
* @throws {RequiredError}
|
|
5598
|
-
*/
|
|
5599
|
-
getSessionUserApiV1SessionSessionIdUserGet(requestParameters: SessionApiGetSessionUserApiV1SessionSessionIdUserGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<FinaticResponseSessionUserResponse>;
|
|
5600
|
-
/**
|
|
5601
|
-
* Initialize a new session with company API key.
|
|
5602
|
-
* @summary Init Session
|
|
5603
|
-
* @param {SessionApiInitSessionApiV1SessionInitPostRequest} requestParameters Request parameters.
|
|
5604
|
-
* @param {*} [options] Override http request option.
|
|
5605
|
-
* @throws {RequiredError}
|
|
5606
|
-
*/
|
|
5607
|
-
initSessionApiV1SessionInitPost(requestParameters: SessionApiInitSessionApiV1SessionInitPostRequest, options?: RawAxiosRequestConfig): AxiosPromise<FinaticResponseTokenResponseData>;
|
|
5608
|
-
/**
|
|
5609
|
-
* Start a session with a one-time token.
|
|
5610
|
-
* @summary Start Session
|
|
5611
|
-
* @param {SessionApiStartSessionApiV1SessionStartPostRequest} requestParameters Request parameters.
|
|
5612
|
-
* @param {*} [options] Override http request option.
|
|
5613
|
-
* @throws {RequiredError}
|
|
5614
|
-
*/
|
|
5615
|
-
startSessionApiV1SessionStartPost(requestParameters: SessionApiStartSessionApiV1SessionStartPostRequest, options?: RawAxiosRequestConfig): AxiosPromise<FinaticResponseSessionResponseData>;
|
|
5616
|
-
};
|
|
5617
5019
|
/**
|
|
5618
5020
|
* SessionApi - interface
|
|
5619
5021
|
*/
|
|
@@ -5926,7 +5328,7 @@ interface RetryOptions {
|
|
|
5926
5328
|
retryMultiplier?: number;
|
|
5927
5329
|
retryOnStatus?: number[];
|
|
5928
5330
|
retryOnNetworkError?: boolean;
|
|
5929
|
-
onFailedAttempt?: (
|
|
5331
|
+
onFailedAttempt?: (context: RetryContext) => void | Promise<void>;
|
|
5930
5332
|
}
|
|
5931
5333
|
/**
|
|
5932
5334
|
* Retry an async function with exponential backoff using p-retry.
|
|
@@ -7851,5 +7253,5 @@ declare class FinaticConnect extends FinaticConnect$1 {
|
|
|
7851
7253
|
static readonly __CUSTOM_CLASS__ = true;
|
|
7852
7254
|
}
|
|
7853
7255
|
|
|
7854
|
-
export { AccountStatus, ApiError, BrokerDataAccountTypeEnum, BrokerDataAssetTypeEnum, BrokerDataOrderSideEnum, BrokerDataPositionStatusEnum,
|
|
7855
|
-
export type { Accounttype, ValidationError$1 as ApiValidationError, Assettype, Availablebalance, Availabletowithdraw, Averagebuyprice, Averagefillprice, Averagesellprice, Balancetype, BrokerInfo,
|
|
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 };
|