@finatic/client 0.9.2 → 0.9.4
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 +521 -214
- package/dist/index.js +973 -433
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +973 -434
- package/dist/index.mjs.map +1 -1
- package/package.json +23 -15
package/dist/index.d.ts
CHANGED
|
@@ -328,31 +328,6 @@ declare enum BrokerDataOrderSideEnum {
|
|
|
328
328
|
Sell = "sell"
|
|
329
329
|
}
|
|
330
330
|
|
|
331
|
-
/**
|
|
332
|
-
* Finatic FastAPI Backend
|
|
333
|
-
* FinaticAPI REST API
|
|
334
|
-
*
|
|
335
|
-
* The version of the OpenAPI document: 1.0.0
|
|
336
|
-
*
|
|
337
|
-
*
|
|
338
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
339
|
-
* https://openapi-generator.tech
|
|
340
|
-
* Do not edit the class manually.
|
|
341
|
-
*/
|
|
342
|
-
declare enum BrokerDataOrderStatusEnum {
|
|
343
|
-
Submitted = "submitted",
|
|
344
|
-
New = "new",
|
|
345
|
-
PartiallyFilled = "partially_filled",
|
|
346
|
-
Filled = "filled",
|
|
347
|
-
PendingCancel = "pending_cancel",
|
|
348
|
-
Cancelled = "cancelled",
|
|
349
|
-
Rejected = "rejected",
|
|
350
|
-
Expired = "expired",
|
|
351
|
-
Created = "created",
|
|
352
|
-
Received = "received",
|
|
353
|
-
Queued = "queued"
|
|
354
|
-
}
|
|
355
|
-
|
|
356
331
|
/**
|
|
357
332
|
* Finatic FastAPI Backend
|
|
358
333
|
* FinaticAPI REST API
|
|
@@ -799,7 +774,7 @@ interface Accountstatus {
|
|
|
799
774
|
* FDX-style broker account schema following FDX Account patterns. Extends FDX Account schema with broker-specific fields.
|
|
800
775
|
*/
|
|
801
776
|
interface FDXBrokerAccount {
|
|
802
|
-
'
|
|
777
|
+
'id'?: string | null;
|
|
803
778
|
/**
|
|
804
779
|
* Broker-provided account identifier
|
|
805
780
|
*/
|
|
@@ -818,7 +793,8 @@ interface FDXBrokerAccount {
|
|
|
818
793
|
'institutionId'?: string | null;
|
|
819
794
|
'currencyCode'?: string | null;
|
|
820
795
|
'accountStatus'?: Accountstatus | null;
|
|
821
|
-
'
|
|
796
|
+
'subAccountType'?: string | null;
|
|
797
|
+
'accountClassification'?: string | null;
|
|
822
798
|
/**
|
|
823
799
|
* User-broker connection UUID
|
|
824
800
|
*/
|
|
@@ -965,6 +941,8 @@ interface FDXBrokerBalance {
|
|
|
965
941
|
* Associated account identifier
|
|
966
942
|
*/
|
|
967
943
|
'accountId': string;
|
|
944
|
+
'internalAccountId'?: string | null;
|
|
945
|
+
'connectionId'?: string | null;
|
|
968
946
|
'balanceType': Balancetype;
|
|
969
947
|
'balanceName'?: string | null;
|
|
970
948
|
'availableBalance'?: Availablebalance | null;
|
|
@@ -1278,6 +1256,7 @@ interface FDXBrokerOrder {
|
|
|
1278
1256
|
* Broker account identifier
|
|
1279
1257
|
*/
|
|
1280
1258
|
'accountId': string;
|
|
1259
|
+
'internalAccountId'?: string | null;
|
|
1281
1260
|
'connectionId'?: string | null;
|
|
1282
1261
|
'orderType'?: Ordertype | null;
|
|
1283
1262
|
'orderClass'?: Orderclass | null;
|
|
@@ -1752,15 +1731,12 @@ interface Unrealizedprofitlosspercent {
|
|
|
1752
1731
|
* FDX-style broker position schema. Based on FDX Holdings, significantly extended for trading: - Short positions - Realized/unrealized P&L - Position lifecycle - Commission tracking
|
|
1753
1732
|
*/
|
|
1754
1733
|
interface FDXBrokerPosition {
|
|
1755
|
-
'
|
|
1756
|
-
/**
|
|
1757
|
-
* Position identifier
|
|
1758
|
-
*/
|
|
1759
|
-
'positionId': string;
|
|
1734
|
+
'id'?: string | null;
|
|
1760
1735
|
/**
|
|
1761
1736
|
* Broker account identifier
|
|
1762
1737
|
*/
|
|
1763
1738
|
'accountId': string;
|
|
1739
|
+
'internalAccountId'?: string | null;
|
|
1764
1740
|
/**
|
|
1765
1741
|
* User-broker connection identifier
|
|
1766
1742
|
*/
|
|
@@ -2000,6 +1976,8 @@ interface FDXBrokerPositionLot {
|
|
|
2000
1976
|
* Broker account identifier
|
|
2001
1977
|
*/
|
|
2002
1978
|
'accountId': string;
|
|
1979
|
+
'internalAccountId'?: string | null;
|
|
1980
|
+
'connectionId'?: string | null;
|
|
2003
1981
|
/**
|
|
2004
1982
|
* Security identifier
|
|
2005
1983
|
*/
|
|
@@ -3370,7 +3348,7 @@ declare const BrokersApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
|
3370
3348
|
* @summary Get Balances
|
|
3371
3349
|
* @param {string | null} [brokerId] Filter by broker ID
|
|
3372
3350
|
* @param {string | null} [connectionId] Filter by connection ID
|
|
3373
|
-
* @param {string | null} [accountId] Filter by broker provided account ID
|
|
3351
|
+
* @param {string | null} [accountId] Filter by broker provided account ID or internal account UUID
|
|
3374
3352
|
* @param {boolean | null} [isEndOfDaySnapshot] Filter by end-of-day snapshot status (true/false)
|
|
3375
3353
|
* @param {number} [limit] Maximum number of balances to return
|
|
3376
3354
|
* @param {number} [offset] Number of balances to skip for pagination
|
|
@@ -3431,9 +3409,9 @@ declare const BrokersApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
|
3431
3409
|
* @summary Get Orders
|
|
3432
3410
|
* @param {string | null} [brokerId] Filter by broker ID
|
|
3433
3411
|
* @param {string | null} [connectionId] Filter by connection ID
|
|
3434
|
-
* @param {string | null} [accountId] Filter by broker provided account ID
|
|
3412
|
+
* @param {string | null} [accountId] Filter by broker provided account ID or internal account UUID
|
|
3435
3413
|
* @param {string | null} [symbol] Filter by symbol
|
|
3436
|
-
* @param {
|
|
3414
|
+
* @param {string | null} [orderStatus] Filter by order status (e.g., \'filled\', \'pending_new\', \'cancelled\')
|
|
3437
3415
|
* @param {BrokerDataOrderSideEnum | null} [side] Filter by order side (e.g., \'buy\', \'sell\')
|
|
3438
3416
|
* @param {BrokerDataAssetTypeEnum | null} [assetType] Filter by asset type (e.g., \'stock\', \'option\', \'crypto\', \'future\')
|
|
3439
3417
|
* @param {number} [limit] Maximum number of orders to return
|
|
@@ -3444,7 +3422,7 @@ declare const BrokersApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
|
3444
3422
|
* @param {*} [options] Override http request option.
|
|
3445
3423
|
* @throws {RequiredError}
|
|
3446
3424
|
*/
|
|
3447
|
-
getOrdersApiV1BrokersDataOrdersGet: (brokerId?: string | null, connectionId?: string | null, accountId?: string | null, symbol?: string | null, orderStatus?:
|
|
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>;
|
|
3448
3426
|
/**
|
|
3449
3427
|
* Get position lot fills for a specific lot. This endpoint returns all fills associated with a specific position lot.
|
|
3450
3428
|
* @summary Get Position Lot Fills
|
|
@@ -3475,7 +3453,7 @@ declare const BrokersApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
|
3475
3453
|
* @summary Get Positions
|
|
3476
3454
|
* @param {string | null} [brokerId] Filter by broker ID
|
|
3477
3455
|
* @param {string | null} [connectionId] Filter by connection ID
|
|
3478
|
-
* @param {string | null} [accountId] Filter by broker provided account ID
|
|
3456
|
+
* @param {string | null} [accountId] Filter by broker provided account ID or internal account UUID
|
|
3479
3457
|
* @param {string | null} [symbol] Filter by symbol
|
|
3480
3458
|
* @param {BrokerDataOrderSideEnum | null} [side] Filter by position side (e.g., \'long\', \'short\')
|
|
3481
3459
|
* @param {BrokerDataAssetTypeEnum | null} [assetType] Filter by asset type (e.g., \'stock\', \'option\', \'crypto\', \'future\')
|
|
@@ -3529,7 +3507,7 @@ declare const BrokersApiFp: (configuration?: Configuration) => {
|
|
|
3529
3507
|
* @summary Get Balances
|
|
3530
3508
|
* @param {string | null} [brokerId] Filter by broker ID
|
|
3531
3509
|
* @param {string | null} [connectionId] Filter by connection ID
|
|
3532
|
-
* @param {string | null} [accountId] Filter by broker provided account ID
|
|
3510
|
+
* @param {string | null} [accountId] Filter by broker provided account ID or internal account UUID
|
|
3533
3511
|
* @param {boolean | null} [isEndOfDaySnapshot] Filter by end-of-day snapshot status (true/false)
|
|
3534
3512
|
* @param {number} [limit] Maximum number of balances to return
|
|
3535
3513
|
* @param {number} [offset] Number of balances to skip for pagination
|
|
@@ -3590,9 +3568,9 @@ declare const BrokersApiFp: (configuration?: Configuration) => {
|
|
|
3590
3568
|
* @summary Get Orders
|
|
3591
3569
|
* @param {string | null} [brokerId] Filter by broker ID
|
|
3592
3570
|
* @param {string | null} [connectionId] Filter by connection ID
|
|
3593
|
-
* @param {string | null} [accountId] Filter by broker provided account ID
|
|
3571
|
+
* @param {string | null} [accountId] Filter by broker provided account ID or internal account UUID
|
|
3594
3572
|
* @param {string | null} [symbol] Filter by symbol
|
|
3595
|
-
* @param {
|
|
3573
|
+
* @param {string | null} [orderStatus] Filter by order status (e.g., \'filled\', \'pending_new\', \'cancelled\')
|
|
3596
3574
|
* @param {BrokerDataOrderSideEnum | null} [side] Filter by order side (e.g., \'buy\', \'sell\')
|
|
3597
3575
|
* @param {BrokerDataAssetTypeEnum | null} [assetType] Filter by asset type (e.g., \'stock\', \'option\', \'crypto\', \'future\')
|
|
3598
3576
|
* @param {number} [limit] Maximum number of orders to return
|
|
@@ -3603,7 +3581,7 @@ declare const BrokersApiFp: (configuration?: Configuration) => {
|
|
|
3603
3581
|
* @param {*} [options] Override http request option.
|
|
3604
3582
|
* @throws {RequiredError}
|
|
3605
3583
|
*/
|
|
3606
|
-
getOrdersApiV1BrokersDataOrdersGet(brokerId?: string | null, connectionId?: string | null, accountId?: string | null, symbol?: string | null, orderStatus?:
|
|
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>>;
|
|
3607
3585
|
/**
|
|
3608
3586
|
* Get position lot fills for a specific lot. This endpoint returns all fills associated with a specific position lot.
|
|
3609
3587
|
* @summary Get Position Lot Fills
|
|
@@ -3634,7 +3612,7 @@ declare const BrokersApiFp: (configuration?: Configuration) => {
|
|
|
3634
3612
|
* @summary Get Positions
|
|
3635
3613
|
* @param {string | null} [brokerId] Filter by broker ID
|
|
3636
3614
|
* @param {string | null} [connectionId] Filter by connection ID
|
|
3637
|
-
* @param {string | null} [accountId] Filter by broker provided account ID
|
|
3615
|
+
* @param {string | null} [accountId] Filter by broker provided account ID or internal account UUID
|
|
3638
3616
|
* @param {string | null} [symbol] Filter by symbol
|
|
3639
3617
|
* @param {BrokerDataOrderSideEnum | null} [side] Filter by position side (e.g., \'long\', \'short\')
|
|
3640
3618
|
* @param {BrokerDataAssetTypeEnum | null} [assetType] Filter by asset type (e.g., \'stock\', \'option\', \'crypto\', \'future\')
|
|
@@ -3913,7 +3891,7 @@ interface BrokersApiGetBalancesApiV1BrokersDataBalancesGetRequest {
|
|
|
3913
3891
|
*/
|
|
3914
3892
|
readonly connectionId?: string | null;
|
|
3915
3893
|
/**
|
|
3916
|
-
* Filter by broker provided account ID
|
|
3894
|
+
* Filter by broker provided account ID or internal account UUID
|
|
3917
3895
|
*/
|
|
3918
3896
|
readonly accountId?: string | null;
|
|
3919
3897
|
/**
|
|
@@ -4037,7 +4015,7 @@ interface BrokersApiGetOrdersApiV1BrokersDataOrdersGetRequest {
|
|
|
4037
4015
|
*/
|
|
4038
4016
|
readonly connectionId?: string | null;
|
|
4039
4017
|
/**
|
|
4040
|
-
* Filter by broker provided account ID
|
|
4018
|
+
* Filter by broker provided account ID or internal account UUID
|
|
4041
4019
|
*/
|
|
4042
4020
|
readonly accountId?: string | null;
|
|
4043
4021
|
/**
|
|
@@ -4047,7 +4025,7 @@ interface BrokersApiGetOrdersApiV1BrokersDataOrdersGetRequest {
|
|
|
4047
4025
|
/**
|
|
4048
4026
|
* Filter by order status (e.g., \'filled\', \'pending_new\', \'cancelled\')
|
|
4049
4027
|
*/
|
|
4050
|
-
readonly orderStatus?:
|
|
4028
|
+
readonly orderStatus?: string | null;
|
|
4051
4029
|
/**
|
|
4052
4030
|
* Filter by order side (e.g., \'buy\', \'sell\')
|
|
4053
4031
|
*/
|
|
@@ -4144,7 +4122,7 @@ interface BrokersApiGetPositionsApiV1BrokersDataPositionsGetRequest {
|
|
|
4144
4122
|
*/
|
|
4145
4123
|
readonly connectionId?: string | null;
|
|
4146
4124
|
/**
|
|
4147
|
-
* Filter by broker provided account ID
|
|
4125
|
+
* Filter by broker provided account ID or internal account UUID
|
|
4148
4126
|
*/
|
|
4149
4127
|
readonly accountId?: string | null;
|
|
4150
4128
|
/**
|
|
@@ -4393,6 +4371,170 @@ interface Logger {
|
|
|
4393
4371
|
*/
|
|
4394
4372
|
declare function getLogger(config?: SdkConfig): Logger;
|
|
4395
4373
|
|
|
4374
|
+
/**
|
|
4375
|
+
* Pagination utilities for TypeScript SDK.
|
|
4376
|
+
*
|
|
4377
|
+
* Provides PaginatedData class for wrapping paginated responses with helper methods.
|
|
4378
|
+
*/
|
|
4379
|
+
/**
|
|
4380
|
+
* Standard FinaticResponse type for all API responses.
|
|
4381
|
+
*
|
|
4382
|
+
* This matches the FinaticResponse interface defined in wrapper files.
|
|
4383
|
+
*/
|
|
4384
|
+
interface FinaticResponse$3<T> {
|
|
4385
|
+
'_id'?: string;
|
|
4386
|
+
/**
|
|
4387
|
+
* Success payload containing data and optional meta
|
|
4388
|
+
*/
|
|
4389
|
+
'success': {
|
|
4390
|
+
'data': T;
|
|
4391
|
+
'meta'?: {
|
|
4392
|
+
[key: string]: any;
|
|
4393
|
+
} | null;
|
|
4394
|
+
};
|
|
4395
|
+
'error'?: {
|
|
4396
|
+
[key: string]: any;
|
|
4397
|
+
} | null;
|
|
4398
|
+
'warning'?: Array<{
|
|
4399
|
+
[key: string]: any;
|
|
4400
|
+
}> | null;
|
|
4401
|
+
}
|
|
4402
|
+
interface PaginationMeta {
|
|
4403
|
+
has_more: boolean;
|
|
4404
|
+
next_offset: number | null;
|
|
4405
|
+
current_offset: number;
|
|
4406
|
+
limit: number;
|
|
4407
|
+
}
|
|
4408
|
+
/**
|
|
4409
|
+
* PaginatedData wraps a data array with pagination metadata and helper methods.
|
|
4410
|
+
*
|
|
4411
|
+
* This class behaves like an array, so you can use it directly:
|
|
4412
|
+
* - paginatedData.length returns the number of items
|
|
4413
|
+
* - paginatedData[0] returns the first item
|
|
4414
|
+
* - paginatedData.forEach(...) works directly
|
|
4415
|
+
* - paginatedData.map(...) works directly
|
|
4416
|
+
*
|
|
4417
|
+
* It also provides pagination methods:
|
|
4418
|
+
* - hasMore: Check if there are more pages
|
|
4419
|
+
* - nextPage(): Get the next page
|
|
4420
|
+
* - prevPage(): Get the previous page
|
|
4421
|
+
* - firstPage(): Get the first page
|
|
4422
|
+
* - lastPage(): Get the last page
|
|
4423
|
+
*
|
|
4424
|
+
* @template T - The element type (e.g., FDXBrokerAccount)
|
|
4425
|
+
*
|
|
4426
|
+
* Usage:
|
|
4427
|
+
* ```typescript
|
|
4428
|
+
* const response = await sdk.getAccounts();
|
|
4429
|
+
* const accounts = response.success.data; // Can use directly as array!
|
|
4430
|
+
* console.log(accounts.length); // Works directly
|
|
4431
|
+
* console.log(accounts[0]); // Works directly
|
|
4432
|
+
* accounts.forEach(account => console.log(account)); // Works directly
|
|
4433
|
+
*
|
|
4434
|
+
* if (accounts.hasMore) {
|
|
4435
|
+
* const nextPage = await accounts.nextPage(); // Returns PaginatedData<FDXBrokerAccount>
|
|
4436
|
+
* const nextAccounts = nextPage; // Can use directly as array too!
|
|
4437
|
+
* }
|
|
4438
|
+
* ```
|
|
4439
|
+
*/
|
|
4440
|
+
declare class PaginatedData<T> {
|
|
4441
|
+
items: T[];
|
|
4442
|
+
private meta;
|
|
4443
|
+
private originalMethod;
|
|
4444
|
+
private currentParams;
|
|
4445
|
+
private wrapperInstance;
|
|
4446
|
+
constructor(items: T[], // The actual data array
|
|
4447
|
+
meta: PaginationMeta, originalMethod: (params?: any) => Promise<any>, currentParams: any, wrapperInstance: any);
|
|
4448
|
+
/**
|
|
4449
|
+
* Get the number of items (allows paginatedData.length).
|
|
4450
|
+
*/
|
|
4451
|
+
get length(): number;
|
|
4452
|
+
/**
|
|
4453
|
+
* Check if there are more pages available.
|
|
4454
|
+
*/
|
|
4455
|
+
get hasMore(): boolean;
|
|
4456
|
+
/**
|
|
4457
|
+
* Calls a function for each element in the array.
|
|
4458
|
+
*/
|
|
4459
|
+
forEach(callbackfn: (value: T, index: number, array: T[]) => void, thisArg?: any): void;
|
|
4460
|
+
/**
|
|
4461
|
+
* Creates a new array with the results of calling a function for every array element.
|
|
4462
|
+
*/
|
|
4463
|
+
map<U>(callbackfn: (value: T, index: number, array: T[]) => U, thisArg?: any): U[];
|
|
4464
|
+
/**
|
|
4465
|
+
* Returns the elements of an array that meet the condition specified in a callback function.
|
|
4466
|
+
*/
|
|
4467
|
+
filter(callbackfn: (value: T, index: number, array: T[]) => boolean, thisArg?: any): T[];
|
|
4468
|
+
/**
|
|
4469
|
+
* Returns the value of the first element in the array where predicate is true.
|
|
4470
|
+
*/
|
|
4471
|
+
find(predicate: (value: T, index: number, obj: T[]) => boolean, thisArg?: any): T | undefined;
|
|
4472
|
+
/**
|
|
4473
|
+
* Returns the index of the first element in the array where predicate is true.
|
|
4474
|
+
*/
|
|
4475
|
+
findIndex(predicate: (value: T, index: number, obj: T[]) => boolean, thisArg?: any): number;
|
|
4476
|
+
/**
|
|
4477
|
+
* Returns a section of an array.
|
|
4478
|
+
*/
|
|
4479
|
+
slice(start?: number, end?: number): T[];
|
|
4480
|
+
/**
|
|
4481
|
+
* Determines whether an array includes a certain element.
|
|
4482
|
+
*/
|
|
4483
|
+
includes(searchElement: T, fromIndex?: number): boolean;
|
|
4484
|
+
/**
|
|
4485
|
+
* Returns the index of the first occurrence of a value in an array.
|
|
4486
|
+
*/
|
|
4487
|
+
indexOf(searchElement: T, fromIndex?: number): number;
|
|
4488
|
+
/**
|
|
4489
|
+
* Returns a string representation of an array.
|
|
4490
|
+
*/
|
|
4491
|
+
toString(): string;
|
|
4492
|
+
/**
|
|
4493
|
+
* Returns a string representation of an array.
|
|
4494
|
+
*/
|
|
4495
|
+
toLocaleString(): string;
|
|
4496
|
+
/**
|
|
4497
|
+
* Convert to JSON - returns just the items array for serialization.
|
|
4498
|
+
* This allows clean serialization without exposing internal methods.
|
|
4499
|
+
*
|
|
4500
|
+
* @returns The items array
|
|
4501
|
+
*
|
|
4502
|
+
* @example
|
|
4503
|
+
* ```typescript
|
|
4504
|
+
* const orders = await sdk.getOrders();
|
|
4505
|
+
* console.log(orders); // Shows full PaginatedData with methods
|
|
4506
|
+
* console.log(orders.toJSON()); // Shows just the items array
|
|
4507
|
+
* JSON.stringify(orders); // Automatically uses toJSON()
|
|
4508
|
+
* ```
|
|
4509
|
+
*/
|
|
4510
|
+
toJSON(): T[];
|
|
4511
|
+
/**
|
|
4512
|
+
* Get the next page of data.
|
|
4513
|
+
* @returns Promise<PaginatedData<T>> - The next page (not wrapped in FinaticResponse)
|
|
4514
|
+
* @throws Error if no more pages are available
|
|
4515
|
+
*/
|
|
4516
|
+
nextPage(): Promise<PaginatedData<T>>;
|
|
4517
|
+
/**
|
|
4518
|
+
* Get the previous page of data.
|
|
4519
|
+
* @returns Promise<PaginatedData<T>> - The previous page (not wrapped in FinaticResponse)
|
|
4520
|
+
* @throws Error if fetch fails
|
|
4521
|
+
*/
|
|
4522
|
+
prevPage(): Promise<PaginatedData<T>>;
|
|
4523
|
+
/**
|
|
4524
|
+
* Get the first page of data.
|
|
4525
|
+
* @returns Promise<PaginatedData<T>> - The first page (not wrapped in FinaticResponse)
|
|
4526
|
+
* @throws Error if fetch fails
|
|
4527
|
+
*/
|
|
4528
|
+
firstPage(): Promise<PaginatedData<T>>;
|
|
4529
|
+
/**
|
|
4530
|
+
* Get the last page of data.
|
|
4531
|
+
* Uses iterative approach to find the last page.
|
|
4532
|
+
* @returns Promise<PaginatedData<T>> - The last page (not wrapped in FinaticResponse)
|
|
4533
|
+
* @throws Error if fetch fails
|
|
4534
|
+
*/
|
|
4535
|
+
lastPage(): Promise<PaginatedData<T>>;
|
|
4536
|
+
}
|
|
4537
|
+
|
|
4396
4538
|
/**
|
|
4397
4539
|
* Generated wrapper functions for brokers operations (Phase 2A).
|
|
4398
4540
|
*
|
|
@@ -4423,91 +4565,164 @@ interface FinaticResponse$2<T> {
|
|
|
4423
4565
|
[key: string]: any;
|
|
4424
4566
|
}> | null;
|
|
4425
4567
|
}
|
|
4568
|
+
interface DisconnectCompanyFromBrokerParams$1 {
|
|
4569
|
+
/** Connection ID */
|
|
4570
|
+
connectionId: string;
|
|
4571
|
+
}
|
|
4426
4572
|
interface GetOrdersParams {
|
|
4573
|
+
/** Filter by broker ID */
|
|
4427
4574
|
brokerId?: string;
|
|
4575
|
+
/** Filter by connection ID */
|
|
4428
4576
|
connectionId?: string;
|
|
4577
|
+
/** Filter by broker provided account ID or internal account UUID */
|
|
4429
4578
|
accountId?: string;
|
|
4579
|
+
/** Filter by symbol */
|
|
4430
4580
|
symbol?: string;
|
|
4431
|
-
|
|
4581
|
+
/** Filter by order status (e.g., 'filled', 'pending_new', 'cancelled') */
|
|
4582
|
+
orderStatus?: string;
|
|
4583
|
+
/** Filter by order side (e.g., 'buy', 'sell') */
|
|
4432
4584
|
side?: BrokerDataOrderSideEnum;
|
|
4585
|
+
/** Filter by asset type (e.g., 'stock', 'option', 'crypto', 'future') */
|
|
4433
4586
|
assetType?: BrokerDataAssetTypeEnum;
|
|
4587
|
+
/** Maximum number of orders to return */
|
|
4434
4588
|
limit?: number;
|
|
4589
|
+
/** Number of orders to skip for pagination */
|
|
4435
4590
|
offset?: number;
|
|
4591
|
+
/** Filter orders created after this timestamp */
|
|
4436
4592
|
createdAfter?: string;
|
|
4593
|
+
/** Filter orders created before this timestamp */
|
|
4437
4594
|
createdBefore?: string;
|
|
4595
|
+
/** Include order metadata in response (excluded by default for FDX compliance) */
|
|
4438
4596
|
includeMetadata?: boolean;
|
|
4439
4597
|
}
|
|
4440
4598
|
interface GetPositionsParams {
|
|
4599
|
+
/** Filter by broker ID */
|
|
4441
4600
|
brokerId?: string;
|
|
4601
|
+
/** Filter by connection ID */
|
|
4442
4602
|
connectionId?: string;
|
|
4603
|
+
/** Filter by broker provided account ID or internal account UUID */
|
|
4443
4604
|
accountId?: string;
|
|
4605
|
+
/** Filter by symbol */
|
|
4444
4606
|
symbol?: string;
|
|
4607
|
+
/** Filter by position side (e.g., 'long', 'short') */
|
|
4445
4608
|
side?: BrokerDataOrderSideEnum;
|
|
4609
|
+
/** Filter by asset type (e.g., 'stock', 'option', 'crypto', 'future') */
|
|
4446
4610
|
assetType?: BrokerDataAssetTypeEnum;
|
|
4611
|
+
/** Filter by position status: 'open' (quantity > 0) or 'closed' (quantity = 0) */
|
|
4447
4612
|
positionStatus?: BrokerDataPositionStatusEnum;
|
|
4613
|
+
/** Maximum number of positions to return */
|
|
4448
4614
|
limit?: number;
|
|
4615
|
+
/** Number of positions to skip for pagination */
|
|
4449
4616
|
offset?: number;
|
|
4617
|
+
/** Filter positions updated after this timestamp */
|
|
4450
4618
|
updatedAfter?: string;
|
|
4619
|
+
/** Filter positions updated before this timestamp */
|
|
4451
4620
|
updatedBefore?: string;
|
|
4621
|
+
/** Include position metadata in response (excluded by default for FDX compliance) */
|
|
4452
4622
|
includeMetadata?: boolean;
|
|
4453
4623
|
}
|
|
4454
4624
|
interface GetBalancesParams {
|
|
4625
|
+
/** Filter by broker ID */
|
|
4455
4626
|
brokerId?: string;
|
|
4627
|
+
/** Filter by connection ID */
|
|
4456
4628
|
connectionId?: string;
|
|
4629
|
+
/** Filter by broker provided account ID or internal account UUID */
|
|
4457
4630
|
accountId?: string;
|
|
4631
|
+
/** Filter by end-of-day snapshot status (true/false) */
|
|
4458
4632
|
isEndOfDaySnapshot?: boolean;
|
|
4633
|
+
/** Maximum number of balances to return */
|
|
4459
4634
|
limit?: number;
|
|
4635
|
+
/** Number of balances to skip for pagination */
|
|
4460
4636
|
offset?: number;
|
|
4637
|
+
/** Filter balances created after this timestamp */
|
|
4461
4638
|
balanceCreatedAfter?: string;
|
|
4639
|
+
/** Filter balances created before this timestamp */
|
|
4462
4640
|
balanceCreatedBefore?: string;
|
|
4641
|
+
/** Include balance metadata in response (excluded by default for FDX compliance) */
|
|
4463
4642
|
includeMetadata?: boolean;
|
|
4464
4643
|
}
|
|
4465
4644
|
interface GetAccountsParams {
|
|
4645
|
+
/** Filter by broker ID */
|
|
4466
4646
|
brokerId?: string;
|
|
4647
|
+
/** Filter by connection ID */
|
|
4467
4648
|
connectionId?: string;
|
|
4649
|
+
/** Filter by account type (e.g., 'margin', 'cash', 'crypto_wallet', 'live', 'sim') */
|
|
4468
4650
|
accountType?: BrokerDataAccountTypeEnum;
|
|
4651
|
+
/** Filter by account status (e.g., 'active', 'inactive') */
|
|
4469
4652
|
status?: AccountStatus;
|
|
4653
|
+
/** Filter by currency (e.g., 'USD', 'EUR') */
|
|
4470
4654
|
currency?: string;
|
|
4655
|
+
/** Maximum number of accounts to return */
|
|
4471
4656
|
limit?: number;
|
|
4657
|
+
/** Number of accounts to skip for pagination */
|
|
4472
4658
|
offset?: number;
|
|
4659
|
+
/** Include connection metadata in response (excluded by default for FDX compliance) */
|
|
4473
4660
|
includeMetadata?: boolean;
|
|
4474
4661
|
}
|
|
4475
4662
|
interface GetOrderFillsParams {
|
|
4663
|
+
/** Order ID */
|
|
4476
4664
|
orderId: string;
|
|
4665
|
+
/** Filter by connection ID */
|
|
4477
4666
|
connectionId?: string;
|
|
4667
|
+
/** Maximum number of fills to return */
|
|
4478
4668
|
limit?: number;
|
|
4669
|
+
/** Number of fills to skip for pagination */
|
|
4479
4670
|
offset?: number;
|
|
4671
|
+
/** Include fill metadata in response (excluded by default for FDX compliance) */
|
|
4480
4672
|
includeMetadata?: boolean;
|
|
4481
4673
|
}
|
|
4482
4674
|
interface GetOrderEventsParams {
|
|
4675
|
+
/** Order ID */
|
|
4483
4676
|
orderId: string;
|
|
4677
|
+
/** Filter by connection ID */
|
|
4484
4678
|
connectionId?: string;
|
|
4679
|
+
/** Maximum number of events to return */
|
|
4485
4680
|
limit?: number;
|
|
4681
|
+
/** Number of events to skip for pagination */
|
|
4486
4682
|
offset?: number;
|
|
4683
|
+
/** Include event metadata in response (excluded by default for FDX compliance) */
|
|
4487
4684
|
includeMetadata?: boolean;
|
|
4488
4685
|
}
|
|
4489
4686
|
interface GetOrderGroupsParams {
|
|
4687
|
+
/** Filter by broker ID */
|
|
4490
4688
|
brokerId?: string;
|
|
4689
|
+
/** Filter by connection ID */
|
|
4491
4690
|
connectionId?: string;
|
|
4691
|
+
/** Maximum number of order groups to return */
|
|
4492
4692
|
limit?: number;
|
|
4693
|
+
/** Number of order groups to skip for pagination */
|
|
4493
4694
|
offset?: number;
|
|
4695
|
+
/** Filter order groups created after this timestamp */
|
|
4494
4696
|
createdAfter?: string;
|
|
4697
|
+
/** Filter order groups created before this timestamp */
|
|
4495
4698
|
createdBefore?: string;
|
|
4699
|
+
/** Include group metadata in response (excluded by default for FDX compliance) */
|
|
4496
4700
|
includeMetadata?: boolean;
|
|
4497
4701
|
}
|
|
4498
4702
|
interface GetPositionLotsParams {
|
|
4703
|
+
/** Filter by broker ID */
|
|
4499
4704
|
brokerId?: string;
|
|
4705
|
+
/** Filter by connection ID */
|
|
4500
4706
|
connectionId?: string;
|
|
4707
|
+
/** Filter by broker provided account ID */
|
|
4501
4708
|
accountId?: string;
|
|
4709
|
+
/** Filter by symbol */
|
|
4502
4710
|
symbol?: string;
|
|
4711
|
+
/** Filter by position ID */
|
|
4503
4712
|
positionId?: string;
|
|
4713
|
+
/** Maximum number of position lots to return */
|
|
4504
4714
|
limit?: number;
|
|
4715
|
+
/** Number of position lots to skip for pagination */
|
|
4505
4716
|
offset?: number;
|
|
4506
4717
|
}
|
|
4507
4718
|
interface GetPositionLotFillsParams {
|
|
4719
|
+
/** Position lot ID */
|
|
4508
4720
|
lotId: string;
|
|
4721
|
+
/** Filter by connection ID */
|
|
4509
4722
|
connectionId?: string;
|
|
4723
|
+
/** Maximum number of fills to return */
|
|
4510
4724
|
limit?: number;
|
|
4725
|
+
/** Number of fills to skip for pagination */
|
|
4511
4726
|
offset?: number;
|
|
4512
4727
|
}
|
|
4513
4728
|
/**
|
|
@@ -4539,7 +4754,7 @@ declare class BrokersWrapper {
|
|
|
4539
4754
|
* -------
|
|
4540
4755
|
* FinaticResponse[list[BrokerInfo]]
|
|
4541
4756
|
* list of available brokers with their metadata.
|
|
4542
|
-
* @param No parameters required for this method
|
|
4757
|
+
* @param params No parameters required for this method
|
|
4543
4758
|
* @returns {Promise<FinaticResponse<BrokerInfo[]>>} Standard response with success/Error/Warning structure
|
|
4544
4759
|
*
|
|
4545
4760
|
* Generated from: GET /api/v1/brokers/
|
|
@@ -4548,7 +4763,7 @@ declare class BrokersWrapper {
|
|
|
4548
4763
|
* @example
|
|
4549
4764
|
* ```typescript-client
|
|
4550
4765
|
* // Example with no parameters
|
|
4551
|
-
* const result = await finatic.getBrokers();
|
|
4766
|
+
* const result = await finatic.getBrokers({});
|
|
4552
4767
|
*
|
|
4553
4768
|
* // Access the response data
|
|
4554
4769
|
* if (result.success) {
|
|
@@ -4556,7 +4771,7 @@ declare class BrokersWrapper {
|
|
|
4556
4771
|
* }
|
|
4557
4772
|
* ```
|
|
4558
4773
|
*/
|
|
4559
|
-
getBrokers(): Promise<FinaticResponse$2<BrokerInfo[]>>;
|
|
4774
|
+
getBrokers(params?: {}): Promise<FinaticResponse$2<BrokerInfo[]>>;
|
|
4560
4775
|
/**
|
|
4561
4776
|
* List Broker Connections
|
|
4562
4777
|
*
|
|
@@ -4565,7 +4780,7 @@ declare class BrokersWrapper {
|
|
|
4565
4780
|
* This endpoint is accessible from the portal and uses session-only authentication.
|
|
4566
4781
|
* Returns connections that the user has any permissions for, including the current
|
|
4567
4782
|
* company's permissions (read/write) for each connection.
|
|
4568
|
-
* @param No parameters required for this method
|
|
4783
|
+
* @param params No parameters required for this method
|
|
4569
4784
|
* @returns {Promise<FinaticResponse<UserBrokerConnectionWithPermissions[]>>} Standard response with success/Error/Warning structure
|
|
4570
4785
|
*
|
|
4571
4786
|
* Generated from: GET /api/v1/brokers/connections
|
|
@@ -4574,7 +4789,7 @@ declare class BrokersWrapper {
|
|
|
4574
4789
|
* @example
|
|
4575
4790
|
* ```typescript-client
|
|
4576
4791
|
* // Example with no parameters
|
|
4577
|
-
* const result = await finatic.getBrokerConnections();
|
|
4792
|
+
* const result = await finatic.getBrokerConnections({});
|
|
4578
4793
|
*
|
|
4579
4794
|
* // Access the response data
|
|
4580
4795
|
* if (result.success) {
|
|
@@ -4582,7 +4797,7 @@ declare class BrokersWrapper {
|
|
|
4582
4797
|
* }
|
|
4583
4798
|
* ```
|
|
4584
4799
|
*/
|
|
4585
|
-
getBrokerConnections(): Promise<FinaticResponse$2<UserBrokerConnectionWithPermissions[]>>;
|
|
4800
|
+
getBrokerConnections(params?: {}): Promise<FinaticResponse$2<UserBrokerConnectionWithPermissions[]>>;
|
|
4586
4801
|
/**
|
|
4587
4802
|
* Disconnect Company From Broker
|
|
4588
4803
|
*
|
|
@@ -4590,7 +4805,7 @@ declare class BrokersWrapper {
|
|
|
4590
4805
|
*
|
|
4591
4806
|
* If the company is the only one with access, the entire connection is deleted.
|
|
4592
4807
|
* If other companies have access, only the company's access is removed.
|
|
4593
|
-
* @param connectionId {string}
|
|
4808
|
+
* @param params.connectionId {string} Connection ID
|
|
4594
4809
|
* @returns {Promise<FinaticResponse<DisconnectActionResult>>} Standard response with success/Error/Warning structure
|
|
4595
4810
|
*
|
|
4596
4811
|
* Generated from: DELETE /api/v1/brokers/disconnect-company/{connection_id}
|
|
@@ -4599,7 +4814,9 @@ declare class BrokersWrapper {
|
|
|
4599
4814
|
* @example
|
|
4600
4815
|
* ```typescript-client
|
|
4601
4816
|
* // Minimal example with required parameters only
|
|
4602
|
-
* const result = await finatic.disconnectCompanyFromBroker(
|
|
4817
|
+
* const result = await finatic.disconnectCompanyFromBroker({
|
|
4818
|
+
connectionId: '00000000-0000-0000-0000-000000000000'
|
|
4819
|
+
* });
|
|
4603
4820
|
*
|
|
4604
4821
|
* // Access the response data
|
|
4605
4822
|
* if (result.success) {
|
|
@@ -4609,7 +4826,7 @@ declare class BrokersWrapper {
|
|
|
4609
4826
|
* }
|
|
4610
4827
|
* ```
|
|
4611
4828
|
*/
|
|
4612
|
-
disconnectCompanyFromBroker(
|
|
4829
|
+
disconnectCompanyFromBroker(params: DisconnectCompanyFromBrokerParams$1): Promise<FinaticResponse$2<DisconnectActionResult>>;
|
|
4613
4830
|
/**
|
|
4614
4831
|
* Get Orders
|
|
4615
4832
|
*
|
|
@@ -4617,19 +4834,19 @@ declare class BrokersWrapper {
|
|
|
4617
4834
|
*
|
|
4618
4835
|
* This endpoint is accessible from the portal and uses session-only authentication.
|
|
4619
4836
|
* Returns orders from connections the company has read access to.
|
|
4620
|
-
* @param brokerId {string} (optional)
|
|
4621
|
-
* @param connectionId {string} (optional)
|
|
4622
|
-
* @param accountId {string} (optional)
|
|
4623
|
-
* @param symbol {string} (optional)
|
|
4624
|
-
* @param orderStatus {
|
|
4625
|
-
* @param side {BrokerDataOrderSideEnum} (optional)
|
|
4626
|
-
* @param assetType {BrokerDataAssetTypeEnum} (optional)
|
|
4627
|
-
* @param limit {number} (optional)
|
|
4628
|
-
* @param offset {number} (optional)
|
|
4629
|
-
* @param createdAfter {string} (optional)
|
|
4630
|
-
* @param createdBefore {string} (optional)
|
|
4631
|
-
* @param includeMetadata {boolean} (optional)
|
|
4632
|
-
* @returns {Promise<FinaticResponse<FDXBrokerOrder
|
|
4837
|
+
* @param params.brokerId {string} (optional) Filter by broker ID
|
|
4838
|
+
* @param params.connectionId {string} (optional) Filter by connection ID
|
|
4839
|
+
* @param params.accountId {string} (optional) Filter by broker provided account ID or internal account UUID
|
|
4840
|
+
* @param params.symbol {string} (optional) Filter by symbol
|
|
4841
|
+
* @param params.orderStatus {string} (optional) Filter by order status (e.g., 'filled', 'pending_new', 'cancelled')
|
|
4842
|
+
* @param params.side {BrokerDataOrderSideEnum} (optional) Filter by order side (e.g., 'buy', 'sell')
|
|
4843
|
+
* @param params.assetType {BrokerDataAssetTypeEnum} (optional) Filter by asset type (e.g., 'stock', 'option', 'crypto', 'future')
|
|
4844
|
+
* @param params.limit {number} (optional) Maximum number of orders to return
|
|
4845
|
+
* @param params.offset {number} (optional) Number of orders to skip for pagination
|
|
4846
|
+
* @param params.createdAfter {string} (optional) Filter orders created after this timestamp
|
|
4847
|
+
* @param params.createdBefore {string} (optional) Filter orders created before this timestamp
|
|
4848
|
+
* @param params.includeMetadata {boolean} (optional) Include order metadata in response (excluded by default for FDX compliance)
|
|
4849
|
+
* @returns {Promise<FinaticResponse<PaginatedData<FDXBrokerOrder>>>} Standard response with success/Error/Warning structure
|
|
4633
4850
|
*
|
|
4634
4851
|
* Generated from: GET /api/v1/brokers/data/orders
|
|
4635
4852
|
* @methodId get_orders_api_v1_brokers_data_orders_get
|
|
@@ -4637,7 +4854,7 @@ declare class BrokersWrapper {
|
|
|
4637
4854
|
* @example
|
|
4638
4855
|
* ```typescript-client
|
|
4639
4856
|
* // Example with no parameters
|
|
4640
|
-
* const result = await finatic.getOrders();
|
|
4857
|
+
* const result = await finatic.getOrders({});
|
|
4641
4858
|
*
|
|
4642
4859
|
* // Access the response data
|
|
4643
4860
|
* if (result.success) {
|
|
@@ -4647,7 +4864,11 @@ declare class BrokersWrapper {
|
|
|
4647
4864
|
* @example
|
|
4648
4865
|
* ```typescript-client
|
|
4649
4866
|
* // Full example with optional parameters
|
|
4650
|
-
* const result = await finatic.getOrders(
|
|
4867
|
+
* const result = await finatic.getOrders({
|
|
4868
|
+
brokerId: 'alpaca',
|
|
4869
|
+
connectionId: '00000000-0000-0000-0000-000000000000',
|
|
4870
|
+
accountId: '123456789'
|
|
4871
|
+
* });
|
|
4651
4872
|
*
|
|
4652
4873
|
* // Handle response with warnings
|
|
4653
4874
|
* if (result.success) {
|
|
@@ -4660,7 +4881,7 @@ declare class BrokersWrapper {
|
|
|
4660
4881
|
* }
|
|
4661
4882
|
* ```
|
|
4662
4883
|
*/
|
|
4663
|
-
getOrders(
|
|
4884
|
+
getOrders(params?: GetOrdersParams): Promise<FinaticResponse$2<PaginatedData<FDXBrokerOrder>>>;
|
|
4664
4885
|
/**
|
|
4665
4886
|
* Get Positions
|
|
4666
4887
|
*
|
|
@@ -4668,19 +4889,19 @@ declare class BrokersWrapper {
|
|
|
4668
4889
|
*
|
|
4669
4890
|
* This endpoint is accessible from the portal and uses session-only authentication.
|
|
4670
4891
|
* Returns positions from connections the company has read access to.
|
|
4671
|
-
* @param brokerId {string} (optional)
|
|
4672
|
-
* @param connectionId {string} (optional)
|
|
4673
|
-
* @param accountId {string} (optional)
|
|
4674
|
-
* @param symbol {string} (optional)
|
|
4675
|
-
* @param side {BrokerDataOrderSideEnum} (optional)
|
|
4676
|
-
* @param assetType {BrokerDataAssetTypeEnum} (optional)
|
|
4677
|
-
* @param positionStatus {BrokerDataPositionStatusEnum} (optional)
|
|
4678
|
-
* @param limit {number} (optional)
|
|
4679
|
-
* @param offset {number} (optional)
|
|
4680
|
-
* @param updatedAfter {string} (optional)
|
|
4681
|
-
* @param updatedBefore {string} (optional)
|
|
4682
|
-
* @param includeMetadata {boolean} (optional)
|
|
4683
|
-
* @returns {Promise<FinaticResponse<FDXBrokerPosition
|
|
4892
|
+
* @param params.brokerId {string} (optional) Filter by broker ID
|
|
4893
|
+
* @param params.connectionId {string} (optional) Filter by connection ID
|
|
4894
|
+
* @param params.accountId {string} (optional) Filter by broker provided account ID or internal account UUID
|
|
4895
|
+
* @param params.symbol {string} (optional) Filter by symbol
|
|
4896
|
+
* @param params.side {BrokerDataOrderSideEnum} (optional) Filter by position side (e.g., 'long', 'short')
|
|
4897
|
+
* @param params.assetType {BrokerDataAssetTypeEnum} (optional) Filter by asset type (e.g., 'stock', 'option', 'crypto', 'future')
|
|
4898
|
+
* @param params.positionStatus {BrokerDataPositionStatusEnum} (optional) Filter by position status: 'open' (quantity > 0) or 'closed' (quantity = 0)
|
|
4899
|
+
* @param params.limit {number} (optional) Maximum number of positions to return
|
|
4900
|
+
* @param params.offset {number} (optional) Number of positions to skip for pagination
|
|
4901
|
+
* @param params.updatedAfter {string} (optional) Filter positions updated after this timestamp
|
|
4902
|
+
* @param params.updatedBefore {string} (optional) Filter positions updated before this timestamp
|
|
4903
|
+
* @param params.includeMetadata {boolean} (optional) Include position metadata in response (excluded by default for FDX compliance)
|
|
4904
|
+
* @returns {Promise<FinaticResponse<PaginatedData<FDXBrokerPosition>>>} Standard response with success/Error/Warning structure
|
|
4684
4905
|
*
|
|
4685
4906
|
* Generated from: GET /api/v1/brokers/data/positions
|
|
4686
4907
|
* @methodId get_positions_api_v1_brokers_data_positions_get
|
|
@@ -4688,7 +4909,7 @@ declare class BrokersWrapper {
|
|
|
4688
4909
|
* @example
|
|
4689
4910
|
* ```typescript-client
|
|
4690
4911
|
* // Example with no parameters
|
|
4691
|
-
* const result = await finatic.getPositions();
|
|
4912
|
+
* const result = await finatic.getPositions({});
|
|
4692
4913
|
*
|
|
4693
4914
|
* // Access the response data
|
|
4694
4915
|
* if (result.success) {
|
|
@@ -4698,7 +4919,11 @@ declare class BrokersWrapper {
|
|
|
4698
4919
|
* @example
|
|
4699
4920
|
* ```typescript-client
|
|
4700
4921
|
* // Full example with optional parameters
|
|
4701
|
-
* const result = await finatic.getPositions(
|
|
4922
|
+
* const result = await finatic.getPositions({
|
|
4923
|
+
brokerId: 'alpaca',
|
|
4924
|
+
connectionId: '00000000-0000-0000-0000-000000000000',
|
|
4925
|
+
accountId: '123456789'
|
|
4926
|
+
* });
|
|
4702
4927
|
*
|
|
4703
4928
|
* // Handle response with warnings
|
|
4704
4929
|
* if (result.success) {
|
|
@@ -4711,7 +4936,7 @@ declare class BrokersWrapper {
|
|
|
4711
4936
|
* }
|
|
4712
4937
|
* ```
|
|
4713
4938
|
*/
|
|
4714
|
-
getPositions(
|
|
4939
|
+
getPositions(params?: GetPositionsParams): Promise<FinaticResponse$2<PaginatedData<FDXBrokerPosition>>>;
|
|
4715
4940
|
/**
|
|
4716
4941
|
* Get Balances
|
|
4717
4942
|
*
|
|
@@ -4719,16 +4944,16 @@ declare class BrokersWrapper {
|
|
|
4719
4944
|
*
|
|
4720
4945
|
* This endpoint is accessible from the portal and uses session-only authentication.
|
|
4721
4946
|
* Returns balances from connections the company has read access to.
|
|
4722
|
-
* @param brokerId {string} (optional)
|
|
4723
|
-
* @param connectionId {string} (optional)
|
|
4724
|
-
* @param accountId {string} (optional)
|
|
4725
|
-
* @param isEndOfDaySnapshot {boolean} (optional)
|
|
4726
|
-
* @param limit {number} (optional)
|
|
4727
|
-
* @param offset {number} (optional)
|
|
4728
|
-
* @param balanceCreatedAfter {string} (optional)
|
|
4729
|
-
* @param balanceCreatedBefore {string} (optional)
|
|
4730
|
-
* @param includeMetadata {boolean} (optional)
|
|
4731
|
-
* @returns {Promise<FinaticResponse<FDXBrokerBalance
|
|
4947
|
+
* @param params.brokerId {string} (optional) Filter by broker ID
|
|
4948
|
+
* @param params.connectionId {string} (optional) Filter by connection ID
|
|
4949
|
+
* @param params.accountId {string} (optional) Filter by broker provided account ID or internal account UUID
|
|
4950
|
+
* @param params.isEndOfDaySnapshot {boolean} (optional) Filter by end-of-day snapshot status (true/false)
|
|
4951
|
+
* @param params.limit {number} (optional) Maximum number of balances to return
|
|
4952
|
+
* @param params.offset {number} (optional) Number of balances to skip for pagination
|
|
4953
|
+
* @param params.balanceCreatedAfter {string} (optional) Filter balances created after this timestamp
|
|
4954
|
+
* @param params.balanceCreatedBefore {string} (optional) Filter balances created before this timestamp
|
|
4955
|
+
* @param params.includeMetadata {boolean} (optional) Include balance metadata in response (excluded by default for FDX compliance)
|
|
4956
|
+
* @returns {Promise<FinaticResponse<PaginatedData<FDXBrokerBalance>>>} Standard response with success/Error/Warning structure
|
|
4732
4957
|
*
|
|
4733
4958
|
* Generated from: GET /api/v1/brokers/data/balances
|
|
4734
4959
|
* @methodId get_balances_api_v1_brokers_data_balances_get
|
|
@@ -4736,7 +4961,7 @@ declare class BrokersWrapper {
|
|
|
4736
4961
|
* @example
|
|
4737
4962
|
* ```typescript-client
|
|
4738
4963
|
* // Example with no parameters
|
|
4739
|
-
* const result = await finatic.getBalances();
|
|
4964
|
+
* const result = await finatic.getBalances({});
|
|
4740
4965
|
*
|
|
4741
4966
|
* // Access the response data
|
|
4742
4967
|
* if (result.success) {
|
|
@@ -4746,7 +4971,11 @@ declare class BrokersWrapper {
|
|
|
4746
4971
|
* @example
|
|
4747
4972
|
* ```typescript-client
|
|
4748
4973
|
* // Full example with optional parameters
|
|
4749
|
-
* const result = await finatic.getBalances(
|
|
4974
|
+
* const result = await finatic.getBalances({
|
|
4975
|
+
brokerId: 'alpaca',
|
|
4976
|
+
connectionId: '00000000-0000-0000-0000-000000000000',
|
|
4977
|
+
accountId: '123456789'
|
|
4978
|
+
* });
|
|
4750
4979
|
*
|
|
4751
4980
|
* // Handle response with warnings
|
|
4752
4981
|
* if (result.success) {
|
|
@@ -4759,7 +4988,7 @@ declare class BrokersWrapper {
|
|
|
4759
4988
|
* }
|
|
4760
4989
|
* ```
|
|
4761
4990
|
*/
|
|
4762
|
-
getBalances(
|
|
4991
|
+
getBalances(params?: GetBalancesParams): Promise<FinaticResponse$2<PaginatedData<FDXBrokerBalance>>>;
|
|
4763
4992
|
/**
|
|
4764
4993
|
* Get Accounts
|
|
4765
4994
|
*
|
|
@@ -4767,15 +4996,15 @@ declare class BrokersWrapper {
|
|
|
4767
4996
|
*
|
|
4768
4997
|
* This endpoint is accessible from the portal and uses session-only authentication.
|
|
4769
4998
|
* Returns accounts from connections the company has read access to.
|
|
4770
|
-
* @param brokerId {string} (optional)
|
|
4771
|
-
* @param connectionId {string} (optional)
|
|
4772
|
-
* @param accountType {BrokerDataAccountTypeEnum} (optional)
|
|
4773
|
-
* @param status {AccountStatus} (optional)
|
|
4774
|
-
* @param currency {string} (optional)
|
|
4775
|
-
* @param limit {number} (optional)
|
|
4776
|
-
* @param offset {number} (optional)
|
|
4777
|
-
* @param includeMetadata {boolean} (optional)
|
|
4778
|
-
* @returns {Promise<FinaticResponse<FDXBrokerAccount
|
|
4999
|
+
* @param params.brokerId {string} (optional) Filter by broker ID
|
|
5000
|
+
* @param params.connectionId {string} (optional) Filter by connection ID
|
|
5001
|
+
* @param params.accountType {BrokerDataAccountTypeEnum} (optional) Filter by account type (e.g., 'margin', 'cash', 'crypto_wallet', 'live', 'sim')
|
|
5002
|
+
* @param params.status {AccountStatus} (optional) Filter by account status (e.g., 'active', 'inactive')
|
|
5003
|
+
* @param params.currency {string} (optional) Filter by currency (e.g., 'USD', 'EUR')
|
|
5004
|
+
* @param params.limit {number} (optional) Maximum number of accounts to return
|
|
5005
|
+
* @param params.offset {number} (optional) Number of accounts to skip for pagination
|
|
5006
|
+
* @param params.includeMetadata {boolean} (optional) Include connection metadata in response (excluded by default for FDX compliance)
|
|
5007
|
+
* @returns {Promise<FinaticResponse<PaginatedData<FDXBrokerAccount>>>} Standard response with success/Error/Warning structure
|
|
4779
5008
|
*
|
|
4780
5009
|
* Generated from: GET /api/v1/brokers/data/accounts
|
|
4781
5010
|
* @methodId get_accounts_api_v1_brokers_data_accounts_get
|
|
@@ -4783,7 +5012,7 @@ declare class BrokersWrapper {
|
|
|
4783
5012
|
* @example
|
|
4784
5013
|
* ```typescript-client
|
|
4785
5014
|
* // Example with no parameters
|
|
4786
|
-
* const result = await finatic.getAccounts();
|
|
5015
|
+
* const result = await finatic.getAccounts({});
|
|
4787
5016
|
*
|
|
4788
5017
|
* // Access the response data
|
|
4789
5018
|
* if (result.success) {
|
|
@@ -4793,7 +5022,11 @@ declare class BrokersWrapper {
|
|
|
4793
5022
|
* @example
|
|
4794
5023
|
* ```typescript-client
|
|
4795
5024
|
* // Full example with optional parameters
|
|
4796
|
-
* const result = await finatic.getAccounts(
|
|
5025
|
+
* const result = await finatic.getAccounts({
|
|
5026
|
+
brokerId: 'alpaca',
|
|
5027
|
+
connectionId: '00000000-0000-0000-0000-000000000000',
|
|
5028
|
+
accountType: 'margin'
|
|
5029
|
+
* });
|
|
4797
5030
|
*
|
|
4798
5031
|
* // Handle response with warnings
|
|
4799
5032
|
* if (result.success) {
|
|
@@ -4806,19 +5039,19 @@ declare class BrokersWrapper {
|
|
|
4806
5039
|
* }
|
|
4807
5040
|
* ```
|
|
4808
5041
|
*/
|
|
4809
|
-
getAccounts(
|
|
5042
|
+
getAccounts(params?: GetAccountsParams): Promise<FinaticResponse$2<PaginatedData<FDXBrokerAccount>>>;
|
|
4810
5043
|
/**
|
|
4811
5044
|
* Get Order Fills
|
|
4812
5045
|
*
|
|
4813
5046
|
* Get order fills for a specific order.
|
|
4814
5047
|
*
|
|
4815
5048
|
* This endpoint returns all execution fills for the specified order.
|
|
4816
|
-
* @param orderId {string}
|
|
4817
|
-
* @param connectionId {string} (optional)
|
|
4818
|
-
* @param limit {number} (optional)
|
|
4819
|
-
* @param offset {number} (optional)
|
|
4820
|
-
* @param includeMetadata {boolean} (optional)
|
|
4821
|
-
* @returns {Promise<FinaticResponse<FDXBrokerOrderFill
|
|
5049
|
+
* @param params.orderId {string} Order ID
|
|
5050
|
+
* @param params.connectionId {string} (optional) Filter by connection ID
|
|
5051
|
+
* @param params.limit {number} (optional) Maximum number of fills to return
|
|
5052
|
+
* @param params.offset {number} (optional) Number of fills to skip for pagination
|
|
5053
|
+
* @param params.includeMetadata {boolean} (optional) Include fill metadata in response (excluded by default for FDX compliance)
|
|
5054
|
+
* @returns {Promise<FinaticResponse<PaginatedData<FDXBrokerOrderFill>>>} Standard response with success/Error/Warning structure
|
|
4822
5055
|
*
|
|
4823
5056
|
* Generated from: GET /api/v1/brokers/data/orders/{order_id}/fills
|
|
4824
5057
|
* @methodId get_order_fills_api_v1_brokers_data_orders__order_id__fills_get
|
|
@@ -4826,7 +5059,9 @@ declare class BrokersWrapper {
|
|
|
4826
5059
|
* @example
|
|
4827
5060
|
* ```typescript-client
|
|
4828
5061
|
* // Minimal example with required parameters only
|
|
4829
|
-
* const result = await finatic.getOrderFills(
|
|
5062
|
+
* const result = await finatic.getOrderFills({
|
|
5063
|
+
orderId: '00000000-0000-0000-0000-000000000000'
|
|
5064
|
+
* });
|
|
4830
5065
|
*
|
|
4831
5066
|
* // Access the response data
|
|
4832
5067
|
* if (result.success) {
|
|
@@ -4838,7 +5073,12 @@ declare class BrokersWrapper {
|
|
|
4838
5073
|
* @example
|
|
4839
5074
|
* ```typescript-client
|
|
4840
5075
|
* // Full example with optional parameters
|
|
4841
|
-
* const result = await finatic.getOrderFills(
|
|
5076
|
+
* const result = await finatic.getOrderFills({
|
|
5077
|
+
orderId: '00000000-0000-0000-0000-000000000000',
|
|
5078
|
+
connectionId: '00000000-0000-0000-0000-000000000000',
|
|
5079
|
+
limit: 100,
|
|
5080
|
+
offset: 0
|
|
5081
|
+
* });
|
|
4842
5082
|
*
|
|
4843
5083
|
* // Handle response with warnings
|
|
4844
5084
|
* if (result.success) {
|
|
@@ -4851,19 +5091,19 @@ declare class BrokersWrapper {
|
|
|
4851
5091
|
* }
|
|
4852
5092
|
* ```
|
|
4853
5093
|
*/
|
|
4854
|
-
getOrderFills(
|
|
5094
|
+
getOrderFills(params: GetOrderFillsParams): Promise<FinaticResponse$2<PaginatedData<FDXBrokerOrderFill>>>;
|
|
4855
5095
|
/**
|
|
4856
5096
|
* Get Order Events
|
|
4857
5097
|
*
|
|
4858
5098
|
* Get order events for a specific order.
|
|
4859
5099
|
*
|
|
4860
5100
|
* This endpoint returns all lifecycle events for the specified order.
|
|
4861
|
-
* @param orderId {string}
|
|
4862
|
-
* @param connectionId {string} (optional)
|
|
4863
|
-
* @param limit {number} (optional)
|
|
4864
|
-
* @param offset {number} (optional)
|
|
4865
|
-
* @param includeMetadata {boolean} (optional)
|
|
4866
|
-
* @returns {Promise<FinaticResponse<FDXBrokerOrderEvent
|
|
5101
|
+
* @param params.orderId {string} Order ID
|
|
5102
|
+
* @param params.connectionId {string} (optional) Filter by connection ID
|
|
5103
|
+
* @param params.limit {number} (optional) Maximum number of events to return
|
|
5104
|
+
* @param params.offset {number} (optional) Number of events to skip for pagination
|
|
5105
|
+
* @param params.includeMetadata {boolean} (optional) Include event metadata in response (excluded by default for FDX compliance)
|
|
5106
|
+
* @returns {Promise<FinaticResponse<PaginatedData<FDXBrokerOrderEvent>>>} Standard response with success/Error/Warning structure
|
|
4867
5107
|
*
|
|
4868
5108
|
* Generated from: GET /api/v1/brokers/data/orders/{order_id}/events
|
|
4869
5109
|
* @methodId get_order_events_api_v1_brokers_data_orders__order_id__events_get
|
|
@@ -4871,7 +5111,9 @@ declare class BrokersWrapper {
|
|
|
4871
5111
|
* @example
|
|
4872
5112
|
* ```typescript-client
|
|
4873
5113
|
* // Minimal example with required parameters only
|
|
4874
|
-
* const result = await finatic.getOrderEvents(
|
|
5114
|
+
* const result = await finatic.getOrderEvents({
|
|
5115
|
+
orderId: '00000000-0000-0000-0000-000000000000'
|
|
5116
|
+
* });
|
|
4875
5117
|
*
|
|
4876
5118
|
* // Access the response data
|
|
4877
5119
|
* if (result.success) {
|
|
@@ -4883,7 +5125,12 @@ declare class BrokersWrapper {
|
|
|
4883
5125
|
* @example
|
|
4884
5126
|
* ```typescript-client
|
|
4885
5127
|
* // Full example with optional parameters
|
|
4886
|
-
* const result = await finatic.getOrderEvents(
|
|
5128
|
+
* const result = await finatic.getOrderEvents({
|
|
5129
|
+
orderId: '00000000-0000-0000-0000-000000000000',
|
|
5130
|
+
connectionId: '00000000-0000-0000-0000-000000000000',
|
|
5131
|
+
limit: 100,
|
|
5132
|
+
offset: 0
|
|
5133
|
+
* });
|
|
4887
5134
|
*
|
|
4888
5135
|
* // Handle response with warnings
|
|
4889
5136
|
* if (result.success) {
|
|
@@ -4896,21 +5143,21 @@ declare class BrokersWrapper {
|
|
|
4896
5143
|
* }
|
|
4897
5144
|
* ```
|
|
4898
5145
|
*/
|
|
4899
|
-
getOrderEvents(
|
|
5146
|
+
getOrderEvents(params: GetOrderEventsParams): Promise<FinaticResponse$2<PaginatedData<FDXBrokerOrderEvent>>>;
|
|
4900
5147
|
/**
|
|
4901
5148
|
* Get Order Groups
|
|
4902
5149
|
*
|
|
4903
5150
|
* Get order groups.
|
|
4904
5151
|
*
|
|
4905
5152
|
* This endpoint returns order groups that contain multiple orders.
|
|
4906
|
-
* @param brokerId {string} (optional)
|
|
4907
|
-
* @param connectionId {string} (optional)
|
|
4908
|
-
* @param limit {number} (optional)
|
|
4909
|
-
* @param offset {number} (optional)
|
|
4910
|
-
* @param createdAfter {string} (optional)
|
|
4911
|
-
* @param createdBefore {string} (optional)
|
|
4912
|
-
* @param includeMetadata {boolean} (optional)
|
|
4913
|
-
* @returns {Promise<FinaticResponse<FDXBrokerOrderGroup
|
|
5153
|
+
* @param params.brokerId {string} (optional) Filter by broker ID
|
|
5154
|
+
* @param params.connectionId {string} (optional) Filter by connection ID
|
|
5155
|
+
* @param params.limit {number} (optional) Maximum number of order groups to return
|
|
5156
|
+
* @param params.offset {number} (optional) Number of order groups to skip for pagination
|
|
5157
|
+
* @param params.createdAfter {string} (optional) Filter order groups created after this timestamp
|
|
5158
|
+
* @param params.createdBefore {string} (optional) Filter order groups created before this timestamp
|
|
5159
|
+
* @param params.includeMetadata {boolean} (optional) Include group metadata in response (excluded by default for FDX compliance)
|
|
5160
|
+
* @returns {Promise<FinaticResponse<PaginatedData<FDXBrokerOrderGroup>>>} Standard response with success/Error/Warning structure
|
|
4914
5161
|
*
|
|
4915
5162
|
* Generated from: GET /api/v1/brokers/data/orders/groups
|
|
4916
5163
|
* @methodId get_order_groups_api_v1_brokers_data_orders_groups_get
|
|
@@ -4918,7 +5165,7 @@ declare class BrokersWrapper {
|
|
|
4918
5165
|
* @example
|
|
4919
5166
|
* ```typescript-client
|
|
4920
5167
|
* // Example with no parameters
|
|
4921
|
-
* const result = await finatic.getOrderGroups();
|
|
5168
|
+
* const result = await finatic.getOrderGroups({});
|
|
4922
5169
|
*
|
|
4923
5170
|
* // Access the response data
|
|
4924
5171
|
* if (result.success) {
|
|
@@ -4928,7 +5175,11 @@ declare class BrokersWrapper {
|
|
|
4928
5175
|
* @example
|
|
4929
5176
|
* ```typescript-client
|
|
4930
5177
|
* // Full example with optional parameters
|
|
4931
|
-
* const result = await finatic.getOrderGroups(
|
|
5178
|
+
* const result = await finatic.getOrderGroups({
|
|
5179
|
+
brokerId: 'alpaca',
|
|
5180
|
+
connectionId: '00000000-0000-0000-0000-000000000000',
|
|
5181
|
+
limit: 100
|
|
5182
|
+
* });
|
|
4932
5183
|
*
|
|
4933
5184
|
* // Handle response with warnings
|
|
4934
5185
|
* if (result.success) {
|
|
@@ -4941,7 +5192,7 @@ declare class BrokersWrapper {
|
|
|
4941
5192
|
* }
|
|
4942
5193
|
* ```
|
|
4943
5194
|
*/
|
|
4944
|
-
getOrderGroups(
|
|
5195
|
+
getOrderGroups(params?: GetOrderGroupsParams): Promise<FinaticResponse$2<PaginatedData<FDXBrokerOrderGroup>>>;
|
|
4945
5196
|
/**
|
|
4946
5197
|
* Get Position Lots
|
|
4947
5198
|
*
|
|
@@ -4949,14 +5200,14 @@ declare class BrokersWrapper {
|
|
|
4949
5200
|
*
|
|
4950
5201
|
* This endpoint returns tax lots for positions, which are used for tax reporting.
|
|
4951
5202
|
* Each lot tracks when a position was opened/closed and at what prices.
|
|
4952
|
-
* @param brokerId {string} (optional)
|
|
4953
|
-
* @param connectionId {string} (optional)
|
|
4954
|
-
* @param accountId {string} (optional)
|
|
4955
|
-
* @param symbol {string} (optional)
|
|
4956
|
-
* @param positionId {string} (optional)
|
|
4957
|
-
* @param limit {number} (optional)
|
|
4958
|
-
* @param offset {number} (optional)
|
|
4959
|
-
* @returns {Promise<FinaticResponse<FDXBrokerPositionLot
|
|
5203
|
+
* @param params.brokerId {string} (optional) Filter by broker ID
|
|
5204
|
+
* @param params.connectionId {string} (optional) Filter by connection ID
|
|
5205
|
+
* @param params.accountId {string} (optional) Filter by broker provided account ID
|
|
5206
|
+
* @param params.symbol {string} (optional) Filter by symbol
|
|
5207
|
+
* @param params.positionId {string} (optional) Filter by position ID
|
|
5208
|
+
* @param params.limit {number} (optional) Maximum number of position lots to return
|
|
5209
|
+
* @param params.offset {number} (optional) Number of position lots to skip for pagination
|
|
5210
|
+
* @returns {Promise<FinaticResponse<PaginatedData<FDXBrokerPositionLot>>>} Standard response with success/Error/Warning structure
|
|
4960
5211
|
*
|
|
4961
5212
|
* Generated from: GET /api/v1/brokers/data/positions/lots
|
|
4962
5213
|
* @methodId get_position_lots_api_v1_brokers_data_positions_lots_get
|
|
@@ -4964,7 +5215,7 @@ declare class BrokersWrapper {
|
|
|
4964
5215
|
* @example
|
|
4965
5216
|
* ```typescript-client
|
|
4966
5217
|
* // Example with no parameters
|
|
4967
|
-
* const result = await finatic.getPositionLots();
|
|
5218
|
+
* const result = await finatic.getPositionLots({});
|
|
4968
5219
|
*
|
|
4969
5220
|
* // Access the response data
|
|
4970
5221
|
* if (result.success) {
|
|
@@ -4974,7 +5225,11 @@ declare class BrokersWrapper {
|
|
|
4974
5225
|
* @example
|
|
4975
5226
|
* ```typescript-client
|
|
4976
5227
|
* // Full example with optional parameters
|
|
4977
|
-
* const result = await finatic.getPositionLots(
|
|
5228
|
+
* const result = await finatic.getPositionLots({
|
|
5229
|
+
brokerId: 'alpaca',
|
|
5230
|
+
connectionId: '00000000-0000-0000-0000-000000000000',
|
|
5231
|
+
accountId: '123456789'
|
|
5232
|
+
* });
|
|
4978
5233
|
*
|
|
4979
5234
|
* // Handle response with warnings
|
|
4980
5235
|
* if (result.success) {
|
|
@@ -4987,18 +5242,18 @@ declare class BrokersWrapper {
|
|
|
4987
5242
|
* }
|
|
4988
5243
|
* ```
|
|
4989
5244
|
*/
|
|
4990
|
-
getPositionLots(
|
|
5245
|
+
getPositionLots(params?: GetPositionLotsParams): Promise<FinaticResponse$2<PaginatedData<FDXBrokerPositionLot>>>;
|
|
4991
5246
|
/**
|
|
4992
5247
|
* Get Position Lot Fills
|
|
4993
5248
|
*
|
|
4994
5249
|
* Get position lot fills for a specific lot.
|
|
4995
5250
|
*
|
|
4996
5251
|
* This endpoint returns all fills associated with a specific position lot.
|
|
4997
|
-
* @param lotId {string}
|
|
4998
|
-
* @param connectionId {string} (optional)
|
|
4999
|
-
* @param limit {number} (optional)
|
|
5000
|
-
* @param offset {number} (optional)
|
|
5001
|
-
* @returns {Promise<FinaticResponse<FDXBrokerPositionLotFill
|
|
5252
|
+
* @param params.lotId {string} Position lot ID
|
|
5253
|
+
* @param params.connectionId {string} (optional) Filter by connection ID
|
|
5254
|
+
* @param params.limit {number} (optional) Maximum number of fills to return
|
|
5255
|
+
* @param params.offset {number} (optional) Number of fills to skip for pagination
|
|
5256
|
+
* @returns {Promise<FinaticResponse<PaginatedData<FDXBrokerPositionLotFill>>>} Standard response with success/Error/Warning structure
|
|
5002
5257
|
*
|
|
5003
5258
|
* Generated from: GET /api/v1/brokers/data/positions/lots/{lot_id}/fills
|
|
5004
5259
|
* @methodId get_position_lot_fills_api_v1_brokers_data_positions_lots__lot_id__fills_get
|
|
@@ -5006,7 +5261,9 @@ declare class BrokersWrapper {
|
|
|
5006
5261
|
* @example
|
|
5007
5262
|
* ```typescript-client
|
|
5008
5263
|
* // Minimal example with required parameters only
|
|
5009
|
-
* const result = await finatic.getPositionLotFills(
|
|
5264
|
+
* const result = await finatic.getPositionLotFills({
|
|
5265
|
+
lotId: '00000000-0000-0000-0000-000000000000'
|
|
5266
|
+
* });
|
|
5010
5267
|
*
|
|
5011
5268
|
* // Access the response data
|
|
5012
5269
|
* if (result.success) {
|
|
@@ -5018,7 +5275,12 @@ declare class BrokersWrapper {
|
|
|
5018
5275
|
* @example
|
|
5019
5276
|
* ```typescript-client
|
|
5020
5277
|
* // Full example with optional parameters
|
|
5021
|
-
* const result = await finatic.getPositionLotFills(
|
|
5278
|
+
* const result = await finatic.getPositionLotFills({
|
|
5279
|
+
lotId: '00000000-0000-0000-0000-000000000000',
|
|
5280
|
+
connectionId: '00000000-0000-0000-0000-000000000000',
|
|
5281
|
+
limit: 100,
|
|
5282
|
+
offset: 0
|
|
5283
|
+
* });
|
|
5022
5284
|
*
|
|
5023
5285
|
* // Handle response with warnings
|
|
5024
5286
|
* if (result.success) {
|
|
@@ -5031,7 +5293,7 @@ declare class BrokersWrapper {
|
|
|
5031
5293
|
* }
|
|
5032
5294
|
* ```
|
|
5033
5295
|
*/
|
|
5034
|
-
getPositionLotFills(
|
|
5296
|
+
getPositionLotFills(params: GetPositionLotFillsParams): Promise<FinaticResponse$2<PaginatedData<FDXBrokerPositionLotFill>>>;
|
|
5035
5297
|
}
|
|
5036
5298
|
|
|
5037
5299
|
/**
|
|
@@ -5188,6 +5450,10 @@ interface FinaticResponse$1<T> {
|
|
|
5188
5450
|
[key: string]: any;
|
|
5189
5451
|
}> | null;
|
|
5190
5452
|
}
|
|
5453
|
+
interface GetCompanyParams$1 {
|
|
5454
|
+
/** Company ID */
|
|
5455
|
+
companyId: string;
|
|
5456
|
+
}
|
|
5191
5457
|
/**
|
|
5192
5458
|
* Company wrapper functions.
|
|
5193
5459
|
* Provides simplified method names and response unwrapping.
|
|
@@ -5209,7 +5475,7 @@ declare class CompanyWrapper {
|
|
|
5209
5475
|
* Get Company
|
|
5210
5476
|
*
|
|
5211
5477
|
* Get public company details by ID (no user check, no sensitive data).
|
|
5212
|
-
* @param companyId {string}
|
|
5478
|
+
* @param params.companyId {string} Company ID
|
|
5213
5479
|
* @returns {Promise<FinaticResponse<CompanyResponse>>} Standard response with success/Error/Warning structure
|
|
5214
5480
|
*
|
|
5215
5481
|
* Generated from: GET /api/v1/company/{company_id}
|
|
@@ -5218,7 +5484,9 @@ declare class CompanyWrapper {
|
|
|
5218
5484
|
* @example
|
|
5219
5485
|
* ```typescript-client
|
|
5220
5486
|
* // Minimal example with required parameters only
|
|
5221
|
-
* const result = await finatic.getCompany(
|
|
5487
|
+
* const result = await finatic.getCompany({
|
|
5488
|
+
companyId: '00000000-0000-0000-0000-000000000000'
|
|
5489
|
+
* });
|
|
5222
5490
|
*
|
|
5223
5491
|
* // Access the response data
|
|
5224
5492
|
* if (result.success) {
|
|
@@ -5228,7 +5496,7 @@ declare class CompanyWrapper {
|
|
|
5228
5496
|
* }
|
|
5229
5497
|
* ```
|
|
5230
5498
|
*/
|
|
5231
|
-
getCompany(
|
|
5499
|
+
getCompany(params: GetCompanyParams$1): Promise<FinaticResponse$1<CompanyResponse>>;
|
|
5232
5500
|
}
|
|
5233
5501
|
|
|
5234
5502
|
/**
|
|
@@ -5263,8 +5531,8 @@ declare const SessionApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
|
5263
5531
|
/**
|
|
5264
5532
|
* Start a session with a one-time token.
|
|
5265
5533
|
* @summary Start Session
|
|
5266
|
-
* @param {string} oneTimeToken
|
|
5267
|
-
* @param {SessionStartRequest} sessionStartRequest
|
|
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
|
|
5268
5536
|
* @param {*} [options] Override http request option.
|
|
5269
5537
|
* @throws {RequiredError}
|
|
5270
5538
|
*/
|
|
@@ -5302,8 +5570,8 @@ declare const SessionApiFp: (configuration?: Configuration) => {
|
|
|
5302
5570
|
/**
|
|
5303
5571
|
* Start a session with a one-time token.
|
|
5304
5572
|
* @summary Start Session
|
|
5305
|
-
* @param {string} oneTimeToken
|
|
5306
|
-
* @param {SessionStartRequest} sessionStartRequest
|
|
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
|
|
5307
5575
|
* @param {*} [options] Override http request option.
|
|
5308
5576
|
* @throws {RequiredError}
|
|
5309
5577
|
*/
|
|
@@ -5418,7 +5686,13 @@ interface SessionApiInitSessionApiV1SessionInitPostRequest {
|
|
|
5418
5686
|
* Request parameters for startSessionApiV1SessionStartPost operation in SessionApi.
|
|
5419
5687
|
*/
|
|
5420
5688
|
interface SessionApiStartSessionApiV1SessionStartPostRequest {
|
|
5689
|
+
/**
|
|
5690
|
+
* One-time use token obtained from init_session endpoint to authenticate and start the session
|
|
5691
|
+
*/
|
|
5421
5692
|
readonly oneTimeToken: string;
|
|
5693
|
+
/**
|
|
5694
|
+
* Session start request containing optional user ID to associate with the session
|
|
5695
|
+
*/
|
|
5422
5696
|
readonly sessionStartRequest: SessionStartRequest;
|
|
5423
5697
|
}
|
|
5424
5698
|
/**
|
|
@@ -5489,6 +5763,20 @@ interface FinaticResponse<T> {
|
|
|
5489
5763
|
[key: string]: any;
|
|
5490
5764
|
}> | null;
|
|
5491
5765
|
}
|
|
5766
|
+
interface InitSessionParams {
|
|
5767
|
+
/** Company API key */
|
|
5768
|
+
xApiKey: string;
|
|
5769
|
+
}
|
|
5770
|
+
interface StartSessionParams {
|
|
5771
|
+
/** One-time use token obtained from init_session endpoint to authenticate and start the session */
|
|
5772
|
+
OneTimeToken: string;
|
|
5773
|
+
/** Session start request containing optional user ID to associate with the session */
|
|
5774
|
+
body: SessionStartRequest;
|
|
5775
|
+
}
|
|
5776
|
+
interface GetSessionUserParams {
|
|
5777
|
+
/** Session ID */
|
|
5778
|
+
sessionId: string;
|
|
5779
|
+
}
|
|
5492
5780
|
/**
|
|
5493
5781
|
* Session wrapper functions.
|
|
5494
5782
|
* Provides simplified method names and response unwrapping.
|
|
@@ -5510,7 +5798,7 @@ declare class SessionWrapper {
|
|
|
5510
5798
|
* Init Session
|
|
5511
5799
|
*
|
|
5512
5800
|
* Initialize a new session with company API key.
|
|
5513
|
-
* @param xApiKey {string}
|
|
5801
|
+
* @param params.xApiKey {string} Company API key
|
|
5514
5802
|
* @returns {Promise<FinaticResponse<TokenResponseData>>} Standard response with success/Error/Warning structure
|
|
5515
5803
|
*
|
|
5516
5804
|
* Generated from: POST /api/v1/session/init
|
|
@@ -5519,7 +5807,7 @@ declare class SessionWrapper {
|
|
|
5519
5807
|
* @example
|
|
5520
5808
|
* ```typescript-client
|
|
5521
5809
|
* // Example with no parameters
|
|
5522
|
-
* const result = await finatic.initSession();
|
|
5810
|
+
* const result = await finatic.initSession({});
|
|
5523
5811
|
*
|
|
5524
5812
|
* // Access the response data
|
|
5525
5813
|
* if (result.success) {
|
|
@@ -5527,13 +5815,13 @@ declare class SessionWrapper {
|
|
|
5527
5815
|
* }
|
|
5528
5816
|
* ```
|
|
5529
5817
|
*/
|
|
5530
|
-
initSession(
|
|
5818
|
+
initSession(params: InitSessionParams): Promise<FinaticResponse<TokenResponseData>>;
|
|
5531
5819
|
/**
|
|
5532
5820
|
* Start Session
|
|
5533
5821
|
*
|
|
5534
5822
|
* Start a session with a one-time token.
|
|
5535
|
-
* @param OneTimeToken {string}
|
|
5536
|
-
* @param body {SessionStartRequest}
|
|
5823
|
+
* @param params.OneTimeToken {string} One-time use token obtained from init_session endpoint to authenticate and start the session
|
|
5824
|
+
* @param params.body {SessionStartRequest} Session start request containing optional user ID to associate with the session
|
|
5537
5825
|
* @returns {Promise<FinaticResponse<SessionResponseData>>} Standard response with success/Error/Warning structure
|
|
5538
5826
|
*
|
|
5539
5827
|
* Generated from: POST /api/v1/session/start
|
|
@@ -5542,7 +5830,7 @@ declare class SessionWrapper {
|
|
|
5542
5830
|
* @example
|
|
5543
5831
|
* ```typescript-client
|
|
5544
5832
|
* // Example with no parameters
|
|
5545
|
-
* const result = await finatic.startSession();
|
|
5833
|
+
* const result = await finatic.startSession({});
|
|
5546
5834
|
*
|
|
5547
5835
|
* // Access the response data
|
|
5548
5836
|
* if (result.success) {
|
|
@@ -5550,7 +5838,7 @@ declare class SessionWrapper {
|
|
|
5550
5838
|
* }
|
|
5551
5839
|
* ```
|
|
5552
5840
|
*/
|
|
5553
|
-
startSession(
|
|
5841
|
+
startSession(params: StartSessionParams): Promise<FinaticResponse<SessionResponseData>>;
|
|
5554
5842
|
/**
|
|
5555
5843
|
* Get Portal Url
|
|
5556
5844
|
*
|
|
@@ -5558,7 +5846,7 @@ declare class SessionWrapper {
|
|
|
5558
5846
|
*
|
|
5559
5847
|
* The session must be in ACTIVE or AUTHENTICATING state and the request must come from the same device
|
|
5560
5848
|
* that initiated the session. Device info is automatically validated from the request.
|
|
5561
|
-
* @param No parameters required for this method
|
|
5849
|
+
* @param params No parameters required for this method
|
|
5562
5850
|
* @returns {Promise<FinaticResponse<PortalUrlResponse>>} Standard response with success/Error/Warning structure
|
|
5563
5851
|
*
|
|
5564
5852
|
* Generated from: GET /api/v1/session/portal
|
|
@@ -5567,7 +5855,7 @@ declare class SessionWrapper {
|
|
|
5567
5855
|
* @example
|
|
5568
5856
|
* ```typescript-client
|
|
5569
5857
|
* // Example with no parameters
|
|
5570
|
-
* const result = await finatic.getPortalUrl();
|
|
5858
|
+
* const result = await finatic.getPortalUrl({});
|
|
5571
5859
|
*
|
|
5572
5860
|
* // Access the response data
|
|
5573
5861
|
* if (result.success) {
|
|
@@ -5575,7 +5863,7 @@ declare class SessionWrapper {
|
|
|
5575
5863
|
* }
|
|
5576
5864
|
* ```
|
|
5577
5865
|
*/
|
|
5578
|
-
getPortalUrl(): Promise<FinaticResponse<PortalUrlResponse>>;
|
|
5866
|
+
getPortalUrl(params?: {}): Promise<FinaticResponse<PortalUrlResponse>>;
|
|
5579
5867
|
/**
|
|
5580
5868
|
* Get Session User
|
|
5581
5869
|
*
|
|
@@ -5591,7 +5879,7 @@ declare class SessionWrapper {
|
|
|
5591
5879
|
* - Generates fresh tokens (not returning stored ones)
|
|
5592
5880
|
* - Only accessible to authenticated sessions with user_id
|
|
5593
5881
|
* - Validates that header session_id matches path session_id
|
|
5594
|
-
* @param sessionId {string}
|
|
5882
|
+
* @param params.sessionId {string} Session ID
|
|
5595
5883
|
* @returns {Promise<FinaticResponse<SessionUserResponse>>} Standard response with success/Error/Warning structure
|
|
5596
5884
|
*
|
|
5597
5885
|
* Generated from: GET /api/v1/session/{session_id}/user
|
|
@@ -5600,7 +5888,9 @@ declare class SessionWrapper {
|
|
|
5600
5888
|
* @example
|
|
5601
5889
|
* ```typescript-client
|
|
5602
5890
|
* // Minimal example with required parameters only
|
|
5603
|
-
* const result = await finatic.getSessionUser(
|
|
5891
|
+
* const result = await finatic.getSessionUser({
|
|
5892
|
+
sessionId: 'sess_1234567890abcdef'
|
|
5893
|
+
* });
|
|
5604
5894
|
*
|
|
5605
5895
|
* // Access the response data
|
|
5606
5896
|
* if (result.success) {
|
|
@@ -5610,7 +5900,7 @@ declare class SessionWrapper {
|
|
|
5610
5900
|
* }
|
|
5611
5901
|
* ```
|
|
5612
5902
|
*/
|
|
5613
|
-
getSessionUser(
|
|
5903
|
+
getSessionUser(params: GetSessionUserParams): Promise<FinaticResponse<SessionUserResponse>>;
|
|
5614
5904
|
}
|
|
5615
5905
|
|
|
5616
5906
|
/**
|
|
@@ -5925,28 +6215,34 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
5925
6215
|
*
|
|
5926
6216
|
* @methodId get_portal_url_api_v1_session_portal_get
|
|
5927
6217
|
* @category session
|
|
5928
|
-
* @param
|
|
5929
|
-
* @param
|
|
5930
|
-
* @param
|
|
5931
|
-
* @param
|
|
6218
|
+
* @param params - Optional parameters object
|
|
6219
|
+
* @param params.theme - Optional theme preset or custom theme object
|
|
6220
|
+
* @param params.brokers - Optional array of broker IDs to filter
|
|
6221
|
+
* @param params.email - Optional email address
|
|
6222
|
+
* @param params.mode - Optional mode ('light' or 'dark')
|
|
5932
6223
|
* @returns Portal URL string
|
|
5933
6224
|
* @example
|
|
5934
6225
|
* ```typescript-client
|
|
5935
|
-
* const url = await finatic.getPortalUrl('
|
|
6226
|
+
* const url = await finatic.getPortalUrl({ theme: 'default', brokers: ['broker-1'], email: 'user@example.com', mode: 'dark' });
|
|
5936
6227
|
* ```
|
|
5937
6228
|
* @example
|
|
5938
6229
|
* ```typescript-server
|
|
5939
|
-
* const url = await finatic.getPortalUrl('
|
|
6230
|
+
* const url = await finatic.getPortalUrl({ theme: 'default', brokers: ['broker-1'], email: 'user@example.com', mode: 'dark' });
|
|
5940
6231
|
* ```
|
|
5941
6232
|
* @example
|
|
5942
6233
|
* ```python
|
|
5943
|
-
* url = await finatic.get_portal_url('
|
|
6234
|
+
* url = await finatic.get_portal_url(theme='default', brokers=['broker-1'], email='user@example.com', mode='dark')
|
|
5944
6235
|
* ```
|
|
5945
6236
|
*/
|
|
5946
|
-
getPortalUrl(
|
|
5947
|
-
|
|
5948
|
-
|
|
5949
|
-
|
|
6237
|
+
getPortalUrl(params?: {
|
|
6238
|
+
theme?: string | {
|
|
6239
|
+
preset?: string;
|
|
6240
|
+
custom?: Record<string, unknown>;
|
|
6241
|
+
};
|
|
6242
|
+
brokers?: string[];
|
|
6243
|
+
email?: string;
|
|
6244
|
+
mode?: 'light' | 'dark';
|
|
6245
|
+
}): Promise<string>;
|
|
5950
6246
|
/**
|
|
5951
6247
|
* Open portal in iframe (Client SDK only).
|
|
5952
6248
|
* The portal handles user authentication and linking to session at the source of truth.
|
|
@@ -5954,27 +6250,38 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
5954
6250
|
*
|
|
5955
6251
|
* @methodId open_portal_client_sdk
|
|
5956
6252
|
* @category session
|
|
5957
|
-
* @param
|
|
5958
|
-
* @param
|
|
5959
|
-
* @param
|
|
5960
|
-
* @param
|
|
6253
|
+
* @param params - Optional parameters object
|
|
6254
|
+
* @param params.theme - Optional theme preset or custom theme object
|
|
6255
|
+
* @param params.brokers - Optional array of broker IDs to filter
|
|
6256
|
+
* @param params.email - Optional email address
|
|
6257
|
+
* @param params.mode - Optional mode ('light' or 'dark')
|
|
5961
6258
|
* @param onSuccess - Optional callback when portal authentication succeeds
|
|
5962
6259
|
* @param onError - Optional callback when portal authentication fails
|
|
5963
6260
|
* @param onClose - Optional callback when portal is closed
|
|
5964
6261
|
* @returns Promise that resolves when portal is opened
|
|
5965
6262
|
* @example
|
|
5966
6263
|
* ```typescript-client
|
|
5967
|
-
* await finatic.openPortal(
|
|
6264
|
+
* await finatic.openPortal({
|
|
6265
|
+
* theme: 'default',
|
|
6266
|
+
* brokers: ['broker-1'],
|
|
6267
|
+
* email: 'user@example.com',
|
|
6268
|
+
* mode: 'dark'
|
|
6269
|
+
* },
|
|
5968
6270
|
* (userId) => console.log('User authenticated:', userId),
|
|
5969
6271
|
* (error) => console.error('Portal error:', error),
|
|
5970
6272
|
* () => console.log('Portal closed')
|
|
5971
6273
|
* );
|
|
5972
6274
|
* ```
|
|
5973
6275
|
*/
|
|
5974
|
-
openPortal(
|
|
5975
|
-
|
|
5976
|
-
|
|
5977
|
-
|
|
6276
|
+
openPortal(params?: {
|
|
6277
|
+
theme?: string | {
|
|
6278
|
+
preset?: string;
|
|
6279
|
+
custom?: Record<string, unknown>;
|
|
6280
|
+
};
|
|
6281
|
+
brokers?: string[];
|
|
6282
|
+
email?: string;
|
|
6283
|
+
mode?: 'light' | 'dark';
|
|
6284
|
+
}, onSuccess?: (userId: string) => void, onError?: (error: Error) => void, onClose?: () => void): Promise<void>;
|
|
5978
6285
|
/**
|
|
5979
6286
|
* Get current user ID (set after portal authentication).
|
|
5980
6287
|
*
|
|
@@ -6100,7 +6407,7 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
6100
6407
|
* print('Error:', result.error['message'])
|
|
6101
6408
|
* ```
|
|
6102
6409
|
*/
|
|
6103
|
-
getCompany(params
|
|
6410
|
+
getCompany(params: GetCompanyParams): Promise<Awaited<ReturnType<typeof this$1.company.getCompany>>>;
|
|
6104
6411
|
/**
|
|
6105
6412
|
* Get Brokers
|
|
6106
6413
|
*
|
|
@@ -6252,7 +6559,7 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
6252
6559
|
* print('Error:', result.error['message'])
|
|
6253
6560
|
* ```
|
|
6254
6561
|
*/
|
|
6255
|
-
disconnectCompanyFromBroker(params
|
|
6562
|
+
disconnectCompanyFromBroker(params: DisconnectCompanyFromBrokerParams): Promise<Awaited<ReturnType<typeof this$1.brokers.disconnectCompanyFromBroker>>>;
|
|
6256
6563
|
/**
|
|
6257
6564
|
* Get Orders
|
|
6258
6565
|
*
|
|
@@ -6330,7 +6637,7 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
6330
6637
|
* print('Error:', result.error['message'], result.error['code'])
|
|
6331
6638
|
* ```
|
|
6332
6639
|
*/
|
|
6333
|
-
getOrders(params?:
|
|
6640
|
+
getOrders(params?: GetOrdersParams): Promise<Awaited<ReturnType<typeof this$1.brokers.getOrders>>>;
|
|
6334
6641
|
/**
|
|
6335
6642
|
* Get Positions
|
|
6336
6643
|
*
|
|
@@ -6408,7 +6715,7 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
6408
6715
|
* print('Error:', result.error['message'], result.error['code'])
|
|
6409
6716
|
* ```
|
|
6410
6717
|
*/
|
|
6411
|
-
getPositions(params?:
|
|
6718
|
+
getPositions(params?: GetPositionsParams): Promise<Awaited<ReturnType<typeof this$1.brokers.getPositions>>>;
|
|
6412
6719
|
/**
|
|
6413
6720
|
* Get Balances
|
|
6414
6721
|
*
|
|
@@ -6486,7 +6793,7 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
6486
6793
|
* print('Error:', result.error['message'], result.error['code'])
|
|
6487
6794
|
* ```
|
|
6488
6795
|
*/
|
|
6489
|
-
getBalances(params?:
|
|
6796
|
+
getBalances(params?: GetBalancesParams): Promise<Awaited<ReturnType<typeof this$1.brokers.getBalances>>>;
|
|
6490
6797
|
/**
|
|
6491
6798
|
* Get Accounts
|
|
6492
6799
|
*
|
|
@@ -6564,7 +6871,7 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
6564
6871
|
* print('Error:', result.error['message'], result.error['code'])
|
|
6565
6872
|
* ```
|
|
6566
6873
|
*/
|
|
6567
|
-
getAccounts(params?:
|
|
6874
|
+
getAccounts(params?: GetAccountsParams): Promise<Awaited<ReturnType<typeof this$1.brokers.getAccounts>>>;
|
|
6568
6875
|
/**
|
|
6569
6876
|
* Get Order Fills
|
|
6570
6877
|
*
|
|
@@ -6650,7 +6957,7 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
6650
6957
|
* print('Error:', result.error['message'], result.error['code'])
|
|
6651
6958
|
* ```
|
|
6652
6959
|
*/
|
|
6653
|
-
getOrderFills(params
|
|
6960
|
+
getOrderFills(params: GetOrderFillsParams): Promise<Awaited<ReturnType<typeof this$1.brokers.getOrderFills>>>;
|
|
6654
6961
|
/**
|
|
6655
6962
|
* Get Order Events
|
|
6656
6963
|
*
|
|
@@ -6736,7 +7043,7 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
6736
7043
|
* print('Error:', result.error['message'], result.error['code'])
|
|
6737
7044
|
* ```
|
|
6738
7045
|
*/
|
|
6739
|
-
getOrderEvents(params
|
|
7046
|
+
getOrderEvents(params: GetOrderEventsParams): Promise<Awaited<ReturnType<typeof this$1.brokers.getOrderEvents>>>;
|
|
6740
7047
|
/**
|
|
6741
7048
|
* Get Order Groups
|
|
6742
7049
|
*
|
|
@@ -6813,7 +7120,7 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
6813
7120
|
* print('Error:', result.error['message'], result.error['code'])
|
|
6814
7121
|
* ```
|
|
6815
7122
|
*/
|
|
6816
|
-
getOrderGroups(params?:
|
|
7123
|
+
getOrderGroups(params?: GetOrderGroupsParams): Promise<Awaited<ReturnType<typeof this$1.brokers.getOrderGroups>>>;
|
|
6817
7124
|
/**
|
|
6818
7125
|
* Get Position Lots
|
|
6819
7126
|
*
|
|
@@ -6891,7 +7198,7 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
6891
7198
|
* print('Error:', result.error['message'], result.error['code'])
|
|
6892
7199
|
* ```
|
|
6893
7200
|
*/
|
|
6894
|
-
getPositionLots(params?:
|
|
7201
|
+
getPositionLots(params?: GetPositionLotsParams): Promise<Awaited<ReturnType<typeof this$1.brokers.getPositionLots>>>;
|
|
6895
7202
|
/**
|
|
6896
7203
|
* Get Position Lot Fills
|
|
6897
7204
|
*
|
|
@@ -6977,7 +7284,7 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
6977
7284
|
* print('Error:', result.error['message'], result.error['code'])
|
|
6978
7285
|
* ```
|
|
6979
7286
|
*/
|
|
6980
|
-
getPositionLotFills(params
|
|
7287
|
+
getPositionLotFills(params: GetPositionLotFillsParams): Promise<Awaited<ReturnType<typeof this$1.brokers.getPositionLotFills>>>;
|
|
6981
7288
|
/**
|
|
6982
7289
|
* Get all Orders across all pages.
|
|
6983
7290
|
* Auto-generated from paginated endpoint.
|
|
@@ -7544,5 +7851,5 @@ declare class FinaticConnect extends FinaticConnect$1 {
|
|
|
7544
7851
|
static readonly __CUSTOM_CLASS__ = true;
|
|
7545
7852
|
}
|
|
7546
7853
|
|
|
7547
|
-
export { AccountStatus, ApiError, BrokerDataAccountTypeEnum, BrokerDataAssetTypeEnum, BrokerDataOrderSideEnum,
|
|
7548
|
-
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, 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, 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 };
|
|
7854
|
+
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, 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 };
|
|
7855
|
+
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, 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 };
|