@finatic/client 0.9.9 → 0.9.10
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 +374 -580
- package/dist/index.js +259 -491
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +260 -492
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -2138,34 +2138,6 @@ declare enum FinaticBrokerFactoryBrokersRobinhoodExecutorsConsumerRobinhoodOrder
|
|
|
2138
2138
|
Close = "close"
|
|
2139
2139
|
}
|
|
2140
2140
|
|
|
2141
|
-
/**
|
|
2142
|
-
* Finatic FastAPI Backend
|
|
2143
|
-
* FinaticAPI REST API
|
|
2144
|
-
*
|
|
2145
|
-
* The version of the OpenAPI document: 1.0.0
|
|
2146
|
-
*
|
|
2147
|
-
*
|
|
2148
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
2149
|
-
* https://openapi-generator.tech
|
|
2150
|
-
* Do not edit the class manually.
|
|
2151
|
-
*/
|
|
2152
|
-
|
|
2153
|
-
/**
|
|
2154
|
-
* One leg within a spread for option orders. Used by order_option_spread() function. Matches the structure expected by the raw query params layer.
|
|
2155
|
-
*/
|
|
2156
|
-
interface FinaticBrokerFactoryBrokersRobinhoodExecutorsConsumerRobinhoodOrderPlaceQueryParamsRobinhoodOptionSpreadLeg {
|
|
2157
|
-
'expirationDate': string;
|
|
2158
|
-
'strikePrice': number;
|
|
2159
|
-
'optionType': BrokerDataOptionTypeEnum;
|
|
2160
|
-
'positionEffect': FinaticBrokerFactoryBrokersRobinhoodExecutorsConsumerRobinhoodOrderPlaceQueryParamsRobinhoodOptionSpreadLegPositionEffectEnum;
|
|
2161
|
-
'action': BrokerDataOrderSideEnum;
|
|
2162
|
-
'ratioQuantity'?: number;
|
|
2163
|
-
}
|
|
2164
|
-
declare enum FinaticBrokerFactoryBrokersRobinhoodExecutorsConsumerRobinhoodOrderPlaceQueryParamsRobinhoodOptionSpreadLegPositionEffectEnum {
|
|
2165
|
-
Open = "open",
|
|
2166
|
-
Close = "close"
|
|
2167
|
-
}
|
|
2168
|
-
|
|
2169
2141
|
/**
|
|
2170
2142
|
* Finatic FastAPI Backend
|
|
2171
2143
|
* FinaticAPI REST API
|
|
@@ -3158,13 +3130,49 @@ interface FinaticResponseOrderActionResult {
|
|
|
3158
3130
|
* Do not edit the class manually.
|
|
3159
3131
|
*/
|
|
3160
3132
|
/**
|
|
3161
|
-
*
|
|
3133
|
+
* Status of a session.
|
|
3162
3134
|
*/
|
|
3163
|
-
|
|
3135
|
+
declare enum SessionStatus {
|
|
3136
|
+
Pending = "pending",
|
|
3137
|
+
Authenticating = "authenticating",
|
|
3138
|
+
Active = "active",
|
|
3139
|
+
Completed = "completed",
|
|
3140
|
+
Expired = "expired"
|
|
3141
|
+
}
|
|
3142
|
+
|
|
3143
|
+
/**
|
|
3144
|
+
* Finatic FastAPI Backend
|
|
3145
|
+
* FinaticAPI REST API
|
|
3146
|
+
*
|
|
3147
|
+
* The version of the OpenAPI document: 1.0.0
|
|
3148
|
+
*
|
|
3149
|
+
*
|
|
3150
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
3151
|
+
* https://openapi-generator.tech
|
|
3152
|
+
* Do not edit the class manually.
|
|
3153
|
+
*/
|
|
3154
|
+
|
|
3155
|
+
/**
|
|
3156
|
+
* Response data for session operations.
|
|
3157
|
+
*/
|
|
3158
|
+
interface SessionResponseData {
|
|
3164
3159
|
/**
|
|
3165
|
-
*
|
|
3160
|
+
* Session ID
|
|
3166
3161
|
*/
|
|
3167
|
-
'
|
|
3162
|
+
'session_id': string;
|
|
3163
|
+
/**
|
|
3164
|
+
* Company ID
|
|
3165
|
+
*/
|
|
3166
|
+
'company_id': string;
|
|
3167
|
+
/**
|
|
3168
|
+
* Session status
|
|
3169
|
+
*/
|
|
3170
|
+
'status': SessionStatus;
|
|
3171
|
+
/**
|
|
3172
|
+
* Session expiration time
|
|
3173
|
+
*/
|
|
3174
|
+
'expires_at': string;
|
|
3175
|
+
'user_id'?: string | null;
|
|
3168
3176
|
}
|
|
3169
3177
|
|
|
3170
3178
|
/**
|
|
@@ -3179,9 +3187,9 @@ interface PortalUrlResponse {
|
|
|
3179
3187
|
* Do not edit the class manually.
|
|
3180
3188
|
*/
|
|
3181
3189
|
|
|
3182
|
-
interface
|
|
3190
|
+
interface SuccessPayloadSessionResponseData {
|
|
3183
3191
|
'_id'?: string;
|
|
3184
|
-
'data'?:
|
|
3192
|
+
'data'?: SessionResponseData | null;
|
|
3185
3193
|
'meta'?: {
|
|
3186
3194
|
[key: string]: any;
|
|
3187
3195
|
} | null;
|
|
@@ -3199,7 +3207,7 @@ interface SuccessPayloadPortalUrlResponse {
|
|
|
3199
3207
|
* Do not edit the class manually.
|
|
3200
3208
|
*/
|
|
3201
3209
|
|
|
3202
|
-
interface
|
|
3210
|
+
interface FinaticResponseSessionResponseData {
|
|
3203
3211
|
/**
|
|
3204
3212
|
* Request trace identifier for tracking and debugging. Auto-generated if not provided.
|
|
3205
3213
|
*/
|
|
@@ -3207,7 +3215,7 @@ interface FinaticapiCoreStandardModelsAbstractResponsesFinaticResponsePortalUrlR
|
|
|
3207
3215
|
/**
|
|
3208
3216
|
* Success payload containing data and optional meta
|
|
3209
3217
|
*/
|
|
3210
|
-
'success':
|
|
3218
|
+
'success': SuccessPayloadSessionResponseData;
|
|
3211
3219
|
'error'?: {
|
|
3212
3220
|
[key: string]: any;
|
|
3213
3221
|
} | null;
|
|
@@ -3228,49 +3236,13 @@ interface FinaticapiCoreStandardModelsAbstractResponsesFinaticResponsePortalUrlR
|
|
|
3228
3236
|
* Do not edit the class manually.
|
|
3229
3237
|
*/
|
|
3230
3238
|
/**
|
|
3231
|
-
*
|
|
3232
|
-
*/
|
|
3233
|
-
declare enum SessionStatus {
|
|
3234
|
-
Pending = "pending",
|
|
3235
|
-
Authenticating = "authenticating",
|
|
3236
|
-
Active = "active",
|
|
3237
|
-
Completed = "completed",
|
|
3238
|
-
Expired = "expired"
|
|
3239
|
-
}
|
|
3240
|
-
|
|
3241
|
-
/**
|
|
3242
|
-
* Finatic FastAPI Backend
|
|
3243
|
-
* FinaticAPI REST API
|
|
3244
|
-
*
|
|
3245
|
-
* The version of the OpenAPI document: 1.0.0
|
|
3246
|
-
*
|
|
3247
|
-
*
|
|
3248
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
3249
|
-
* https://openapi-generator.tech
|
|
3250
|
-
* Do not edit the class manually.
|
|
3251
|
-
*/
|
|
3252
|
-
|
|
3253
|
-
/**
|
|
3254
|
-
* Response data for session operations.
|
|
3239
|
+
* Response model for session user information.
|
|
3255
3240
|
*/
|
|
3256
|
-
interface
|
|
3257
|
-
/**
|
|
3258
|
-
* Session ID
|
|
3259
|
-
*/
|
|
3260
|
-
'session_id': string;
|
|
3261
|
-
/**
|
|
3262
|
-
* Company ID
|
|
3263
|
-
*/
|
|
3264
|
-
'company_id': string;
|
|
3265
|
-
/**
|
|
3266
|
-
* Session status
|
|
3267
|
-
*/
|
|
3268
|
-
'status': SessionStatus;
|
|
3241
|
+
interface SessionUserResponse {
|
|
3269
3242
|
/**
|
|
3270
|
-
*
|
|
3243
|
+
* User ID
|
|
3271
3244
|
*/
|
|
3272
|
-
'
|
|
3273
|
-
'user_id'?: string | null;
|
|
3245
|
+
'user_id': string;
|
|
3274
3246
|
}
|
|
3275
3247
|
|
|
3276
3248
|
/**
|
|
@@ -3285,9 +3257,9 @@ interface SessionResponseData {
|
|
|
3285
3257
|
* Do not edit the class manually.
|
|
3286
3258
|
*/
|
|
3287
3259
|
|
|
3288
|
-
interface
|
|
3260
|
+
interface SuccessPayloadSessionUserResponse {
|
|
3289
3261
|
'_id'?: string;
|
|
3290
|
-
'data'?:
|
|
3262
|
+
'data'?: SessionUserResponse | null;
|
|
3291
3263
|
'meta'?: {
|
|
3292
3264
|
[key: string]: any;
|
|
3293
3265
|
} | null;
|
|
@@ -3305,7 +3277,7 @@ interface SuccessPayloadSessionResponseData {
|
|
|
3305
3277
|
* Do not edit the class manually.
|
|
3306
3278
|
*/
|
|
3307
3279
|
|
|
3308
|
-
interface
|
|
3280
|
+
interface FinaticResponseSessionUserResponse {
|
|
3309
3281
|
/**
|
|
3310
3282
|
* Request trace identifier for tracking and debugging. Auto-generated if not provided.
|
|
3311
3283
|
*/
|
|
@@ -3313,7 +3285,7 @@ interface FinaticapiCoreStandardModelsAbstractResponsesFinaticResponseSessionRes
|
|
|
3313
3285
|
/**
|
|
3314
3286
|
* Success payload containing data and optional meta
|
|
3315
3287
|
*/
|
|
3316
|
-
'success':
|
|
3288
|
+
'success': SuccessPayloadSessionUserResponse;
|
|
3317
3289
|
'error'?: {
|
|
3318
3290
|
[key: string]: any;
|
|
3319
3291
|
} | null;
|
|
@@ -3334,13 +3306,13 @@ interface FinaticapiCoreStandardModelsAbstractResponsesFinaticResponseSessionRes
|
|
|
3334
3306
|
* Do not edit the class manually.
|
|
3335
3307
|
*/
|
|
3336
3308
|
/**
|
|
3337
|
-
* Response model for
|
|
3309
|
+
* Response model for portal URL.
|
|
3338
3310
|
*/
|
|
3339
|
-
interface
|
|
3311
|
+
interface PortalUrlResponse {
|
|
3340
3312
|
/**
|
|
3341
|
-
*
|
|
3313
|
+
* Portal URL with token
|
|
3342
3314
|
*/
|
|
3343
|
-
'
|
|
3315
|
+
'portal_url': string;
|
|
3344
3316
|
}
|
|
3345
3317
|
|
|
3346
3318
|
/**
|
|
@@ -3355,9 +3327,9 @@ interface SessionUserResponse {
|
|
|
3355
3327
|
* Do not edit the class manually.
|
|
3356
3328
|
*/
|
|
3357
3329
|
|
|
3358
|
-
interface
|
|
3330
|
+
interface SuccessPayloadPortalUrlResponse {
|
|
3359
3331
|
'_id'?: string;
|
|
3360
|
-
'data'?:
|
|
3332
|
+
'data'?: PortalUrlResponse | null;
|
|
3361
3333
|
'meta'?: {
|
|
3362
3334
|
[key: string]: any;
|
|
3363
3335
|
} | null;
|
|
@@ -3375,7 +3347,7 @@ interface SuccessPayloadSessionUserResponse {
|
|
|
3375
3347
|
* Do not edit the class manually.
|
|
3376
3348
|
*/
|
|
3377
3349
|
|
|
3378
|
-
interface
|
|
3350
|
+
interface FinaticapiCoreStandardModelsAbstractResponsesFinaticResponsePortalUrlResponse2 {
|
|
3379
3351
|
/**
|
|
3380
3352
|
* Request trace identifier for tracking and debugging. Auto-generated if not provided.
|
|
3381
3353
|
*/
|
|
@@ -3383,7 +3355,7 @@ interface FinaticapiCoreStandardModelsAbstractResponsesFinaticResponseSessionUse
|
|
|
3383
3355
|
/**
|
|
3384
3356
|
* Success payload containing data and optional meta
|
|
3385
3357
|
*/
|
|
3386
|
-
'success':
|
|
3358
|
+
'success': SuccessPayloadPortalUrlResponse;
|
|
3387
3359
|
'error'?: {
|
|
3388
3360
|
[key: string]: any;
|
|
3389
3361
|
} | null;
|
|
@@ -4655,6 +4627,34 @@ declare enum NinjaTraderOrderPlaceRequestBrokerEnum {
|
|
|
4655
4627
|
NinjaTrader = "ninja_trader"
|
|
4656
4628
|
}
|
|
4657
4629
|
|
|
4630
|
+
/**
|
|
4631
|
+
* Finatic FastAPI Backend
|
|
4632
|
+
* FinaticAPI REST API
|
|
4633
|
+
*
|
|
4634
|
+
* The version of the OpenAPI document: 1.0.0
|
|
4635
|
+
*
|
|
4636
|
+
*
|
|
4637
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
4638
|
+
* https://openapi-generator.tech
|
|
4639
|
+
* Do not edit the class manually.
|
|
4640
|
+
*/
|
|
4641
|
+
|
|
4642
|
+
/**
|
|
4643
|
+
* One leg within a spread for option orders. Used by order_option_spread() function. Matches the structure expected by the raw query params layer.
|
|
4644
|
+
*/
|
|
4645
|
+
interface RobinhoodOptionSpreadLeg {
|
|
4646
|
+
'expirationDate': string;
|
|
4647
|
+
'strikePrice': number;
|
|
4648
|
+
'optionType': BrokerDataOptionTypeEnum;
|
|
4649
|
+
'positionEffect': RobinhoodOptionSpreadLegPositionEffectEnum;
|
|
4650
|
+
'action': BrokerDataOrderSideEnum;
|
|
4651
|
+
'ratioQuantity'?: number;
|
|
4652
|
+
}
|
|
4653
|
+
declare enum RobinhoodOptionSpreadLegPositionEffectEnum {
|
|
4654
|
+
Open = "open",
|
|
4655
|
+
Close = "close"
|
|
4656
|
+
}
|
|
4657
|
+
|
|
4658
4658
|
/**
|
|
4659
4659
|
* Finatic FastAPI Backend
|
|
4660
4660
|
* FinaticAPI REST API
|
|
@@ -4687,7 +4687,7 @@ interface Order1 {
|
|
|
4687
4687
|
'stopPrice': number;
|
|
4688
4688
|
'limitPrice': number;
|
|
4689
4689
|
'direction'?: Order1DirectionEnum;
|
|
4690
|
-
'spread'?: Array<
|
|
4690
|
+
'spread'?: Array<RobinhoodOptionSpreadLeg>;
|
|
4691
4691
|
'positionEffect'?: Order1PositionEffectEnum;
|
|
4692
4692
|
'creditOrDebit'?: Order1CreditOrDebitEnum;
|
|
4693
4693
|
'expirationDate'?: string;
|
|
@@ -5038,7 +5038,7 @@ interface RobinhoodOptionLimitOrderPlaceQueryParams {
|
|
|
5038
5038
|
'orderQty': number;
|
|
5039
5039
|
'price': number;
|
|
5040
5040
|
'direction'?: RobinhoodOptionLimitOrderPlaceQueryParamsDirectionEnum | null;
|
|
5041
|
-
'spread'?: Array<
|
|
5041
|
+
'spread'?: Array<RobinhoodOptionSpreadLeg> | null;
|
|
5042
5042
|
'positionEffect'?: RobinhoodOptionLimitOrderPlaceQueryParamsPositionEffectEnum | null;
|
|
5043
5043
|
'creditOrDebit'?: RobinhoodOptionLimitOrderPlaceQueryParamsCreditOrDebitEnum | null;
|
|
5044
5044
|
'expirationDate'?: string | null;
|
|
@@ -5098,7 +5098,7 @@ interface RobinhoodOptionMarketOrderPlaceQueryParams {
|
|
|
5098
5098
|
'symbol': string;
|
|
5099
5099
|
'orderQty': number;
|
|
5100
5100
|
'direction'?: RobinhoodOptionMarketOrderPlaceQueryParamsDirectionEnum | null;
|
|
5101
|
-
'spread'?: Array<
|
|
5101
|
+
'spread'?: Array<RobinhoodOptionSpreadLeg> | null;
|
|
5102
5102
|
'positionEffect'?: RobinhoodOptionMarketOrderPlaceQueryParamsPositionEffectEnum | null;
|
|
5103
5103
|
'creditOrDebit'?: RobinhoodOptionMarketOrderPlaceQueryParamsCreditOrDebitEnum | null;
|
|
5104
5104
|
'expirationDate'?: string | null;
|
|
@@ -5160,7 +5160,7 @@ interface RobinhoodOptionStopLimitOrderPlaceQueryParams {
|
|
|
5160
5160
|
'stopPrice': number;
|
|
5161
5161
|
'limitPrice': number;
|
|
5162
5162
|
'direction'?: RobinhoodOptionStopLimitOrderPlaceQueryParamsDirectionEnum | null;
|
|
5163
|
-
'spread'?: Array<
|
|
5163
|
+
'spread'?: Array<RobinhoodOptionSpreadLeg> | null;
|
|
5164
5164
|
'positionEffect'?: RobinhoodOptionStopLimitOrderPlaceQueryParamsPositionEffectEnum | null;
|
|
5165
5165
|
'creditOrDebit'?: RobinhoodOptionStopLimitOrderPlaceQueryParamsCreditOrDebitEnum | null;
|
|
5166
5166
|
'expirationDate'?: string | null;
|
|
@@ -5221,7 +5221,7 @@ interface RobinhoodOptionStopOrderPlaceQueryParams {
|
|
|
5221
5221
|
'orderQty': number;
|
|
5222
5222
|
'stopPrice': number;
|
|
5223
5223
|
'direction'?: RobinhoodOptionStopOrderPlaceQueryParamsDirectionEnum | null;
|
|
5224
|
-
'spread'?: Array<
|
|
5224
|
+
'spread'?: Array<RobinhoodOptionSpreadLeg> | null;
|
|
5225
5225
|
'positionEffect'?: RobinhoodOptionStopOrderPlaceQueryParamsPositionEffectEnum | null;
|
|
5226
5226
|
'creditOrDebit'?: RobinhoodOptionStopOrderPlaceQueryParamsCreditOrDebitEnum | null;
|
|
5227
5227
|
'expirationDate'?: string | null;
|
|
@@ -5282,7 +5282,7 @@ interface RobinhoodOptionTrailingStopOrderPlaceQueryParams {
|
|
|
5282
5282
|
'orderQty': number;
|
|
5283
5283
|
'stopPrice': number;
|
|
5284
5284
|
'direction'?: RobinhoodOptionTrailingStopOrderPlaceQueryParamsDirectionEnum | null;
|
|
5285
|
-
'spread'?: Array<
|
|
5285
|
+
'spread'?: Array<RobinhoodOptionSpreadLeg> | null;
|
|
5286
5286
|
'positionEffect'?: RobinhoodOptionTrailingStopOrderPlaceQueryParamsPositionEffectEnum | null;
|
|
5287
5287
|
'creditOrDebit'?: RobinhoodOptionTrailingStopOrderPlaceQueryParamsCreditOrDebitEnum | null;
|
|
5288
5288
|
'expirationDate'?: string | null;
|
|
@@ -5937,7 +5937,7 @@ interface SessionStartRequest {
|
|
|
5937
5937
|
*/
|
|
5938
5938
|
interface BrokersApiInterface {
|
|
5939
5939
|
/**
|
|
5940
|
-
* Cancel an existing order.
|
|
5940
|
+
* Cancel an existing order. Cancels an order by its order ID. The broker connection is automatically resolved from the order record.
|
|
5941
5941
|
* @summary Cancel Order
|
|
5942
5942
|
* @param {BrokersApiCancelOrderApiBetaBrokersOrdersOrderIdDeleteRequest} requestParameters Request parameters.
|
|
5943
5943
|
* @param {*} [options] Override http request option.
|
|
@@ -6047,7 +6047,7 @@ interface BrokersApiInterface {
|
|
|
6047
6047
|
*/
|
|
6048
6048
|
listBrokerConnectionsApiBetaBrokersConnectionsGet(options?: RawAxiosRequestConfig): AxiosPromise<FinaticResponseListUserBrokerConnectionWithPermissions>;
|
|
6049
6049
|
/**
|
|
6050
|
-
* Modify an existing order.
|
|
6050
|
+
* Modify an existing order. Updates an order\'s parameters (price, quantity, etc.) by order ID. The order structure follows the same pattern as placing orders, with common fields shared across brokers and broker-specific fields available per broker.
|
|
6051
6051
|
* @summary Modify Order
|
|
6052
6052
|
* @param {BrokersApiModifyOrderApiBetaBrokersOrdersOrderIdPatchRequest} requestParameters Request parameters.
|
|
6053
6053
|
* @param {*} [options] Override http request option.
|
|
@@ -6055,7 +6055,7 @@ interface BrokersApiInterface {
|
|
|
6055
6055
|
*/
|
|
6056
6056
|
modifyOrderApiBetaBrokersOrdersOrderIdPatch(requestParameters: BrokersApiModifyOrderApiBetaBrokersOrdersOrderIdPatchRequest, options?: RawAxiosRequestConfig): AxiosPromise<FinaticResponseOrderActionResult>;
|
|
6057
6057
|
/**
|
|
6058
|
-
*
|
|
6058
|
+
* Place a new order through the specified broker. Creates an order using the broker connection associated with your account. The order structure includes common fields (symbol, quantity, order type, etc.) shared across all brokers, plus broker-specific fields that vary by broker. Common order fields include: broker, accountNumber, orderType, assetType, action, timeInForce, symbol, and orderQty. Additional broker-specific fields can be included in the order object - see the broker-specific tabs in the parameters section for details.
|
|
6059
6059
|
* @summary Place Order
|
|
6060
6060
|
* @param {BrokersApiPlaceOrderApiBetaBrokersOrdersPostRequest} requestParameters Request parameters.
|
|
6061
6061
|
* @param {*} [options] Override http request option.
|
|
@@ -6472,7 +6472,7 @@ interface BrokersApiPlaceOrderApiBetaBrokersOrdersPostRequest {
|
|
|
6472
6472
|
*/
|
|
6473
6473
|
declare class BrokersApi extends BaseAPI implements BrokersApiInterface {
|
|
6474
6474
|
/**
|
|
6475
|
-
* Cancel an existing order.
|
|
6475
|
+
* Cancel an existing order. Cancels an order by its order ID. The broker connection is automatically resolved from the order record.
|
|
6476
6476
|
* @summary Cancel Order
|
|
6477
6477
|
* @param {BrokersApiCancelOrderApiBetaBrokersOrdersOrderIdDeleteRequest} requestParameters Request parameters.
|
|
6478
6478
|
* @param {*} [options] Override http request option.
|
|
@@ -6582,7 +6582,7 @@ declare class BrokersApi extends BaseAPI implements BrokersApiInterface {
|
|
|
6582
6582
|
*/
|
|
6583
6583
|
listBrokerConnectionsApiBetaBrokersConnectionsGet(options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<FinaticResponseListUserBrokerConnectionWithPermissions, any, {}>>;
|
|
6584
6584
|
/**
|
|
6585
|
-
* Modify an existing order.
|
|
6585
|
+
* Modify an existing order. Updates an order\'s parameters (price, quantity, etc.) by order ID. The order structure follows the same pattern as placing orders, with common fields shared across brokers and broker-specific fields available per broker.
|
|
6586
6586
|
* @summary Modify Order
|
|
6587
6587
|
* @param {BrokersApiModifyOrderApiBetaBrokersOrdersOrderIdPatchRequest} requestParameters Request parameters.
|
|
6588
6588
|
* @param {*} [options] Override http request option.
|
|
@@ -6590,7 +6590,7 @@ declare class BrokersApi extends BaseAPI implements BrokersApiInterface {
|
|
|
6590
6590
|
*/
|
|
6591
6591
|
modifyOrderApiBetaBrokersOrdersOrderIdPatch(requestParameters: BrokersApiModifyOrderApiBetaBrokersOrdersOrderIdPatchRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<FinaticResponseOrderActionResult, any, {}>>;
|
|
6592
6592
|
/**
|
|
6593
|
-
*
|
|
6593
|
+
* Place a new order through the specified broker. Creates an order using the broker connection associated with your account. The order structure includes common fields (symbol, quantity, order type, etc.) shared across all brokers, plus broker-specific fields that vary by broker. Common order fields include: broker, accountNumber, orderType, assetType, action, timeInForce, symbol, and orderQty. Additional broker-specific fields can be included in the order object - see the broker-specific tabs in the parameters section for details.
|
|
6594
6594
|
* @summary Place Order
|
|
6595
6595
|
* @param {BrokersApiPlaceOrderApiBetaBrokersOrdersPostRequest} requestParameters Request parameters.
|
|
6596
6596
|
* @param {*} [options] Override http request option.
|
|
@@ -7081,10 +7081,25 @@ interface GetPositionLotFillsParams {
|
|
|
7081
7081
|
offset?: number;
|
|
7082
7082
|
}
|
|
7083
7083
|
interface PlaceOrderParams {
|
|
7084
|
-
/** Broker
|
|
7085
|
-
|
|
7086
|
-
/**
|
|
7087
|
-
|
|
7084
|
+
/** Broker identifier (robinhood, tasty_trade, ninja_trader) */
|
|
7085
|
+
broker: string;
|
|
7086
|
+
/** Account number for the order */
|
|
7087
|
+
accountNumber: number;
|
|
7088
|
+
/** Order details including required and optional fields */
|
|
7089
|
+
order: {
|
|
7090
|
+
/** Type of order (market, limit, etc.) */
|
|
7091
|
+
orderType: string;
|
|
7092
|
+
/** Type of asset (equity, equity_option, crypto, forex) */
|
|
7093
|
+
assetType: string;
|
|
7094
|
+
/** Order action (buy, sell) */
|
|
7095
|
+
action: string;
|
|
7096
|
+
/** Time in force for the order */
|
|
7097
|
+
timeInForce: string;
|
|
7098
|
+
/** Trading symbol */
|
|
7099
|
+
symbol: string;
|
|
7100
|
+
/** Order quantity */
|
|
7101
|
+
orderQty: number;
|
|
7102
|
+
};
|
|
7088
7103
|
}
|
|
7089
7104
|
interface CancelOrderParams {
|
|
7090
7105
|
/** Order ID */
|
|
@@ -7093,12 +7108,25 @@ interface CancelOrderParams {
|
|
|
7093
7108
|
interface ModifyOrderParams {
|
|
7094
7109
|
/** Order ID */
|
|
7095
7110
|
orderId: string;
|
|
7096
|
-
/** Broker
|
|
7097
|
-
|
|
7098
|
-
/** Account number
|
|
7099
|
-
accountNumber
|
|
7100
|
-
/**
|
|
7101
|
-
|
|
7111
|
+
/** Broker identifier (robinhood, tasty_trade, ninja_trader) */
|
|
7112
|
+
broker: string;
|
|
7113
|
+
/** Account number for the order */
|
|
7114
|
+
accountNumber: number;
|
|
7115
|
+
/** Order details including required and optional fields */
|
|
7116
|
+
order: {
|
|
7117
|
+
/** Type of order (market, limit, etc.) */
|
|
7118
|
+
orderType: string;
|
|
7119
|
+
/** Type of asset (equity, equity_option, crypto, forex) */
|
|
7120
|
+
assetType: string;
|
|
7121
|
+
/** Order action (buy, sell) */
|
|
7122
|
+
action: string;
|
|
7123
|
+
/** Time in force for the order */
|
|
7124
|
+
timeInForce: string;
|
|
7125
|
+
/** Trading symbol */
|
|
7126
|
+
symbol: string;
|
|
7127
|
+
/** Order quantity */
|
|
7128
|
+
orderQty: number;
|
|
7129
|
+
};
|
|
7102
7130
|
}
|
|
7103
7131
|
/**
|
|
7104
7132
|
* Brokers wrapper functions.
|
|
@@ -7152,9 +7180,9 @@ declare class BrokersWrapper {
|
|
|
7152
7180
|
* ```typescript-client
|
|
7153
7181
|
* // Full example with optional parameters
|
|
7154
7182
|
* const result = await finatic.getBalances({
|
|
7155
|
-
brokerId: '
|
|
7156
|
-
connectionId: '
|
|
7157
|
-
accountId: '
|
|
7183
|
+
brokerId: 'example-id',
|
|
7184
|
+
connectionId: 'example-id',
|
|
7185
|
+
accountId: 'example-id'
|
|
7158
7186
|
* });
|
|
7159
7187
|
*
|
|
7160
7188
|
* // Handle response with warnings
|
|
@@ -7202,8 +7230,8 @@ declare class BrokersWrapper {
|
|
|
7202
7230
|
* ```typescript-client
|
|
7203
7231
|
* // Full example with optional parameters
|
|
7204
7232
|
* const result = await finatic.getAccounts({
|
|
7205
|
-
brokerId: '
|
|
7206
|
-
connectionId: '
|
|
7233
|
+
brokerId: 'example-id',
|
|
7234
|
+
connectionId: 'example-id',
|
|
7207
7235
|
accountType: 'margin'
|
|
7208
7236
|
* });
|
|
7209
7237
|
*
|
|
@@ -7292,7 +7320,7 @@ declare class BrokersWrapper {
|
|
|
7292
7320
|
* ```typescript-client
|
|
7293
7321
|
* // Minimal example with required parameters only
|
|
7294
7322
|
* const result = await finatic.disconnectCompanyFromBroker({
|
|
7295
|
-
connectionId: '
|
|
7323
|
+
connectionId: 'example-id'
|
|
7296
7324
|
* });
|
|
7297
7325
|
*
|
|
7298
7326
|
* // Access the response data
|
|
@@ -7342,9 +7370,9 @@ declare class BrokersWrapper {
|
|
|
7342
7370
|
* ```typescript-client
|
|
7343
7371
|
* // Full example with optional parameters
|
|
7344
7372
|
* const result = await finatic.getOrders({
|
|
7345
|
-
brokerId: '
|
|
7346
|
-
connectionId: '
|
|
7347
|
-
accountId: '
|
|
7373
|
+
brokerId: 'example-id',
|
|
7374
|
+
connectionId: 'example-id',
|
|
7375
|
+
accountId: 'example-id'
|
|
7348
7376
|
* });
|
|
7349
7377
|
*
|
|
7350
7378
|
* // Handle response with warnings
|
|
@@ -7397,9 +7425,9 @@ declare class BrokersWrapper {
|
|
|
7397
7425
|
* ```typescript-client
|
|
7398
7426
|
* // Full example with optional parameters
|
|
7399
7427
|
* const result = await finatic.getPositions({
|
|
7400
|
-
brokerId: '
|
|
7401
|
-
connectionId: '
|
|
7402
|
-
accountId: '
|
|
7428
|
+
brokerId: 'example-id',
|
|
7429
|
+
connectionId: 'example-id',
|
|
7430
|
+
accountId: 'example-id'
|
|
7403
7431
|
* });
|
|
7404
7432
|
*
|
|
7405
7433
|
* // Handle response with warnings
|
|
@@ -7450,9 +7478,9 @@ declare class BrokersWrapper {
|
|
|
7450
7478
|
* ```typescript-client
|
|
7451
7479
|
* // Full example with optional parameters
|
|
7452
7480
|
* const result = await finatic.getTransactions({
|
|
7453
|
-
brokerId: '
|
|
7454
|
-
connectionId: '
|
|
7455
|
-
accountId: '
|
|
7481
|
+
brokerId: 'example-id',
|
|
7482
|
+
connectionId: 'example-id',
|
|
7483
|
+
accountId: 'example-id'
|
|
7456
7484
|
* });
|
|
7457
7485
|
*
|
|
7458
7486
|
* // Handle response with warnings
|
|
@@ -7487,7 +7515,7 @@ declare class BrokersWrapper {
|
|
|
7487
7515
|
* ```typescript-client
|
|
7488
7516
|
* // Minimal example with required parameters only
|
|
7489
7517
|
* const result = await finatic.getOrderFills({
|
|
7490
|
-
orderId: '
|
|
7518
|
+
orderId: 'example-id'
|
|
7491
7519
|
* });
|
|
7492
7520
|
*
|
|
7493
7521
|
* // Access the response data
|
|
@@ -7501,9 +7529,9 @@ declare class BrokersWrapper {
|
|
|
7501
7529
|
* ```typescript-client
|
|
7502
7530
|
* // Full example with optional parameters
|
|
7503
7531
|
* const result = await finatic.getOrderFills({
|
|
7504
|
-
orderId: '
|
|
7505
|
-
connectionId: '
|
|
7506
|
-
limit:
|
|
7532
|
+
orderId: 'example-id',
|
|
7533
|
+
connectionId: 'example-id',
|
|
7534
|
+
limit: 0,
|
|
7507
7535
|
offset: 0
|
|
7508
7536
|
* });
|
|
7509
7537
|
*
|
|
@@ -7539,7 +7567,7 @@ declare class BrokersWrapper {
|
|
|
7539
7567
|
* ```typescript-client
|
|
7540
7568
|
* // Minimal example with required parameters only
|
|
7541
7569
|
* const result = await finatic.getOrderEvents({
|
|
7542
|
-
orderId: '
|
|
7570
|
+
orderId: 'example-id'
|
|
7543
7571
|
* });
|
|
7544
7572
|
*
|
|
7545
7573
|
* // Access the response data
|
|
@@ -7553,9 +7581,9 @@ declare class BrokersWrapper {
|
|
|
7553
7581
|
* ```typescript-client
|
|
7554
7582
|
* // Full example with optional parameters
|
|
7555
7583
|
* const result = await finatic.getOrderEvents({
|
|
7556
|
-
orderId: '
|
|
7557
|
-
connectionId: '
|
|
7558
|
-
limit:
|
|
7584
|
+
orderId: 'example-id',
|
|
7585
|
+
connectionId: 'example-id',
|
|
7586
|
+
limit: 0,
|
|
7559
7587
|
offset: 0
|
|
7560
7588
|
* });
|
|
7561
7589
|
*
|
|
@@ -7603,9 +7631,9 @@ declare class BrokersWrapper {
|
|
|
7603
7631
|
* ```typescript-client
|
|
7604
7632
|
* // Full example with optional parameters
|
|
7605
7633
|
* const result = await finatic.getOrderGroups({
|
|
7606
|
-
brokerId: '
|
|
7607
|
-
connectionId: '
|
|
7608
|
-
limit:
|
|
7634
|
+
brokerId: 'example-id',
|
|
7635
|
+
connectionId: 'example-id',
|
|
7636
|
+
limit: 0
|
|
7609
7637
|
* });
|
|
7610
7638
|
*
|
|
7611
7639
|
* // Handle response with warnings
|
|
@@ -7653,9 +7681,9 @@ declare class BrokersWrapper {
|
|
|
7653
7681
|
* ```typescript-client
|
|
7654
7682
|
* // Full example with optional parameters
|
|
7655
7683
|
* const result = await finatic.getPositionLots({
|
|
7656
|
-
brokerId: '
|
|
7657
|
-
connectionId: '
|
|
7658
|
-
accountId: '
|
|
7684
|
+
brokerId: 'example-id',
|
|
7685
|
+
connectionId: 'example-id',
|
|
7686
|
+
accountId: 'example-id'
|
|
7659
7687
|
* });
|
|
7660
7688
|
*
|
|
7661
7689
|
* // Handle response with warnings
|
|
@@ -7689,7 +7717,7 @@ declare class BrokersWrapper {
|
|
|
7689
7717
|
* ```typescript-client
|
|
7690
7718
|
* // Minimal example with required parameters only
|
|
7691
7719
|
* const result = await finatic.getPositionLotFills({
|
|
7692
|
-
lotId: '
|
|
7720
|
+
lotId: 'example-id'
|
|
7693
7721
|
* });
|
|
7694
7722
|
*
|
|
7695
7723
|
* // Access the response data
|
|
@@ -7703,9 +7731,9 @@ declare class BrokersWrapper {
|
|
|
7703
7731
|
* ```typescript-client
|
|
7704
7732
|
* // Full example with optional parameters
|
|
7705
7733
|
* const result = await finatic.getPositionLotFills({
|
|
7706
|
-
lotId: '
|
|
7707
|
-
connectionId: '
|
|
7708
|
-
limit:
|
|
7734
|
+
lotId: 'example-id',
|
|
7735
|
+
connectionId: 'example-id',
|
|
7736
|
+
limit: 0,
|
|
7709
7737
|
offset: 0
|
|
7710
7738
|
* });
|
|
7711
7739
|
*
|
|
@@ -7724,62 +7752,24 @@ declare class BrokersWrapper {
|
|
|
7724
7752
|
/**
|
|
7725
7753
|
* Place Order
|
|
7726
7754
|
*
|
|
7727
|
-
*
|
|
7728
|
-
*
|
|
7729
|
-
*
|
|
7730
|
-
*
|
|
7731
|
-
*
|
|
7732
|
-
*
|
|
7733
|
-
*
|
|
7734
|
-
*
|
|
7735
|
-
*
|
|
7736
|
-
*
|
|
7737
|
-
*
|
|
7738
|
-
*
|
|
7739
|
-
*
|
|
7740
|
-
*
|
|
7741
|
-
*
|
|
7742
|
-
*
|
|
7743
|
-
*
|
|
7744
|
-
*
|
|
7745
|
-
* - ``order_qty``
|
|
7746
|
-
*
|
|
7747
|
-
* They are surfaced as *query* parameters **only to make the accepted fields
|
|
7748
|
-
* obvious in the interactive docs**. In production usage you should send these
|
|
7749
|
-
* fields inside the JSON body (see ``order_request``) so that the entire order
|
|
7750
|
-
* specification travels in one payload. (Nothing will break if you send both, but there is no need to do so.)
|
|
7751
|
-
*
|
|
7752
|
-
* Body payload & broker-specific extras
|
|
7753
|
-
* -------------------------------------
|
|
7754
|
-
*
|
|
7755
|
-
* Put the standard parameters plus any broker-specific extensions under the
|
|
7756
|
-
* ``order`` key of the body. Refer to the bundled OpenAPI examples below to
|
|
7757
|
-
* see complete payloads for common order types (market, limit, spreads, etc.)
|
|
7758
|
-
* across supported brokers.
|
|
7759
|
-
*
|
|
7760
|
-
* For a formal reference of broker-specific extensions inspect the
|
|
7761
|
-
* ``BrokerOrderPlaceExtras`` schema.
|
|
7762
|
-
*
|
|
7763
|
-
* The endpoint resolves the active ``user_broker_connection`` by calling the
|
|
7764
|
-
* ``get_user_broker_connection_ids_for_broker`` RPC in Supabase. If no active
|
|
7765
|
-
* connection exists it returns a list of *available* brokers so your client
|
|
7766
|
-
* can guide the user accordingly.
|
|
7767
|
-
*
|
|
7768
|
-
* Broker Notes
|
|
7769
|
-
* ------------
|
|
7770
|
-
* - The responses that you get back from the broker are not always the same.
|
|
7771
|
-
* The response models are validated for each broker, but we do not standardize the repsonses.
|
|
7772
|
-
*
|
|
7773
|
-
* - Tasty Trade: If you want to trade options for a particular stock, first fetch the full
|
|
7774
|
-
* option chain via the GET https://api.tastyworks.com/option-chains/{stock_symbol}/nested endpoint.
|
|
7775
|
-
* This endpoint returns all available expirations that tastytrade offers for that equity symbol.
|
|
7776
|
-
* Each expiration contains a list of strikes, where each strike has a call and put field representing
|
|
7777
|
-
* the call symbol and put symbol respectively.
|
|
7778
|
-
*
|
|
7779
|
-
* We are planning to add a new endpoint to fetch the option chain for a particular stock and
|
|
7780
|
-
* handle this logic for you, but for now you need to fetch the option chain manually.
|
|
7781
|
-
* @param params.body {PlaceOrderApiBetaBrokersOrdersPostRequest} (optional) Broker-specific extra parameters object. This is used to pass in broker-specific fields if you want to send a reqeust to a broker API with the parameters that EXTEND our standardized query parameters.
|
|
7782
|
-
* @param params.connectionId {string} (optional) Temporary bypass for testing: specify connection ID directly
|
|
7755
|
+
* Place a new order through the specified broker.
|
|
7756
|
+
*
|
|
7757
|
+
* Creates an order using the broker connection associated with your account.
|
|
7758
|
+
* The order structure includes common fields (symbol, quantity, order type, etc.)
|
|
7759
|
+
* shared across all brokers, plus broker-specific fields that vary by broker.
|
|
7760
|
+
*
|
|
7761
|
+
* Common order fields include: broker, accountNumber, orderType, assetType,
|
|
7762
|
+
* action, timeInForce, symbol, and orderQty. Additional broker-specific fields
|
|
7763
|
+
* can be included in the order object - see the broker-specific tabs in the
|
|
7764
|
+
* parameters section for details.
|
|
7765
|
+
* @param params.broker {string} Broker identifier (robinhood, tasty_trade, ninja_trader)
|
|
7766
|
+
* @param params.accountNumber {number} Account number for the order
|
|
7767
|
+
* @param params.order.orderType {string} Type of order (market, limit, etc.)
|
|
7768
|
+
* @param params.order.assetType {string} Type of asset (equity, equity_option, crypto, forex)
|
|
7769
|
+
* @param params.order.action {string} Order action (buy, sell)
|
|
7770
|
+
* @param params.order.timeInForce {string} Time in force for the order
|
|
7771
|
+
* @param params.order.symbol {string} Trading symbol
|
|
7772
|
+
* @param params.order.orderQty {number} Order quantity
|
|
7783
7773
|
* @returns {Promise<FinaticResponse<OrderActionResult>>} Standard response with success/Error/Warning structure
|
|
7784
7774
|
*
|
|
7785
7775
|
* Generated from: POST /api/beta/brokers/orders
|
|
@@ -7787,43 +7777,35 @@ declare class BrokersWrapper {
|
|
|
7787
7777
|
* @category brokers
|
|
7788
7778
|
* @example
|
|
7789
7779
|
* ```typescript-client
|
|
7790
|
-
* //
|
|
7791
|
-
* const result = await finatic.placeOrder({});
|
|
7792
|
-
*
|
|
7793
|
-
* // Access the response data
|
|
7794
|
-
* if (result.success) {
|
|
7795
|
-
* console.log('Data:', result.success.data);
|
|
7796
|
-
* }
|
|
7797
|
-
* ```
|
|
7798
|
-
* @example
|
|
7799
|
-
* ```typescript-client
|
|
7800
|
-
* // Full example with optional parameters
|
|
7780
|
+
* // This method requires broker and order with required fields:
|
|
7801
7781
|
* const result = await finatic.placeOrder({
|
|
7802
|
-
|
|
7782
|
+
broker: 'robinhood',
|
|
7783
|
+
order: {
|
|
7784
|
+
orderType: 'market',
|
|
7785
|
+
assetType: 'equity',
|
|
7786
|
+
action: 'buy',
|
|
7787
|
+
timeInForce: 'day',
|
|
7788
|
+
symbol: 'AAPL',
|
|
7789
|
+
orderQty: 10
|
|
7790
|
+
}
|
|
7803
7791
|
* });
|
|
7804
7792
|
*
|
|
7805
|
-
* //
|
|
7793
|
+
* // Access the response data
|
|
7806
7794
|
* if (result.success) {
|
|
7807
7795
|
* console.log('Data:', result.success.data);
|
|
7808
|
-
* if (result.warning && result.warning.length > 0) {
|
|
7809
|
-
* console.warn('Warnings:', result.warning);
|
|
7810
|
-
* }
|
|
7811
7796
|
* } else if (result.error) {
|
|
7812
|
-
* console.error('Error:', result.error.message
|
|
7797
|
+
* console.error('Error:', result.error.message);
|
|
7813
7798
|
* }
|
|
7814
7799
|
* ```
|
|
7815
7800
|
*/
|
|
7816
|
-
placeOrder(params
|
|
7801
|
+
placeOrder(params: PlaceOrderParams): Promise<FinaticResponse$2<OrderActionResult>>;
|
|
7817
7802
|
/**
|
|
7818
7803
|
* Cancel Order
|
|
7819
7804
|
*
|
|
7820
7805
|
* Cancel an existing order.
|
|
7821
7806
|
*
|
|
7822
|
-
*
|
|
7823
|
-
*
|
|
7824
|
-
*
|
|
7825
|
-
* The order_id is used to identify the order and automatically resolve the
|
|
7826
|
-
* broker connection from the orders table.
|
|
7807
|
+
* Cancels an order by its order ID. The broker connection is automatically
|
|
7808
|
+
* resolved from the order record.
|
|
7827
7809
|
* @param params.orderId {string} Order ID
|
|
7828
7810
|
* @returns {Promise<FinaticResponse<OrderActionResult>>} Standard response with success/Error/Warning structure
|
|
7829
7811
|
*
|
|
@@ -7834,7 +7816,7 @@ declare class BrokersWrapper {
|
|
|
7834
7816
|
* ```typescript-client
|
|
7835
7817
|
* // Minimal example with required parameters only
|
|
7836
7818
|
* const result = await finatic.cancelOrder({
|
|
7837
|
-
orderId: '
|
|
7819
|
+
orderId: 'example-id'
|
|
7838
7820
|
* });
|
|
7839
7821
|
*
|
|
7840
7822
|
* // Access the response data
|
|
@@ -7851,12 +7833,18 @@ declare class BrokersWrapper {
|
|
|
7851
7833
|
*
|
|
7852
7834
|
* Modify an existing order.
|
|
7853
7835
|
*
|
|
7854
|
-
*
|
|
7855
|
-
*
|
|
7836
|
+
* Updates an order's parameters (price, quantity, etc.) by order ID.
|
|
7837
|
+
* The order structure follows the same pattern as placing orders, with common
|
|
7838
|
+
* fields shared across brokers and broker-specific fields available per broker.
|
|
7856
7839
|
* @param params.orderId {string} Order ID
|
|
7857
|
-
* @param params.
|
|
7858
|
-
* @param params.accountNumber {
|
|
7859
|
-
* @param params.
|
|
7840
|
+
* @param params.broker {string} Broker identifier (robinhood, tasty_trade, ninja_trader)
|
|
7841
|
+
* @param params.accountNumber {number} Account number for the order
|
|
7842
|
+
* @param params.order.orderType {string} Type of order (market, limit, etc.)
|
|
7843
|
+
* @param params.order.assetType {string} Type of asset (equity, equity_option, crypto, forex)
|
|
7844
|
+
* @param params.order.action {string} Order action (buy, sell)
|
|
7845
|
+
* @param params.order.timeInForce {string} Time in force for the order
|
|
7846
|
+
* @param params.order.symbol {string} Trading symbol
|
|
7847
|
+
* @param params.order.orderQty {number} Order quantity
|
|
7860
7848
|
* @returns {Promise<FinaticResponse<OrderActionResult>>} Standard response with success/Error/Warning structure
|
|
7861
7849
|
*
|
|
7862
7850
|
* Generated from: PATCH /api/beta/brokers/orders/{order_id}
|
|
@@ -7866,7 +7854,7 @@ declare class BrokersWrapper {
|
|
|
7866
7854
|
* ```typescript-client
|
|
7867
7855
|
* // Minimal example with required parameters only
|
|
7868
7856
|
* const result = await finatic.modifyOrder({
|
|
7869
|
-
orderId: '
|
|
7857
|
+
orderId: 'example-id'
|
|
7870
7858
|
* });
|
|
7871
7859
|
*
|
|
7872
7860
|
* // Access the response data
|
|
@@ -7876,25 +7864,6 @@ declare class BrokersWrapper {
|
|
|
7876
7864
|
* console.error('Error:', result.error.message);
|
|
7877
7865
|
* }
|
|
7878
7866
|
* ```
|
|
7879
|
-
* @example
|
|
7880
|
-
* ```typescript-client
|
|
7881
|
-
* // Full example with optional parameters
|
|
7882
|
-
* const result = await finatic.modifyOrder({
|
|
7883
|
-
orderId: 'order_1234567890abcdef',
|
|
7884
|
-
accountNumber: '123456789',
|
|
7885
|
-
connectionId: '00000000-0000-0000-0000-000000000000'
|
|
7886
|
-
* });
|
|
7887
|
-
*
|
|
7888
|
-
* // Handle response with warnings
|
|
7889
|
-
* if (result.success) {
|
|
7890
|
-
* console.log('Data:', result.success.data);
|
|
7891
|
-
* if (result.warning && result.warning.length > 0) {
|
|
7892
|
-
* console.warn('Warnings:', result.warning);
|
|
7893
|
-
* }
|
|
7894
|
-
* } else if (result.error) {
|
|
7895
|
-
* console.error('Error:', result.error.message, result.error.code);
|
|
7896
|
-
* }
|
|
7897
|
-
* ```
|
|
7898
7867
|
*/
|
|
7899
7868
|
modifyOrder(params: ModifyOrderParams): Promise<FinaticResponse$2<OrderActionResult>>;
|
|
7900
7869
|
}
|
|
@@ -8000,7 +7969,7 @@ declare class CompanyWrapper {
|
|
|
8000
7969
|
* ```typescript-client
|
|
8001
7970
|
* // Minimal example with required parameters only
|
|
8002
7971
|
* const result = await finatic.getCompany({
|
|
8003
|
-
companyId: '
|
|
7972
|
+
companyId: 'example-id'
|
|
8004
7973
|
* });
|
|
8005
7974
|
*
|
|
8006
7975
|
* // Access the response data
|
|
@@ -8033,7 +8002,7 @@ interface SessionApiInterface {
|
|
|
8033
8002
|
* @param {*} [options] Override http request option.
|
|
8034
8003
|
* @throws {RequiredError}
|
|
8035
8004
|
*/
|
|
8036
|
-
getSessionUserApiBetaSessionSessionIdUserGet(requestParameters: SessionApiGetSessionUserApiBetaSessionSessionIdUserGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
8005
|
+
getSessionUserApiBetaSessionSessionIdUserGet(requestParameters: SessionApiGetSessionUserApiBetaSessionSessionIdUserGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<FinaticResponseSessionUserResponse>;
|
|
8037
8006
|
/**
|
|
8038
8007
|
* Initialize a new session with company API key.
|
|
8039
8008
|
* @summary Init Session
|
|
@@ -8049,7 +8018,7 @@ interface SessionApiInterface {
|
|
|
8049
8018
|
* @param {*} [options] Override http request option.
|
|
8050
8019
|
* @throws {RequiredError}
|
|
8051
8020
|
*/
|
|
8052
|
-
startSessionApiBetaSessionStartPost(requestParameters: SessionApiStartSessionApiBetaSessionStartPostRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
8021
|
+
startSessionApiBetaSessionStartPost(requestParameters: SessionApiStartSessionApiBetaSessionStartPostRequest, options?: RawAxiosRequestConfig): AxiosPromise<FinaticResponseSessionResponseData>;
|
|
8053
8022
|
}
|
|
8054
8023
|
/**
|
|
8055
8024
|
* Request parameters for getPortalUrlApiBetaSessionPortalGet operation in SessionApi.
|
|
@@ -8114,7 +8083,7 @@ declare class SessionApi extends BaseAPI implements SessionApiInterface {
|
|
|
8114
8083
|
* @param {*} [options] Override http request option.
|
|
8115
8084
|
* @throws {RequiredError}
|
|
8116
8085
|
*/
|
|
8117
|
-
getSessionUserApiBetaSessionSessionIdUserGet(requestParameters: SessionApiGetSessionUserApiBetaSessionSessionIdUserGetRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<
|
|
8086
|
+
getSessionUserApiBetaSessionSessionIdUserGet(requestParameters: SessionApiGetSessionUserApiBetaSessionSessionIdUserGetRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<FinaticResponseSessionUserResponse, any, {}>>;
|
|
8118
8087
|
/**
|
|
8119
8088
|
* Initialize a new session with company API key.
|
|
8120
8089
|
* @summary Init Session
|
|
@@ -8130,7 +8099,7 @@ declare class SessionApi extends BaseAPI implements SessionApiInterface {
|
|
|
8130
8099
|
* @param {*} [options] Override http request option.
|
|
8131
8100
|
* @throws {RequiredError}
|
|
8132
8101
|
*/
|
|
8133
|
-
startSessionApiBetaSessionStartPost(requestParameters: SessionApiStartSessionApiBetaSessionStartPostRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<
|
|
8102
|
+
startSessionApiBetaSessionStartPost(requestParameters: SessionApiStartSessionApiBetaSessionStartPostRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<FinaticResponseSessionResponseData, any, {}>>;
|
|
8134
8103
|
}
|
|
8135
8104
|
|
|
8136
8105
|
/**
|
|
@@ -8199,7 +8168,7 @@ declare class SessionWrapper {
|
|
|
8199
8168
|
*
|
|
8200
8169
|
* Initialize a new session with company API key.
|
|
8201
8170
|
* @param params.xApiKey {string} Company API key
|
|
8202
|
-
* @returns {Promise<FinaticResponse<
|
|
8171
|
+
* @returns {Promise<FinaticResponse<TokenResponseData>>} Standard response with success/Error/Warning structure
|
|
8203
8172
|
*
|
|
8204
8173
|
* Generated from: POST /api/beta/session/init
|
|
8205
8174
|
* @methodId init_session_api_beta_session_init_post
|
|
@@ -8215,30 +8184,21 @@ declare class SessionWrapper {
|
|
|
8215
8184
|
* }
|
|
8216
8185
|
* ```
|
|
8217
8186
|
*/
|
|
8218
|
-
initSession(params: InitSessionParams): Promise<FinaticResponse<
|
|
8187
|
+
initSession(params: InitSessionParams): Promise<FinaticResponse<TokenResponseData>>;
|
|
8219
8188
|
/**
|
|
8220
8189
|
* Start Session
|
|
8221
8190
|
*
|
|
8222
8191
|
* Start a session with a one-time token.
|
|
8223
8192
|
* @param params.OneTimeToken {string} One-time use token obtained from init_session endpoint to authenticate and start the session
|
|
8224
8193
|
* @param params.body {SessionStartRequest} Session start request containing optional user ID to associate with the session
|
|
8225
|
-
* @returns {Promise<FinaticResponse<
|
|
8194
|
+
* @returns {Promise<FinaticResponse<SessionResponseData>>} Standard response with success/Error/Warning structure
|
|
8226
8195
|
*
|
|
8227
8196
|
* Generated from: POST /api/beta/session/start
|
|
8228
8197
|
* @methodId start_session_api_beta_session_start_post
|
|
8229
8198
|
* @category session
|
|
8230
|
-
|
|
8231
|
-
* ```typescript-client
|
|
8232
|
-
* // Example with no parameters
|
|
8233
|
-
* const result = await finatic.startSession({});
|
|
8234
|
-
*
|
|
8235
|
-
* // Access the response data
|
|
8236
|
-
* if (result.success) {
|
|
8237
|
-
* console.log('Data:', result.success.data);
|
|
8238
|
-
* }
|
|
8239
|
-
* ```
|
|
8199
|
+
|
|
8240
8200
|
*/
|
|
8241
|
-
startSession(params: StartSessionParams): Promise<FinaticResponse<
|
|
8201
|
+
startSession(params: StartSessionParams): Promise<FinaticResponse<SessionResponseData>>;
|
|
8242
8202
|
/**
|
|
8243
8203
|
* Get Portal Url
|
|
8244
8204
|
*
|
|
@@ -8247,7 +8207,7 @@ declare class SessionWrapper {
|
|
|
8247
8207
|
* The session must be in ACTIVE or AUTHENTICATING state and the request must come from the same device
|
|
8248
8208
|
* that initiated the session. Device info is automatically validated from the request.
|
|
8249
8209
|
* @param params No parameters required for this method
|
|
8250
|
-
* @returns {Promise<FinaticResponse<
|
|
8210
|
+
* @returns {Promise<FinaticResponse<PortalUrlResponse>>} Standard response with success/Error/Warning structure
|
|
8251
8211
|
*
|
|
8252
8212
|
* Generated from: GET /api/beta/session/portal
|
|
8253
8213
|
* @methodId get_portal_url_api_beta_session_portal_get
|
|
@@ -8263,7 +8223,7 @@ declare class SessionWrapper {
|
|
|
8263
8223
|
* }
|
|
8264
8224
|
* ```
|
|
8265
8225
|
*/
|
|
8266
|
-
getPortalUrl(params?: {}): Promise<FinaticResponse<
|
|
8226
|
+
getPortalUrl(params?: {}): Promise<FinaticResponse<PortalUrlResponse>>;
|
|
8267
8227
|
/**
|
|
8268
8228
|
* Get Session User
|
|
8269
8229
|
*
|
|
@@ -8279,7 +8239,7 @@ declare class SessionWrapper {
|
|
|
8279
8239
|
* - Only accessible to authenticated sessions with user_id
|
|
8280
8240
|
* - Validates that header session_id matches path session_id
|
|
8281
8241
|
* @param params.sessionId {string} Session ID
|
|
8282
|
-
* @returns {Promise<FinaticResponse<
|
|
8242
|
+
* @returns {Promise<FinaticResponse<SessionUserResponse>>} Standard response with success/Error/Warning structure
|
|
8283
8243
|
*
|
|
8284
8244
|
* Generated from: GET /api/beta/session/{session_id}/user
|
|
8285
8245
|
* @methodId get_session_user_api_beta_session__session_id__user_get
|
|
@@ -8288,7 +8248,7 @@ declare class SessionWrapper {
|
|
|
8288
8248
|
* ```typescript-client
|
|
8289
8249
|
* // Minimal example with required parameters only
|
|
8290
8250
|
* const result = await finatic.getSessionUser({
|
|
8291
|
-
sessionId: '
|
|
8251
|
+
sessionId: 'example-id'
|
|
8292
8252
|
* });
|
|
8293
8253
|
*
|
|
8294
8254
|
* // Access the response data
|
|
@@ -8299,7 +8259,7 @@ declare class SessionWrapper {
|
|
|
8299
8259
|
* }
|
|
8300
8260
|
* ```
|
|
8301
8261
|
*/
|
|
8302
|
-
getSessionUser(params: GetSessionUserParams): Promise<FinaticResponse<
|
|
8262
|
+
getSessionUser(params: GetSessionUserParams): Promise<FinaticResponse<SessionUserResponse>>;
|
|
8303
8263
|
}
|
|
8304
8264
|
|
|
8305
8265
|
/**
|
|
@@ -8768,18 +8728,12 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
8768
8728
|
* Get Company
|
|
8769
8729
|
*
|
|
8770
8730
|
* Get public company details by ID (no user check, no sensitive data).
|
|
8771
|
-
*
|
|
8772
|
-
* Convenience method that delegates to company wrapper.
|
|
8773
|
-
*
|
|
8774
|
-
* @param params - Optional parameters object. Only include the fields you want to use.
|
|
8775
|
-
* Example: getCompany({ accountId: "123", limit: 10, offset: 0 })
|
|
8776
|
-
* @returns FinaticResponse with success, error, and warning fields
|
|
8777
8731
|
* @methodId get_company_api_beta_company__company_id__get
|
|
8778
8732
|
* @category company
|
|
8779
8733
|
* @example
|
|
8780
8734
|
* ```typescript-client
|
|
8781
8735
|
* // Minimal example with required parameters only
|
|
8782
|
-
* const result = await finatic.getCompany({ companyId: '
|
|
8736
|
+
* const result = await finatic.getCompany({ companyId: 'example-id' });
|
|
8783
8737
|
*
|
|
8784
8738
|
* // Access the response data
|
|
8785
8739
|
* if (result.success) {
|
|
@@ -8791,7 +8745,7 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
8791
8745
|
* @example
|
|
8792
8746
|
* ```typescript-server
|
|
8793
8747
|
* // Minimal example with required parameters only
|
|
8794
|
-
* const result = await finatic.getCompany({ companyId: '
|
|
8748
|
+
* const result = await finatic.getCompany({ companyId: 'example-id' });
|
|
8795
8749
|
*
|
|
8796
8750
|
* // Access the response data
|
|
8797
8751
|
* if (result.success) {
|
|
@@ -8804,7 +8758,7 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
8804
8758
|
* ```python
|
|
8805
8759
|
* # Minimal example with required parameters only
|
|
8806
8760
|
* result = await finatic.get_company(
|
|
8807
|
-
* company_id='
|
|
8761
|
+
* company_id='example'
|
|
8808
8762
|
* )
|
|
8809
8763
|
*
|
|
8810
8764
|
* # Access the response data
|
|
@@ -8823,12 +8777,6 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
8823
8777
|
* Returns array of current balances (one per unit_code per account).
|
|
8824
8778
|
* This endpoint is accessible from the portal and uses session-only authentication.
|
|
8825
8779
|
* Returns balances from connections the company has read access to.
|
|
8826
|
-
*
|
|
8827
|
-
* Convenience method that delegates to brokers wrapper.
|
|
8828
|
-
*
|
|
8829
|
-
* @param params - Optional parameters object. Only include the fields you want to use.
|
|
8830
|
-
* Example: getBalances({ accountId: "123", limit: 10, offset: 0 })
|
|
8831
|
-
* @returns FinaticResponse with success, error, and warning fields
|
|
8832
8780
|
* @methodId get_balances_api_beta_brokers_data_balances_get
|
|
8833
8781
|
* @category brokers
|
|
8834
8782
|
* @example
|
|
@@ -8844,7 +8792,7 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
8844
8792
|
* @example
|
|
8845
8793
|
* ```typescript-client
|
|
8846
8794
|
* // Full example with optional parameters
|
|
8847
|
-
* const result = await finatic.getBalances({ brokerId: '
|
|
8795
|
+
* const result = await finatic.getBalances({ brokerId: 'example-id', connectionId: 'example-id', accountId: 'example-id' });
|
|
8848
8796
|
*
|
|
8849
8797
|
* // Handle response with warnings
|
|
8850
8798
|
* if (result.success) {
|
|
@@ -8879,9 +8827,9 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
8879
8827
|
* ```python
|
|
8880
8828
|
* # Full example with optional parameters
|
|
8881
8829
|
* result = await finatic.get_balances(
|
|
8882
|
-
* broker_id='
|
|
8883
|
-
connection_id='
|
|
8884
|
-
account_id='
|
|
8830
|
+
* broker_id='example',
|
|
8831
|
+
connection_id='example',
|
|
8832
|
+
account_id='example'
|
|
8885
8833
|
* )
|
|
8886
8834
|
*
|
|
8887
8835
|
* # Handle response with warnings
|
|
@@ -8901,12 +8849,6 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
8901
8849
|
*
|
|
8902
8850
|
* This endpoint is accessible from the portal and uses session-only authentication.
|
|
8903
8851
|
* Returns accounts from connections the company has read access to.
|
|
8904
|
-
*
|
|
8905
|
-
* Convenience method that delegates to brokers wrapper.
|
|
8906
|
-
*
|
|
8907
|
-
* @param params - Optional parameters object. Only include the fields you want to use.
|
|
8908
|
-
* Example: getAccounts({ accountId: "123", limit: 10, offset: 0 })
|
|
8909
|
-
* @returns FinaticResponse with success, error, and warning fields
|
|
8910
8852
|
* @methodId get_accounts_api_beta_brokers_data_accounts_get
|
|
8911
8853
|
* @category brokers
|
|
8912
8854
|
* @example
|
|
@@ -8922,7 +8864,7 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
8922
8864
|
* @example
|
|
8923
8865
|
* ```typescript-client
|
|
8924
8866
|
* // Full example with optional parameters
|
|
8925
|
-
* const result = await finatic.getAccounts({ brokerId: '
|
|
8867
|
+
* const result = await finatic.getAccounts({ brokerId: 'example-id', connectionId: 'example-id', accountType: 'margin' });
|
|
8926
8868
|
*
|
|
8927
8869
|
* // Handle response with warnings
|
|
8928
8870
|
* if (result.success) {
|
|
@@ -8957,8 +8899,8 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
8957
8899
|
* ```python
|
|
8958
8900
|
* # Full example with optional parameters
|
|
8959
8901
|
* result = await finatic.get_accounts(
|
|
8960
|
-
* broker_id='
|
|
8961
|
-
connection_id='
|
|
8902
|
+
* broker_id='example',
|
|
8903
|
+
connection_id='example',
|
|
8962
8904
|
account_type='margin'
|
|
8963
8905
|
* )
|
|
8964
8906
|
*
|
|
@@ -8984,12 +8926,6 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
8984
8926
|
* -------
|
|
8985
8927
|
* FinaticResponse[list[BrokerInfo]]
|
|
8986
8928
|
* list of available brokers with their metadata.
|
|
8987
|
-
*
|
|
8988
|
-
* Convenience method that delegates to brokers wrapper.
|
|
8989
|
-
*
|
|
8990
|
-
* @param params - Optional parameters object. Only include the fields you want to use.
|
|
8991
|
-
* Example: getBrokers({ accountId: "123", limit: 10, offset: 0 })
|
|
8992
|
-
* @returns FinaticResponse with success, error, and warning fields
|
|
8993
8929
|
* @methodId get_brokers_api_beta_brokers__get
|
|
8994
8930
|
* @category brokers
|
|
8995
8931
|
* @example
|
|
@@ -9031,12 +8967,6 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
9031
8967
|
* This endpoint is accessible from the portal and uses session-only authentication.
|
|
9032
8968
|
* Returns connections that the user has any permissions for, including the current
|
|
9033
8969
|
* company's permissions (read/write) for each connection.
|
|
9034
|
-
*
|
|
9035
|
-
* Convenience method that delegates to brokers wrapper.
|
|
9036
|
-
*
|
|
9037
|
-
* @param params - Optional parameters object. Only include the fields you want to use.
|
|
9038
|
-
* Example: getBrokerConnections({ accountId: "123", limit: 10, offset: 0 })
|
|
9039
|
-
* @returns FinaticResponse with success, error, and warning fields
|
|
9040
8970
|
* @methodId list_broker_connections_api_beta_brokers_connections_get
|
|
9041
8971
|
* @category brokers
|
|
9042
8972
|
* @example
|
|
@@ -9077,18 +9007,12 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
9077
9007
|
*
|
|
9078
9008
|
* If the company is the only one with access, the entire connection is deleted.
|
|
9079
9009
|
* If other companies have access, only the company's access is removed.
|
|
9080
|
-
*
|
|
9081
|
-
* Convenience method that delegates to brokers wrapper.
|
|
9082
|
-
*
|
|
9083
|
-
* @param params - Optional parameters object. Only include the fields you want to use.
|
|
9084
|
-
* Example: disconnectCompanyFromBroker({ accountId: "123", limit: 10, offset: 0 })
|
|
9085
|
-
* @returns FinaticResponse with success, error, and warning fields
|
|
9086
9010
|
* @methodId disconnect_company_from_broker_api_beta_brokers_disconnect_company__connection_id__delete
|
|
9087
9011
|
* @category brokers
|
|
9088
9012
|
* @example
|
|
9089
9013
|
* ```typescript-client
|
|
9090
9014
|
* // Minimal example with required parameters only
|
|
9091
|
-
* const result = await finatic.disconnectCompanyFromBroker({ connectionId: '
|
|
9015
|
+
* const result = await finatic.disconnectCompanyFromBroker({ connectionId: 'example-id' });
|
|
9092
9016
|
*
|
|
9093
9017
|
* // Access the response data
|
|
9094
9018
|
* if (result.success) {
|
|
@@ -9100,7 +9024,7 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
9100
9024
|
* @example
|
|
9101
9025
|
* ```typescript-server
|
|
9102
9026
|
* // Minimal example with required parameters only
|
|
9103
|
-
* const result = await finatic.disconnectCompanyFromBroker({ connectionId: '
|
|
9027
|
+
* const result = await finatic.disconnectCompanyFromBroker({ connectionId: 'example-id' });
|
|
9104
9028
|
*
|
|
9105
9029
|
* // Access the response data
|
|
9106
9030
|
* if (result.success) {
|
|
@@ -9113,7 +9037,7 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
9113
9037
|
* ```python
|
|
9114
9038
|
* # Minimal example with required parameters only
|
|
9115
9039
|
* result = await finatic.disconnect_company_from_broker(
|
|
9116
|
-
* connection_id='
|
|
9040
|
+
* connection_id='example'
|
|
9117
9041
|
* )
|
|
9118
9042
|
*
|
|
9119
9043
|
* # Access the response data
|
|
@@ -9131,12 +9055,6 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
9131
9055
|
*
|
|
9132
9056
|
* This endpoint is accessible from the portal and uses session-only authentication.
|
|
9133
9057
|
* Returns orders from connections the company has read access to.
|
|
9134
|
-
*
|
|
9135
|
-
* Convenience method that delegates to brokers wrapper.
|
|
9136
|
-
*
|
|
9137
|
-
* @param params - Optional parameters object. Only include the fields you want to use.
|
|
9138
|
-
* Example: getOrders({ accountId: "123", limit: 10, offset: 0 })
|
|
9139
|
-
* @returns FinaticResponse with success, error, and warning fields
|
|
9140
9058
|
* @methodId get_orders_api_beta_brokers_data_orders_get
|
|
9141
9059
|
* @category brokers
|
|
9142
9060
|
* @example
|
|
@@ -9152,7 +9070,7 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
9152
9070
|
* @example
|
|
9153
9071
|
* ```typescript-client
|
|
9154
9072
|
* // Full example with optional parameters
|
|
9155
|
-
* const result = await finatic.getOrders({ brokerId: '
|
|
9073
|
+
* const result = await finatic.getOrders({ brokerId: 'example-id', connectionId: 'example-id', accountId: 'example-id' });
|
|
9156
9074
|
*
|
|
9157
9075
|
* // Handle response with warnings
|
|
9158
9076
|
* if (result.success) {
|
|
@@ -9187,9 +9105,9 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
9187
9105
|
* ```python
|
|
9188
9106
|
* # Full example with optional parameters
|
|
9189
9107
|
* result = await finatic.get_orders(
|
|
9190
|
-
* broker_id='
|
|
9191
|
-
connection_id='
|
|
9192
|
-
account_id='
|
|
9108
|
+
* broker_id='example',
|
|
9109
|
+
connection_id='example',
|
|
9110
|
+
account_id='example'
|
|
9193
9111
|
* )
|
|
9194
9112
|
*
|
|
9195
9113
|
* # Handle response with warnings
|
|
@@ -9209,12 +9127,6 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
9209
9127
|
*
|
|
9210
9128
|
* This endpoint is accessible from the portal and uses session-only authentication.
|
|
9211
9129
|
* Returns positions from connections the company has read access to.
|
|
9212
|
-
*
|
|
9213
|
-
* Convenience method that delegates to brokers wrapper.
|
|
9214
|
-
*
|
|
9215
|
-
* @param params - Optional parameters object. Only include the fields you want to use.
|
|
9216
|
-
* Example: getPositions({ accountId: "123", limit: 10, offset: 0 })
|
|
9217
|
-
* @returns FinaticResponse with success, error, and warning fields
|
|
9218
9130
|
* @methodId get_positions_api_beta_brokers_data_positions_get
|
|
9219
9131
|
* @category brokers
|
|
9220
9132
|
* @example
|
|
@@ -9230,7 +9142,7 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
9230
9142
|
* @example
|
|
9231
9143
|
* ```typescript-client
|
|
9232
9144
|
* // Full example with optional parameters
|
|
9233
|
-
* const result = await finatic.getPositions({ brokerId: '
|
|
9145
|
+
* const result = await finatic.getPositions({ brokerId: 'example-id', connectionId: 'example-id', accountId: 'example-id' });
|
|
9234
9146
|
*
|
|
9235
9147
|
* // Handle response with warnings
|
|
9236
9148
|
* if (result.success) {
|
|
@@ -9265,9 +9177,9 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
9265
9177
|
* ```python
|
|
9266
9178
|
* # Full example with optional parameters
|
|
9267
9179
|
* result = await finatic.get_positions(
|
|
9268
|
-
* broker_id='
|
|
9269
|
-
connection_id='
|
|
9270
|
-
account_id='
|
|
9180
|
+
* broker_id='example',
|
|
9181
|
+
connection_id='example',
|
|
9182
|
+
account_id='example'
|
|
9271
9183
|
* )
|
|
9272
9184
|
*
|
|
9273
9185
|
* # Handle response with warnings
|
|
@@ -9287,12 +9199,6 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
9287
9199
|
*
|
|
9288
9200
|
* Returns transactions from connections the company has read access to.
|
|
9289
9201
|
* This endpoint is accessible from the portal and uses session-only authentication.
|
|
9290
|
-
*
|
|
9291
|
-
* Convenience method that delegates to brokers wrapper.
|
|
9292
|
-
*
|
|
9293
|
-
* @param params - Optional parameters object. Only include the fields you want to use.
|
|
9294
|
-
* Example: getTransactions({ accountId: "123", limit: 10, offset: 0 })
|
|
9295
|
-
* @returns FinaticResponse with success, error, and warning fields
|
|
9296
9202
|
* @methodId get_transactions_api_beta_brokers_data_transactions_get
|
|
9297
9203
|
* @category brokers
|
|
9298
9204
|
* @example
|
|
@@ -9308,7 +9214,7 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
9308
9214
|
* @example
|
|
9309
9215
|
* ```typescript-client
|
|
9310
9216
|
* // Full example with optional parameters
|
|
9311
|
-
* const result = await finatic.getTransactions({ brokerId: '
|
|
9217
|
+
* const result = await finatic.getTransactions({ brokerId: 'example-id', connectionId: 'example-id', accountId: 'example-id' });
|
|
9312
9218
|
*
|
|
9313
9219
|
* // Handle response with warnings
|
|
9314
9220
|
* if (result.success) {
|
|
@@ -9343,9 +9249,9 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
9343
9249
|
* ```python
|
|
9344
9250
|
* # Full example with optional parameters
|
|
9345
9251
|
* result = await finatic.get_transactions(
|
|
9346
|
-
* broker_id='
|
|
9347
|
-
connection_id='
|
|
9348
|
-
account_id='
|
|
9252
|
+
* broker_id='example',
|
|
9253
|
+
connection_id='example',
|
|
9254
|
+
account_id='example'
|
|
9349
9255
|
* )
|
|
9350
9256
|
*
|
|
9351
9257
|
* # Handle response with warnings
|
|
@@ -9364,18 +9270,12 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
9364
9270
|
* Get order fills for a specific order.
|
|
9365
9271
|
*
|
|
9366
9272
|
* This endpoint returns all execution fills for the specified order.
|
|
9367
|
-
*
|
|
9368
|
-
* Convenience method that delegates to brokers wrapper.
|
|
9369
|
-
*
|
|
9370
|
-
* @param params - Optional parameters object. Only include the fields you want to use.
|
|
9371
|
-
* Example: getOrderFills({ accountId: "123", limit: 10, offset: 0 })
|
|
9372
|
-
* @returns FinaticResponse with success, error, and warning fields
|
|
9373
9273
|
* @methodId get_order_fills_api_beta_brokers_data_orders__order_id__fills_get
|
|
9374
9274
|
* @category brokers
|
|
9375
9275
|
* @example
|
|
9376
9276
|
* ```typescript-client
|
|
9377
9277
|
* // Minimal example with required parameters only
|
|
9378
|
-
* const result = await finatic.getOrderFills({ orderId: '
|
|
9278
|
+
* const result = await finatic.getOrderFills({ orderId: 'example-id' });
|
|
9379
9279
|
*
|
|
9380
9280
|
* // Access the response data
|
|
9381
9281
|
* if (result.success) {
|
|
@@ -9387,7 +9287,7 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
9387
9287
|
* @example
|
|
9388
9288
|
* ```typescript-client
|
|
9389
9289
|
* // Full example with optional parameters
|
|
9390
|
-
* const result = await finatic.getOrderFills({ orderId: '
|
|
9290
|
+
* const result = await finatic.getOrderFills({ orderId: 'example-id', connectionId: 'example-id', limit: 0, offset: 0 });
|
|
9391
9291
|
*
|
|
9392
9292
|
* // Handle response with warnings
|
|
9393
9293
|
* if (result.success) {
|
|
@@ -9402,7 +9302,7 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
9402
9302
|
* @example
|
|
9403
9303
|
* ```typescript-server
|
|
9404
9304
|
* // Minimal example with required parameters only
|
|
9405
|
-
* const result = await finatic.getOrderFills({ orderId: '
|
|
9305
|
+
* const result = await finatic.getOrderFills({ orderId: 'example-id' });
|
|
9406
9306
|
*
|
|
9407
9307
|
* // Access the response data
|
|
9408
9308
|
* if (result.success) {
|
|
@@ -9415,7 +9315,7 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
9415
9315
|
* ```python
|
|
9416
9316
|
* # Minimal example with required parameters only
|
|
9417
9317
|
* result = await finatic.get_order_fills(
|
|
9418
|
-
* order_id='
|
|
9318
|
+
* order_id='example'
|
|
9419
9319
|
* )
|
|
9420
9320
|
*
|
|
9421
9321
|
* # Access the response data
|
|
@@ -9428,10 +9328,10 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
9428
9328
|
* ```python
|
|
9429
9329
|
* # Full example with optional parameters
|
|
9430
9330
|
* result = await finatic.get_order_fills(
|
|
9431
|
-
* order_id='
|
|
9432
|
-
connection_id='
|
|
9433
|
-
limit=
|
|
9434
|
-
offset=
|
|
9331
|
+
* order_id='example',
|
|
9332
|
+
connection_id='example',
|
|
9333
|
+
limit='example',
|
|
9334
|
+
offset='example'
|
|
9435
9335
|
* )
|
|
9436
9336
|
*
|
|
9437
9337
|
* # Handle response with warnings
|
|
@@ -9450,18 +9350,12 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
9450
9350
|
* Get order events for a specific order.
|
|
9451
9351
|
*
|
|
9452
9352
|
* This endpoint returns all lifecycle events for the specified order.
|
|
9453
|
-
*
|
|
9454
|
-
* Convenience method that delegates to brokers wrapper.
|
|
9455
|
-
*
|
|
9456
|
-
* @param params - Optional parameters object. Only include the fields you want to use.
|
|
9457
|
-
* Example: getOrderEvents({ accountId: "123", limit: 10, offset: 0 })
|
|
9458
|
-
* @returns FinaticResponse with success, error, and warning fields
|
|
9459
9353
|
* @methodId get_order_events_api_beta_brokers_data_orders__order_id__events_get
|
|
9460
9354
|
* @category brokers
|
|
9461
9355
|
* @example
|
|
9462
9356
|
* ```typescript-client
|
|
9463
9357
|
* // Minimal example with required parameters only
|
|
9464
|
-
* const result = await finatic.getOrderEvents({ orderId: '
|
|
9358
|
+
* const result = await finatic.getOrderEvents({ orderId: 'example-id' });
|
|
9465
9359
|
*
|
|
9466
9360
|
* // Access the response data
|
|
9467
9361
|
* if (result.success) {
|
|
@@ -9473,7 +9367,7 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
9473
9367
|
* @example
|
|
9474
9368
|
* ```typescript-client
|
|
9475
9369
|
* // Full example with optional parameters
|
|
9476
|
-
* const result = await finatic.getOrderEvents({ orderId: '
|
|
9370
|
+
* const result = await finatic.getOrderEvents({ orderId: 'example-id', connectionId: 'example-id', limit: 0, offset: 0 });
|
|
9477
9371
|
*
|
|
9478
9372
|
* // Handle response with warnings
|
|
9479
9373
|
* if (result.success) {
|
|
@@ -9488,7 +9382,7 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
9488
9382
|
* @example
|
|
9489
9383
|
* ```typescript-server
|
|
9490
9384
|
* // Minimal example with required parameters only
|
|
9491
|
-
* const result = await finatic.getOrderEvents({ orderId: '
|
|
9385
|
+
* const result = await finatic.getOrderEvents({ orderId: 'example-id' });
|
|
9492
9386
|
*
|
|
9493
9387
|
* // Access the response data
|
|
9494
9388
|
* if (result.success) {
|
|
@@ -9501,7 +9395,7 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
9501
9395
|
* ```python
|
|
9502
9396
|
* # Minimal example with required parameters only
|
|
9503
9397
|
* result = await finatic.get_order_events(
|
|
9504
|
-
* order_id='
|
|
9398
|
+
* order_id='example'
|
|
9505
9399
|
* )
|
|
9506
9400
|
*
|
|
9507
9401
|
* # Access the response data
|
|
@@ -9514,10 +9408,10 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
9514
9408
|
* ```python
|
|
9515
9409
|
* # Full example with optional parameters
|
|
9516
9410
|
* result = await finatic.get_order_events(
|
|
9517
|
-
* order_id='
|
|
9518
|
-
connection_id='
|
|
9519
|
-
limit=
|
|
9520
|
-
offset=
|
|
9411
|
+
* order_id='example',
|
|
9412
|
+
connection_id='example',
|
|
9413
|
+
limit='example',
|
|
9414
|
+
offset='example'
|
|
9521
9415
|
* )
|
|
9522
9416
|
*
|
|
9523
9417
|
* # Handle response with warnings
|
|
@@ -9536,12 +9430,6 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
9536
9430
|
* Get order groups.
|
|
9537
9431
|
*
|
|
9538
9432
|
* This endpoint returns order groups that contain multiple orders.
|
|
9539
|
-
*
|
|
9540
|
-
* Convenience method that delegates to brokers wrapper.
|
|
9541
|
-
*
|
|
9542
|
-
* @param params - Optional parameters object. Only include the fields you want to use.
|
|
9543
|
-
* Example: getOrderGroups({ accountId: "123", limit: 10, offset: 0 })
|
|
9544
|
-
* @returns FinaticResponse with success, error, and warning fields
|
|
9545
9433
|
* @methodId get_order_groups_api_beta_brokers_data_orders_groups_get
|
|
9546
9434
|
* @category brokers
|
|
9547
9435
|
* @example
|
|
@@ -9557,7 +9445,7 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
9557
9445
|
* @example
|
|
9558
9446
|
* ```typescript-client
|
|
9559
9447
|
* // Full example with optional parameters
|
|
9560
|
-
* const result = await finatic.getOrderGroups({ brokerId: '
|
|
9448
|
+
* const result = await finatic.getOrderGroups({ brokerId: 'example-id', connectionId: 'example-id', limit: 0 });
|
|
9561
9449
|
*
|
|
9562
9450
|
* // Handle response with warnings
|
|
9563
9451
|
* if (result.success) {
|
|
@@ -9592,9 +9480,9 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
9592
9480
|
* ```python
|
|
9593
9481
|
* # Full example with optional parameters
|
|
9594
9482
|
* result = await finatic.get_order_groups(
|
|
9595
|
-
* broker_id='
|
|
9596
|
-
connection_id='
|
|
9597
|
-
limit=
|
|
9483
|
+
* broker_id='example',
|
|
9484
|
+
connection_id='example',
|
|
9485
|
+
limit='example'
|
|
9598
9486
|
* )
|
|
9599
9487
|
*
|
|
9600
9488
|
* # Handle response with warnings
|
|
@@ -9614,12 +9502,6 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
9614
9502
|
*
|
|
9615
9503
|
* This endpoint returns tax lots for positions, which are used for tax reporting.
|
|
9616
9504
|
* Each lot tracks when a position was opened/closed and at what prices.
|
|
9617
|
-
*
|
|
9618
|
-
* Convenience method that delegates to brokers wrapper.
|
|
9619
|
-
*
|
|
9620
|
-
* @param params - Optional parameters object. Only include the fields you want to use.
|
|
9621
|
-
* Example: getPositionLots({ accountId: "123", limit: 10, offset: 0 })
|
|
9622
|
-
* @returns FinaticResponse with success, error, and warning fields
|
|
9623
9505
|
* @methodId get_position_lots_api_beta_brokers_data_positions_lots_get
|
|
9624
9506
|
* @category brokers
|
|
9625
9507
|
* @example
|
|
@@ -9635,7 +9517,7 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
9635
9517
|
* @example
|
|
9636
9518
|
* ```typescript-client
|
|
9637
9519
|
* // Full example with optional parameters
|
|
9638
|
-
* const result = await finatic.getPositionLots({ brokerId: '
|
|
9520
|
+
* const result = await finatic.getPositionLots({ brokerId: 'example-id', connectionId: 'example-id', accountId: 'example-id' });
|
|
9639
9521
|
*
|
|
9640
9522
|
* // Handle response with warnings
|
|
9641
9523
|
* if (result.success) {
|
|
@@ -9670,9 +9552,9 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
9670
9552
|
* ```python
|
|
9671
9553
|
* # Full example with optional parameters
|
|
9672
9554
|
* result = await finatic.get_position_lots(
|
|
9673
|
-
* broker_id='
|
|
9674
|
-
connection_id='
|
|
9675
|
-
account_id='
|
|
9555
|
+
* broker_id='example',
|
|
9556
|
+
connection_id='example',
|
|
9557
|
+
account_id='example'
|
|
9676
9558
|
* )
|
|
9677
9559
|
*
|
|
9678
9560
|
* # Handle response with warnings
|
|
@@ -9691,18 +9573,12 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
9691
9573
|
* Get position lot fills for a specific lot.
|
|
9692
9574
|
*
|
|
9693
9575
|
* This endpoint returns all fills associated with a specific position lot.
|
|
9694
|
-
*
|
|
9695
|
-
* Convenience method that delegates to brokers wrapper.
|
|
9696
|
-
*
|
|
9697
|
-
* @param params - Optional parameters object. Only include the fields you want to use.
|
|
9698
|
-
* Example: getPositionLotFills({ accountId: "123", limit: 10, offset: 0 })
|
|
9699
|
-
* @returns FinaticResponse with success, error, and warning fields
|
|
9700
9576
|
* @methodId get_position_lot_fills_api_beta_brokers_data_positions_lots__lot_id__fills_get
|
|
9701
9577
|
* @category brokers
|
|
9702
9578
|
* @example
|
|
9703
9579
|
* ```typescript-client
|
|
9704
9580
|
* // Minimal example with required parameters only
|
|
9705
|
-
* const result = await finatic.getPositionLotFills({ lotId: '
|
|
9581
|
+
* const result = await finatic.getPositionLotFills({ lotId: 'example-id' });
|
|
9706
9582
|
*
|
|
9707
9583
|
* // Access the response data
|
|
9708
9584
|
* if (result.success) {
|
|
@@ -9714,7 +9590,7 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
9714
9590
|
* @example
|
|
9715
9591
|
* ```typescript-client
|
|
9716
9592
|
* // Full example with optional parameters
|
|
9717
|
-
* const result = await finatic.getPositionLotFills({ lotId: '
|
|
9593
|
+
* const result = await finatic.getPositionLotFills({ lotId: 'example-id', connectionId: 'example-id', limit: 0, offset: 0 });
|
|
9718
9594
|
*
|
|
9719
9595
|
* // Handle response with warnings
|
|
9720
9596
|
* if (result.success) {
|
|
@@ -9729,7 +9605,7 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
9729
9605
|
* @example
|
|
9730
9606
|
* ```typescript-server
|
|
9731
9607
|
* // Minimal example with required parameters only
|
|
9732
|
-
* const result = await finatic.getPositionLotFills({ lotId: '
|
|
9608
|
+
* const result = await finatic.getPositionLotFills({ lotId: 'example-id' });
|
|
9733
9609
|
*
|
|
9734
9610
|
* // Access the response data
|
|
9735
9611
|
* if (result.success) {
|
|
@@ -9742,7 +9618,7 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
9742
9618
|
* ```python
|
|
9743
9619
|
* # Minimal example with required parameters only
|
|
9744
9620
|
* result = await finatic.get_position_lot_fills(
|
|
9745
|
-
* lot_id='
|
|
9621
|
+
* lot_id='example'
|
|
9746
9622
|
* )
|
|
9747
9623
|
*
|
|
9748
9624
|
* # Access the response data
|
|
@@ -9755,10 +9631,10 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
9755
9631
|
* ```python
|
|
9756
9632
|
* # Full example with optional parameters
|
|
9757
9633
|
* result = await finatic.get_position_lot_fills(
|
|
9758
|
-
* lot_id='
|
|
9759
|
-
connection_id='
|
|
9760
|
-
limit=
|
|
9761
|
-
offset=
|
|
9634
|
+
* lot_id='example',
|
|
9635
|
+
connection_id='example',
|
|
9636
|
+
limit='example',
|
|
9637
|
+
offset='example'
|
|
9762
9638
|
* )
|
|
9763
9639
|
*
|
|
9764
9640
|
* # Handle response with warnings
|
|
@@ -9774,91 +9650,38 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
9774
9650
|
/**
|
|
9775
9651
|
* Place Order
|
|
9776
9652
|
*
|
|
9777
|
-
*
|
|
9653
|
+
* Place a new order through the specified broker.
|
|
9778
9654
|
*
|
|
9779
|
-
*
|
|
9780
|
-
*
|
|
9781
|
-
*
|
|
9782
|
-
*
|
|
9783
|
-
*
|
|
9784
|
-
*
|
|
9785
|
-
*
|
|
9786
|
-
*
|
|
9787
|
-
*
|
|
9788
|
-
* - ``broker``
|
|
9789
|
-
* - ``account_number``
|
|
9790
|
-
* - ``order_type``
|
|
9791
|
-
* - ``asset_type``
|
|
9792
|
-
* - ``action``
|
|
9793
|
-
* - ``time_in_force``
|
|
9794
|
-
* - ``symbol``
|
|
9795
|
-
* - ``order_qty``
|
|
9796
|
-
*
|
|
9797
|
-
* They are surfaced as *query* parameters **only to make the accepted fields
|
|
9798
|
-
* obvious in the interactive docs**. In production usage you should send these
|
|
9799
|
-
* fields inside the JSON body (see ``order_request``) so that the entire order
|
|
9800
|
-
* specification travels in one payload. (Nothing will break if you send both, but there is no need to do so.)
|
|
9801
|
-
*
|
|
9802
|
-
* Body payload & broker-specific extras
|
|
9803
|
-
* -------------------------------------
|
|
9804
|
-
*
|
|
9805
|
-
* Put the standard parameters plus any broker-specific extensions under the
|
|
9806
|
-
* ``order`` key of the body. Refer to the bundled OpenAPI examples below to
|
|
9807
|
-
* see complete payloads for common order types (market, limit, spreads, etc.)
|
|
9808
|
-
* across supported brokers.
|
|
9809
|
-
*
|
|
9810
|
-
* For a formal reference of broker-specific extensions inspect the
|
|
9811
|
-
* ``BrokerOrderPlaceExtras`` schema.
|
|
9812
|
-
*
|
|
9813
|
-
* The endpoint resolves the active ``user_broker_connection`` by calling the
|
|
9814
|
-
* ``get_user_broker_connection_ids_for_broker`` RPC in Supabase. If no active
|
|
9815
|
-
* connection exists it returns a list of *available* brokers so your client
|
|
9816
|
-
* can guide the user accordingly.
|
|
9817
|
-
*
|
|
9818
|
-
* Broker Notes
|
|
9819
|
-
* ------------
|
|
9820
|
-
* - The responses that you get back from the broker are not always the same.
|
|
9821
|
-
* The response models are validated for each broker, but we do not standardize the repsonses.
|
|
9822
|
-
*
|
|
9823
|
-
* - Tasty Trade: If you want to trade options for a particular stock, first fetch the full
|
|
9824
|
-
* option chain via the GET https://api.tastyworks.com/option-chains/{stock_symbol}/nested endpoint.
|
|
9825
|
-
* This endpoint returns all available expirations that tastytrade offers for that equity symbol.
|
|
9826
|
-
* Each expiration contains a list of strikes, where each strike has a call and put field representing
|
|
9827
|
-
* the call symbol and put symbol respectively.
|
|
9828
|
-
*
|
|
9829
|
-
* We are planning to add a new endpoint to fetch the option chain for a particular stock and
|
|
9830
|
-
* handle this logic for you, but for now you need to fetch the option chain manually.
|
|
9831
|
-
*
|
|
9832
|
-
* Convenience method that delegates to brokers wrapper.
|
|
9833
|
-
*
|
|
9834
|
-
* @param params - Optional parameters object. Only include the fields you want to use.
|
|
9835
|
-
* Example: placeOrder({ accountId: "123", limit: 10, offset: 0 })
|
|
9836
|
-
* @returns FinaticResponse with success, error, and warning fields
|
|
9655
|
+
* Creates an order using the broker connection associated with your account.
|
|
9656
|
+
* The order structure includes common fields (symbol, quantity, order type, etc.)
|
|
9657
|
+
* shared across all brokers, plus broker-specific fields that vary by broker.
|
|
9658
|
+
*
|
|
9659
|
+
* Common order fields include: broker, accountNumber, orderType, assetType,
|
|
9660
|
+
* action, timeInForce, symbol, and orderQty. Additional broker-specific fields
|
|
9661
|
+
* can be included in the order object - see the broker-specific tabs in the
|
|
9662
|
+
* parameters section for details.
|
|
9837
9663
|
* @methodId place_order_api_beta_brokers_orders_post
|
|
9838
9664
|
* @category brokers
|
|
9839
9665
|
* @example
|
|
9840
9666
|
* ```typescript-client
|
|
9841
|
-
* //
|
|
9842
|
-
* const result = await finatic.placeOrder(
|
|
9667
|
+
* // This method requires the following required fields:
|
|
9668
|
+
* const result = await finatic.placeOrder({
|
|
9669
|
+
broker: 'robinhood',
|
|
9670
|
+
order: {
|
|
9671
|
+
orderType: 'market',
|
|
9672
|
+
assetType: 'equity',
|
|
9673
|
+
action: 'buy',
|
|
9674
|
+
timeInForce: 'day',
|
|
9675
|
+
symbol: 'AAPL',
|
|
9676
|
+
orderQty: 10
|
|
9677
|
+
}
|
|
9678
|
+
* });
|
|
9843
9679
|
*
|
|
9844
9680
|
* // Access the response data
|
|
9845
9681
|
* if (result.success) {
|
|
9846
9682
|
* console.log('Data:', result.success.data);
|
|
9847
|
-
* }
|
|
9848
|
-
* ```
|
|
9849
|
-
* @example
|
|
9850
|
-
* ```typescript-client
|
|
9851
|
-
* // Full example with optional parameters
|
|
9852
|
-
* const result = await finatic.placeOrder({ connectionId: '00000000-0000-0000-0000-000000000000' });
|
|
9853
|
-
*
|
|
9854
|
-
* // Handle response with warnings
|
|
9855
|
-
* if (result.success) {
|
|
9856
|
-
* console.log('Data:', result.success.data);
|
|
9857
|
-
* if (result.warning && result.warning.length > 0) {
|
|
9858
|
-
* console.warn('Warnings:', result.warning);
|
|
9859
|
-
* }
|
|
9860
9683
|
* } else if (result.error) {
|
|
9861
|
-
* console.error('Error:', result.error.message
|
|
9684
|
+
* console.error('Error:', result.error.message);
|
|
9862
9685
|
* }
|
|
9863
9686
|
* ```
|
|
9864
9687
|
* @example
|
|
@@ -9884,7 +9707,7 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
9884
9707
|
* ```python
|
|
9885
9708
|
* # Full example with optional parameters
|
|
9886
9709
|
* result = await finatic.place_order(
|
|
9887
|
-
* connection_id='
|
|
9710
|
+
* connection_id='example'
|
|
9888
9711
|
* )
|
|
9889
9712
|
*
|
|
9890
9713
|
* # Handle response with warnings
|
|
@@ -9896,29 +9719,20 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
9896
9719
|
* print('Error:', result.error['message'], result.error['code'])
|
|
9897
9720
|
* ```
|
|
9898
9721
|
*/
|
|
9899
|
-
placeOrder(params
|
|
9722
|
+
placeOrder(params: PlaceOrderParams): Promise<Awaited<ReturnType<typeof this$1.brokers.placeOrder>>>;
|
|
9900
9723
|
/**
|
|
9901
9724
|
* Cancel Order
|
|
9902
9725
|
*
|
|
9903
9726
|
* Cancel an existing order.
|
|
9904
9727
|
*
|
|
9905
|
-
*
|
|
9906
|
-
*
|
|
9907
|
-
*
|
|
9908
|
-
* The order_id is used to identify the order and automatically resolve the
|
|
9909
|
-
* broker connection from the orders table.
|
|
9910
|
-
*
|
|
9911
|
-
* Convenience method that delegates to brokers wrapper.
|
|
9912
|
-
*
|
|
9913
|
-
* @param params - Optional parameters object. Only include the fields you want to use.
|
|
9914
|
-
* Example: cancelOrder({ accountId: "123", limit: 10, offset: 0 })
|
|
9915
|
-
* @returns FinaticResponse with success, error, and warning fields
|
|
9728
|
+
* Cancels an order by its order ID. The broker connection is automatically
|
|
9729
|
+
* resolved from the order record.
|
|
9916
9730
|
* @methodId cancel_order_api_beta_brokers_orders__order_id__delete
|
|
9917
9731
|
* @category brokers
|
|
9918
9732
|
* @example
|
|
9919
9733
|
* ```typescript-client
|
|
9920
9734
|
* // Minimal example with required parameters only
|
|
9921
|
-
* const result = await finatic.cancelOrder({ orderId: '
|
|
9735
|
+
* const result = await finatic.cancelOrder({ orderId: 'example-id' });
|
|
9922
9736
|
*
|
|
9923
9737
|
* // Access the response data
|
|
9924
9738
|
* if (result.success) {
|
|
@@ -9930,7 +9744,7 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
9930
9744
|
* @example
|
|
9931
9745
|
* ```typescript-server
|
|
9932
9746
|
* // Minimal example with required parameters only
|
|
9933
|
-
* const result = await finatic.cancelOrder({ orderId: '
|
|
9747
|
+
* const result = await finatic.cancelOrder({ orderId: 'example-id' });
|
|
9934
9748
|
*
|
|
9935
9749
|
* // Access the response data
|
|
9936
9750
|
* if (result.success) {
|
|
@@ -9943,7 +9757,7 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
9943
9757
|
* ```python
|
|
9944
9758
|
* # Minimal example with required parameters only
|
|
9945
9759
|
* result = await finatic.cancel_order(
|
|
9946
|
-
* order_id='
|
|
9760
|
+
* order_id='example'
|
|
9947
9761
|
* )
|
|
9948
9762
|
*
|
|
9949
9763
|
* # Access the response data
|
|
@@ -9959,20 +9773,15 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
9959
9773
|
*
|
|
9960
9774
|
* Modify an existing order.
|
|
9961
9775
|
*
|
|
9962
|
-
*
|
|
9963
|
-
*
|
|
9964
|
-
*
|
|
9965
|
-
* Convenience method that delegates to brokers wrapper.
|
|
9966
|
-
*
|
|
9967
|
-
* @param params - Optional parameters object. Only include the fields you want to use.
|
|
9968
|
-
* Example: modifyOrder({ accountId: "123", limit: 10, offset: 0 })
|
|
9969
|
-
* @returns FinaticResponse with success, error, and warning fields
|
|
9776
|
+
* Updates an order's parameters (price, quantity, etc.) by order ID.
|
|
9777
|
+
* The order structure follows the same pattern as placing orders, with common
|
|
9778
|
+
* fields shared across brokers and broker-specific fields available per broker.
|
|
9970
9779
|
* @methodId modify_order_api_beta_brokers_orders__order_id__patch
|
|
9971
9780
|
* @category brokers
|
|
9972
9781
|
* @example
|
|
9973
9782
|
* ```typescript-client
|
|
9974
9783
|
* // Minimal example with required parameters only
|
|
9975
|
-
* const result = await finatic.modifyOrder({ orderId: '
|
|
9784
|
+
* const result = await finatic.modifyOrder({ orderId: 'example-id' });
|
|
9976
9785
|
*
|
|
9977
9786
|
* // Access the response data
|
|
9978
9787
|
* if (result.success) {
|
|
@@ -9982,24 +9791,9 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
9982
9791
|
* }
|
|
9983
9792
|
* ```
|
|
9984
9793
|
* @example
|
|
9985
|
-
* ```typescript-client
|
|
9986
|
-
* // Full example with optional parameters
|
|
9987
|
-
* const result = await finatic.modifyOrder({ orderId: 'order_1234567890abcdef', accountNumber: '123456789', connectionId: '00000000-0000-0000-0000-000000000000' });
|
|
9988
|
-
*
|
|
9989
|
-
* // Handle response with warnings
|
|
9990
|
-
* if (result.success) {
|
|
9991
|
-
* console.log('Data:', result.success.data);
|
|
9992
|
-
* if (result.warning && result.warning.length > 0) {
|
|
9993
|
-
* console.warn('Warnings:', result.warning);
|
|
9994
|
-
* }
|
|
9995
|
-
* } else if (result.error) {
|
|
9996
|
-
* console.error('Error:', result.error.message, result.error.code);
|
|
9997
|
-
* }
|
|
9998
|
-
* ```
|
|
9999
|
-
* @example
|
|
10000
9794
|
* ```typescript-server
|
|
10001
9795
|
* // Minimal example with required parameters only
|
|
10002
|
-
* const result = await finatic.modifyOrder({ orderId: '
|
|
9796
|
+
* const result = await finatic.modifyOrder({ orderId: 'example-id' });
|
|
10003
9797
|
*
|
|
10004
9798
|
* // Access the response data
|
|
10005
9799
|
* if (result.success) {
|
|
@@ -10012,7 +9806,7 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
10012
9806
|
* ```python
|
|
10013
9807
|
* # Minimal example with required parameters only
|
|
10014
9808
|
* result = await finatic.modify_order(
|
|
10015
|
-
* order_id='
|
|
9809
|
+
* order_id='example'
|
|
10016
9810
|
* )
|
|
10017
9811
|
*
|
|
10018
9812
|
* # Access the response data
|
|
@@ -10025,9 +9819,9 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
10025
9819
|
* ```python
|
|
10026
9820
|
* # Full example with optional parameters
|
|
10027
9821
|
* result = await finatic.modify_order(
|
|
10028
|
-
* order_id='
|
|
10029
|
-
account_number='
|
|
10030
|
-
connection_id='
|
|
9822
|
+
* order_id='example',
|
|
9823
|
+
account_number='example',
|
|
9824
|
+
connection_id='example'
|
|
10031
9825
|
* )
|
|
10032
9826
|
*
|
|
10033
9827
|
* # Handle response with warnings
|
|
@@ -10055,7 +9849,7 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
10055
9849
|
* @example
|
|
10056
9850
|
* ```typescript-server
|
|
10057
9851
|
* // Get all items with optional filters
|
|
10058
|
-
* const result = await finatic.getAllBalances({ brokerId: '
|
|
9852
|
+
* const result = await finatic.getAllBalances({ brokerId: 'example-id', connectionId: 'example-id', accountId: 'example-id' });
|
|
10059
9853
|
*
|
|
10060
9854
|
* // Access the response data
|
|
10061
9855
|
* if (result.success) {
|
|
@@ -10070,7 +9864,7 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
10070
9864
|
* @example
|
|
10071
9865
|
* ```typescript-client
|
|
10072
9866
|
* // Get all items with optional filters
|
|
10073
|
-
* const result = await finatic.getAllBalances({ brokerId: '
|
|
9867
|
+
* const result = await finatic.getAllBalances({ brokerId: 'example-id', connectionId: 'example-id', accountId: 'example-id' });
|
|
10074
9868
|
*
|
|
10075
9869
|
* // Access the response data
|
|
10076
9870
|
* if (result.success) {
|
|
@@ -10086,9 +9880,9 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
10086
9880
|
* ```python
|
|
10087
9881
|
* # Get all items with optional filters
|
|
10088
9882
|
* result = await finatic.get_all_balances(
|
|
10089
|
-
* broker_id='
|
|
10090
|
-
connection_id='
|
|
10091
|
-
account_id='
|
|
9883
|
+
* broker_id='example',
|
|
9884
|
+
connection_id='example',
|
|
9885
|
+
account_id='example'
|
|
10092
9886
|
* )
|
|
10093
9887
|
*
|
|
10094
9888
|
* # Access the response data
|
|
@@ -10116,7 +9910,7 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
10116
9910
|
* @example
|
|
10117
9911
|
* ```typescript-server
|
|
10118
9912
|
* // Get all items with optional filters
|
|
10119
|
-
* const result = await finatic.getAllAccounts({ brokerId: '
|
|
9913
|
+
* const result = await finatic.getAllAccounts({ brokerId: 'example-id', connectionId: 'example-id', accountType: 'margin' });
|
|
10120
9914
|
*
|
|
10121
9915
|
* // Access the response data
|
|
10122
9916
|
* if (result.success) {
|
|
@@ -10131,7 +9925,7 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
10131
9925
|
* @example
|
|
10132
9926
|
* ```typescript-client
|
|
10133
9927
|
* // Get all items with optional filters
|
|
10134
|
-
* const result = await finatic.getAllAccounts({ brokerId: '
|
|
9928
|
+
* const result = await finatic.getAllAccounts({ brokerId: 'example-id', connectionId: 'example-id', accountType: 'margin' });
|
|
10135
9929
|
*
|
|
10136
9930
|
* // Access the response data
|
|
10137
9931
|
* if (result.success) {
|
|
@@ -10147,8 +9941,8 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
10147
9941
|
* ```python
|
|
10148
9942
|
* # Get all items with optional filters
|
|
10149
9943
|
* result = await finatic.get_all_accounts(
|
|
10150
|
-
* broker_id='
|
|
10151
|
-
connection_id='
|
|
9944
|
+
* broker_id='example',
|
|
9945
|
+
connection_id='example',
|
|
10152
9946
|
account_type='margin'
|
|
10153
9947
|
* )
|
|
10154
9948
|
*
|
|
@@ -10177,7 +9971,7 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
10177
9971
|
* @example
|
|
10178
9972
|
* ```typescript-server
|
|
10179
9973
|
* // Get all items with optional filters
|
|
10180
|
-
* const result = await finatic.getAllOrders({ brokerId: '
|
|
9974
|
+
* const result = await finatic.getAllOrders({ brokerId: 'example-id', connectionId: 'example-id', accountId: 'example-id' });
|
|
10181
9975
|
*
|
|
10182
9976
|
* // Access the response data
|
|
10183
9977
|
* if (result.success) {
|
|
@@ -10192,7 +9986,7 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
10192
9986
|
* @example
|
|
10193
9987
|
* ```typescript-client
|
|
10194
9988
|
* // Get all items with optional filters
|
|
10195
|
-
* const result = await finatic.getAllOrders({ brokerId: '
|
|
9989
|
+
* const result = await finatic.getAllOrders({ brokerId: 'example-id', connectionId: 'example-id', accountId: 'example-id' });
|
|
10196
9990
|
*
|
|
10197
9991
|
* // Access the response data
|
|
10198
9992
|
* if (result.success) {
|
|
@@ -10208,9 +10002,9 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
10208
10002
|
* ```python
|
|
10209
10003
|
* # Get all items with optional filters
|
|
10210
10004
|
* result = await finatic.get_all_orders(
|
|
10211
|
-
* broker_id='
|
|
10212
|
-
connection_id='
|
|
10213
|
-
account_id='
|
|
10005
|
+
* broker_id='example',
|
|
10006
|
+
connection_id='example',
|
|
10007
|
+
account_id='example'
|
|
10214
10008
|
* )
|
|
10215
10009
|
*
|
|
10216
10010
|
* # Access the response data
|
|
@@ -10238,7 +10032,7 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
10238
10032
|
* @example
|
|
10239
10033
|
* ```typescript-server
|
|
10240
10034
|
* // Get all items with optional filters
|
|
10241
|
-
* const result = await finatic.getAllPositions({ brokerId: '
|
|
10035
|
+
* const result = await finatic.getAllPositions({ brokerId: 'example-id', connectionId: 'example-id', accountId: 'example-id' });
|
|
10242
10036
|
*
|
|
10243
10037
|
* // Access the response data
|
|
10244
10038
|
* if (result.success) {
|
|
@@ -10253,7 +10047,7 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
10253
10047
|
* @example
|
|
10254
10048
|
* ```typescript-client
|
|
10255
10049
|
* // Get all items with optional filters
|
|
10256
|
-
* const result = await finatic.getAllPositions({ brokerId: '
|
|
10050
|
+
* const result = await finatic.getAllPositions({ brokerId: 'example-id', connectionId: 'example-id', accountId: 'example-id' });
|
|
10257
10051
|
*
|
|
10258
10052
|
* // Access the response data
|
|
10259
10053
|
* if (result.success) {
|
|
@@ -10269,9 +10063,9 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
10269
10063
|
* ```python
|
|
10270
10064
|
* # Get all items with optional filters
|
|
10271
10065
|
* result = await finatic.get_all_positions(
|
|
10272
|
-
* broker_id='
|
|
10273
|
-
connection_id='
|
|
10274
|
-
account_id='
|
|
10066
|
+
* broker_id='example',
|
|
10067
|
+
connection_id='example',
|
|
10068
|
+
account_id='example'
|
|
10275
10069
|
* )
|
|
10276
10070
|
*
|
|
10277
10071
|
* # Access the response data
|
|
@@ -10299,7 +10093,7 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
10299
10093
|
* @example
|
|
10300
10094
|
* ```typescript-server
|
|
10301
10095
|
* // Get all items with optional filters
|
|
10302
|
-
* const result = await finatic.getAllTransactions({ brokerId: '
|
|
10096
|
+
* const result = await finatic.getAllTransactions({ brokerId: 'example-id', connectionId: 'example-id', accountId: 'example-id' });
|
|
10303
10097
|
*
|
|
10304
10098
|
* // Access the response data
|
|
10305
10099
|
* if (result.success) {
|
|
@@ -10314,7 +10108,7 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
10314
10108
|
* @example
|
|
10315
10109
|
* ```typescript-client
|
|
10316
10110
|
* // Get all items with optional filters
|
|
10317
|
-
* const result = await finatic.getAllTransactions({ brokerId: '
|
|
10111
|
+
* const result = await finatic.getAllTransactions({ brokerId: 'example-id', connectionId: 'example-id', accountId: 'example-id' });
|
|
10318
10112
|
*
|
|
10319
10113
|
* // Access the response data
|
|
10320
10114
|
* if (result.success) {
|
|
@@ -10330,9 +10124,9 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
10330
10124
|
* ```python
|
|
10331
10125
|
* # Get all items with optional filters
|
|
10332
10126
|
* result = await finatic.get_all_transactions(
|
|
10333
|
-
* broker_id='
|
|
10334
|
-
connection_id='
|
|
10335
|
-
account_id='
|
|
10127
|
+
* broker_id='example',
|
|
10128
|
+
connection_id='example',
|
|
10129
|
+
account_id='example'
|
|
10336
10130
|
* )
|
|
10337
10131
|
*
|
|
10338
10132
|
* # Access the response data
|
|
@@ -10360,7 +10154,7 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
10360
10154
|
* @example
|
|
10361
10155
|
* ```typescript-server
|
|
10362
10156
|
* // Get all items with optional filters
|
|
10363
|
-
* const result = await finatic.getAllOrderFills({ connectionId: '
|
|
10157
|
+
* const result = await finatic.getAllOrderFills({ connectionId: 'example-id', includeMetadata: true });
|
|
10364
10158
|
*
|
|
10365
10159
|
* // Access the response data
|
|
10366
10160
|
* if (result.success) {
|
|
@@ -10375,7 +10169,7 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
10375
10169
|
* @example
|
|
10376
10170
|
* ```typescript-client
|
|
10377
10171
|
* // Get all items with optional filters
|
|
10378
|
-
* const result = await finatic.getAllOrderFills({ connectionId: '
|
|
10172
|
+
* const result = await finatic.getAllOrderFills({ connectionId: 'example-id', includeMetadata: true });
|
|
10379
10173
|
*
|
|
10380
10174
|
* // Access the response data
|
|
10381
10175
|
* if (result.success) {
|
|
@@ -10391,8 +10185,8 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
10391
10185
|
* ```python
|
|
10392
10186
|
* # Get all items with optional filters
|
|
10393
10187
|
* result = await finatic.get_all_order_fills(
|
|
10394
|
-
* connection_id='
|
|
10395
|
-
include_metadata=
|
|
10188
|
+
* connection_id='example',
|
|
10189
|
+
include_metadata='example'
|
|
10396
10190
|
* )
|
|
10397
10191
|
*
|
|
10398
10192
|
* # Access the response data
|
|
@@ -10420,7 +10214,7 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
10420
10214
|
* @example
|
|
10421
10215
|
* ```typescript-server
|
|
10422
10216
|
* // Get all items with optional filters
|
|
10423
|
-
* const result = await finatic.getAllOrderEvents({ connectionId: '
|
|
10217
|
+
* const result = await finatic.getAllOrderEvents({ connectionId: 'example-id', includeMetadata: true });
|
|
10424
10218
|
*
|
|
10425
10219
|
* // Access the response data
|
|
10426
10220
|
* if (result.success) {
|
|
@@ -10435,7 +10229,7 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
10435
10229
|
* @example
|
|
10436
10230
|
* ```typescript-client
|
|
10437
10231
|
* // Get all items with optional filters
|
|
10438
|
-
* const result = await finatic.getAllOrderEvents({ connectionId: '
|
|
10232
|
+
* const result = await finatic.getAllOrderEvents({ connectionId: 'example-id', includeMetadata: true });
|
|
10439
10233
|
*
|
|
10440
10234
|
* // Access the response data
|
|
10441
10235
|
* if (result.success) {
|
|
@@ -10451,8 +10245,8 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
10451
10245
|
* ```python
|
|
10452
10246
|
* # Get all items with optional filters
|
|
10453
10247
|
* result = await finatic.get_all_order_events(
|
|
10454
|
-
* connection_id='
|
|
10455
|
-
include_metadata=
|
|
10248
|
+
* connection_id='example',
|
|
10249
|
+
include_metadata='example'
|
|
10456
10250
|
* )
|
|
10457
10251
|
*
|
|
10458
10252
|
* # Access the response data
|
|
@@ -10480,7 +10274,7 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
10480
10274
|
* @example
|
|
10481
10275
|
* ```typescript-server
|
|
10482
10276
|
* // Get all items with optional filters
|
|
10483
|
-
* const result = await finatic.getAllOrderGroups({ brokerId: '
|
|
10277
|
+
* const result = await finatic.getAllOrderGroups({ brokerId: 'example-id', connectionId: 'example-id', createdAfter: 'example' });
|
|
10484
10278
|
*
|
|
10485
10279
|
* // Access the response data
|
|
10486
10280
|
* if (result.success) {
|
|
@@ -10495,7 +10289,7 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
10495
10289
|
* @example
|
|
10496
10290
|
* ```typescript-client
|
|
10497
10291
|
* // Get all items with optional filters
|
|
10498
|
-
* const result = await finatic.getAllOrderGroups({ brokerId: '
|
|
10292
|
+
* const result = await finatic.getAllOrderGroups({ brokerId: 'example-id', connectionId: 'example-id', createdAfter: 'example' });
|
|
10499
10293
|
*
|
|
10500
10294
|
* // Access the response data
|
|
10501
10295
|
* if (result.success) {
|
|
@@ -10511,9 +10305,9 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
10511
10305
|
* ```python
|
|
10512
10306
|
* # Get all items with optional filters
|
|
10513
10307
|
* result = await finatic.get_all_order_groups(
|
|
10514
|
-
* broker_id='
|
|
10515
|
-
connection_id='
|
|
10516
|
-
created_after='
|
|
10308
|
+
* broker_id='example',
|
|
10309
|
+
connection_id='example',
|
|
10310
|
+
created_after='example'
|
|
10517
10311
|
* )
|
|
10518
10312
|
*
|
|
10519
10313
|
* # Access the response data
|
|
@@ -10541,7 +10335,7 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
10541
10335
|
* @example
|
|
10542
10336
|
* ```typescript-server
|
|
10543
10337
|
* // Get all items with optional filters
|
|
10544
|
-
* const result = await finatic.getAllPositionLots({ brokerId: '
|
|
10338
|
+
* const result = await finatic.getAllPositionLots({ brokerId: 'example-id', connectionId: 'example-id', accountId: 'example-id' });
|
|
10545
10339
|
*
|
|
10546
10340
|
* // Access the response data
|
|
10547
10341
|
* if (result.success) {
|
|
@@ -10556,7 +10350,7 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
10556
10350
|
* @example
|
|
10557
10351
|
* ```typescript-client
|
|
10558
10352
|
* // Get all items with optional filters
|
|
10559
|
-
* const result = await finatic.getAllPositionLots({ brokerId: '
|
|
10353
|
+
* const result = await finatic.getAllPositionLots({ brokerId: 'example-id', connectionId: 'example-id', accountId: 'example-id' });
|
|
10560
10354
|
*
|
|
10561
10355
|
* // Access the response data
|
|
10562
10356
|
* if (result.success) {
|
|
@@ -10572,9 +10366,9 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
10572
10366
|
* ```python
|
|
10573
10367
|
* # Get all items with optional filters
|
|
10574
10368
|
* result = await finatic.get_all_position_lots(
|
|
10575
|
-
* broker_id='
|
|
10576
|
-
connection_id='
|
|
10577
|
-
account_id='
|
|
10369
|
+
* broker_id='example',
|
|
10370
|
+
connection_id='example',
|
|
10371
|
+
account_id='example'
|
|
10578
10372
|
* )
|
|
10579
10373
|
*
|
|
10580
10374
|
* # Access the response data
|
|
@@ -10602,7 +10396,7 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
10602
10396
|
* @example
|
|
10603
10397
|
* ```typescript-server
|
|
10604
10398
|
* // Get all items with optional filters
|
|
10605
|
-
* const result = await finatic.getAllPositionLotFills({ connectionId: '
|
|
10399
|
+
* const result = await finatic.getAllPositionLotFills({ connectionId: 'example-id' });
|
|
10606
10400
|
*
|
|
10607
10401
|
* // Access the response data
|
|
10608
10402
|
* if (result.success) {
|
|
@@ -10617,7 +10411,7 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
10617
10411
|
* @example
|
|
10618
10412
|
* ```typescript-client
|
|
10619
10413
|
* // Get all items with optional filters
|
|
10620
|
-
* const result = await finatic.getAllPositionLotFills({ connectionId: '
|
|
10414
|
+
* const result = await finatic.getAllPositionLotFills({ connectionId: 'example-id' });
|
|
10621
10415
|
*
|
|
10622
10416
|
* // Access the response data
|
|
10623
10417
|
* if (result.success) {
|
|
@@ -10633,7 +10427,7 @@ declare class FinaticConnect$1 extends EventEmitter {
|
|
|
10633
10427
|
* ```python
|
|
10634
10428
|
* # Get all items with optional filters
|
|
10635
10429
|
* result = await finatic.get_all_position_lot_fills(
|
|
10636
|
-
* connection_id='
|
|
10430
|
+
* connection_id='example'
|
|
10637
10431
|
* )
|
|
10638
10432
|
*
|
|
10639
10433
|
* # Access the response data
|
|
@@ -10667,5 +10461,5 @@ declare class FinaticConnect extends FinaticConnect$1 {
|
|
|
10667
10461
|
static readonly __CUSTOM_CLASS__ = true;
|
|
10668
10462
|
}
|
|
10669
10463
|
|
|
10670
|
-
export { ApiError, BrokerDataAccountTypeEnum, BrokerDataAssetTypeEnum, BrokerDataOptionTypeEnum, BrokerDataOrderSideEnum, BrokerDataPositionStatusEnum, BrokersWrapper, CompanyWrapper, Configuration, DayTIFTimeInForceEnum, EventEmitter, FDXAssetType, FDXOrderClass, FDXOrderEventType, FDXOrderGroupType, FDXOrderSide, FDXOrderStatus, FDXOrderType, FDXPositionSide, FDXPositionStatus, FDXSecurityIdType, FDXTimeInForce, FOKTIFTimeInForceEnum, FinaticBrokerFactoryBrokersRobinhoodExecutorsConsumerRobinhoodOrderModifyQueryParamsRobinhoodOptionSpreadLegEffectEnum, FinaticBrokerFactoryBrokersRobinhoodExecutorsConsumerRobinhoodOrderPlaceQueryParamsRobinhoodOptionSpreadLegPositionEffectEnum, FinaticConnect, FinaticError, GTCTIFTimeInForceEnum, GTDTIFTimeInForceEnum, IOCTIFTimeInForceEnum, NinjaTraderLimitOrderModifyQueryParamsAssetTypeEnum, NinjaTraderLimitOrderModifyQueryParamsOrderTypeEnum, NinjaTraderLimitOrderPlaceQueryParamsActionEnum, NinjaTraderLimitOrderPlaceQueryParamsAssetTypeEnum, NinjaTraderLimitOrderPlaceQueryParamsOrderTypeEnum, NinjaTraderMarketOrderModifyQueryParamsAssetTypeEnum, NinjaTraderMarketOrderModifyQueryParamsOrderTypeEnum, NinjaTraderMarketOrderPlaceQueryParamsActionEnum, NinjaTraderMarketOrderPlaceQueryParamsAssetTypeEnum, NinjaTraderMarketOrderPlaceQueryParamsOrderTypeEnum, NinjaTraderOrderModifyRequestBrokerEnum, NinjaTraderOrderPlaceRequestBrokerEnum, NinjaTraderStopOrderModifyQueryParamsAssetTypeEnum, NinjaTraderStopOrderModifyQueryParamsOrderTypeEnum, NinjaTraderStopOrderPlaceQueryParamsActionEnum, NinjaTraderStopOrderPlaceQueryParamsAssetTypeEnum, NinjaTraderStopOrderPlaceQueryParamsOrderTypeEnum, NinjaTraderTrailingStopOrderModifyQueryParamsAssetTypeEnum, NinjaTraderTrailingStopOrderModifyQueryParamsOrderTypeEnum, NinjaTraderTrailingStopOrderPlaceQueryParamsActionEnum, NinjaTraderTrailingStopOrderPlaceQueryParamsAssetTypeEnum, NinjaTraderTrailingStopOrderPlaceQueryParamsOrderTypeEnum, Order1ActionEnum, Order1AmountInEnum, Order1AssetTypeEnum, Order1CreditOrDebitEnum, Order1DirectionEnum, Order1MarketHoursEnum, Order1OptionTypeEnum, Order1OrderTypeEnum, Order1PositionEffectEnum, PaginatedData, RobinhoodCryptoLimitOrderPlaceQueryParamsActionEnum, RobinhoodCryptoLimitOrderPlaceQueryParamsAmountInEnum, RobinhoodCryptoLimitOrderPlaceQueryParamsAssetTypeEnum, RobinhoodCryptoLimitOrderPlaceQueryParamsOrderTypeEnum, RobinhoodCryptoMarketOrderPlaceQueryParamsActionEnum, RobinhoodCryptoMarketOrderPlaceQueryParamsAmountInEnum, RobinhoodCryptoMarketOrderPlaceQueryParamsAssetTypeEnum, RobinhoodCryptoMarketOrderPlaceQueryParamsOrderTypeEnum, RobinhoodCryptoStopLimitOrderPlaceQueryParamsActionEnum, RobinhoodCryptoStopLimitOrderPlaceQueryParamsAmountInEnum, RobinhoodCryptoStopLimitOrderPlaceQueryParamsAssetTypeEnum, RobinhoodCryptoStopLimitOrderPlaceQueryParamsOrderTypeEnum, RobinhoodCryptoStopOrderPlaceQueryParamsActionEnum, RobinhoodCryptoStopOrderPlaceQueryParamsAmountInEnum, RobinhoodCryptoStopOrderPlaceQueryParamsAssetTypeEnum, RobinhoodCryptoStopOrderPlaceQueryParamsOrderTypeEnum, RobinhoodCryptoTrailingStopOrderPlaceQueryParamsActionEnum, RobinhoodCryptoTrailingStopOrderPlaceQueryParamsAmountInEnum, RobinhoodCryptoTrailingStopOrderPlaceQueryParamsAssetTypeEnum, RobinhoodCryptoTrailingStopOrderPlaceQueryParamsOrderTypeEnum, RobinhoodEquityLimitOrderPlaceQueryParamsActionEnum, RobinhoodEquityLimitOrderPlaceQueryParamsAssetTypeEnum, RobinhoodEquityLimitOrderPlaceQueryParamsMarketHoursEnum, RobinhoodEquityLimitOrderPlaceQueryParamsOrderTypeEnum, RobinhoodEquityMarketOrderPlaceQueryParamsActionEnum, RobinhoodEquityMarketOrderPlaceQueryParamsAssetTypeEnum, RobinhoodEquityMarketOrderPlaceQueryParamsMarketHoursEnum, RobinhoodEquityMarketOrderPlaceQueryParamsOrderTypeEnum, RobinhoodEquityStopLimitOrderPlaceQueryParamsActionEnum, RobinhoodEquityStopLimitOrderPlaceQueryParamsAssetTypeEnum, RobinhoodEquityStopLimitOrderPlaceQueryParamsMarketHoursEnum, RobinhoodEquityStopLimitOrderPlaceQueryParamsOrderTypeEnum, RobinhoodEquityStopOrderPlaceQueryParamsActionEnum, RobinhoodEquityStopOrderPlaceQueryParamsAssetTypeEnum, RobinhoodEquityStopOrderPlaceQueryParamsMarketHoursEnum, RobinhoodEquityStopOrderPlaceQueryParamsOrderTypeEnum, RobinhoodEquityTrailingStopOrderPlaceQueryParamsActionEnum, RobinhoodEquityTrailingStopOrderPlaceQueryParamsAssetTypeEnum, RobinhoodEquityTrailingStopOrderPlaceQueryParamsMarketHoursEnum, RobinhoodEquityTrailingStopOrderPlaceQueryParamsOrderTypeEnum, RobinhoodLimitOrderModifyQueryParamsAmountInEnum, RobinhoodLimitOrderModifyQueryParamsAssetTypeEnum, RobinhoodLimitOrderModifyQueryParamsCreditOrDebitEnum, RobinhoodLimitOrderModifyQueryParamsDirectionEnum, RobinhoodLimitOrderModifyQueryParamsMarketHoursEnum, RobinhoodLimitOrderModifyQueryParamsOptionTypeEnum, RobinhoodLimitOrderModifyQueryParamsOrderTypeEnum, RobinhoodLimitOrderModifyQueryParamsPositionEffectEnum, RobinhoodMarketOrderModifyQueryParamsAmountInEnum, RobinhoodMarketOrderModifyQueryParamsAssetTypeEnum, RobinhoodMarketOrderModifyQueryParamsCreditOrDebitEnum, RobinhoodMarketOrderModifyQueryParamsDirectionEnum, RobinhoodMarketOrderModifyQueryParamsMarketHoursEnum, RobinhoodMarketOrderModifyQueryParamsOptionTypeEnum, RobinhoodMarketOrderModifyQueryParamsOrderTypeEnum, RobinhoodMarketOrderModifyQueryParamsPositionEffectEnum, RobinhoodOptionLimitOrderPlaceQueryParamsActionEnum, RobinhoodOptionLimitOrderPlaceQueryParamsAssetTypeEnum, RobinhoodOptionLimitOrderPlaceQueryParamsCreditOrDebitEnum, RobinhoodOptionLimitOrderPlaceQueryParamsDirectionEnum, RobinhoodOptionLimitOrderPlaceQueryParamsOptionTypeEnum, RobinhoodOptionLimitOrderPlaceQueryParamsOrderTypeEnum, RobinhoodOptionLimitOrderPlaceQueryParamsPositionEffectEnum, RobinhoodOptionMarketOrderPlaceQueryParamsActionEnum, RobinhoodOptionMarketOrderPlaceQueryParamsAssetTypeEnum, RobinhoodOptionMarketOrderPlaceQueryParamsCreditOrDebitEnum, RobinhoodOptionMarketOrderPlaceQueryParamsDirectionEnum, RobinhoodOptionMarketOrderPlaceQueryParamsOptionTypeEnum, RobinhoodOptionMarketOrderPlaceQueryParamsOrderTypeEnum, RobinhoodOptionMarketOrderPlaceQueryParamsPositionEffectEnum, RobinhoodOptionStopLimitOrderPlaceQueryParamsActionEnum, RobinhoodOptionStopLimitOrderPlaceQueryParamsAssetTypeEnum, RobinhoodOptionStopLimitOrderPlaceQueryParamsCreditOrDebitEnum, RobinhoodOptionStopLimitOrderPlaceQueryParamsDirectionEnum, RobinhoodOptionStopLimitOrderPlaceQueryParamsOptionTypeEnum, RobinhoodOptionStopLimitOrderPlaceQueryParamsOrderTypeEnum, RobinhoodOptionStopLimitOrderPlaceQueryParamsPositionEffectEnum, RobinhoodOptionStopOrderPlaceQueryParamsActionEnum, RobinhoodOptionStopOrderPlaceQueryParamsAssetTypeEnum, RobinhoodOptionStopOrderPlaceQueryParamsCreditOrDebitEnum, RobinhoodOptionStopOrderPlaceQueryParamsDirectionEnum, RobinhoodOptionStopOrderPlaceQueryParamsOptionTypeEnum, RobinhoodOptionStopOrderPlaceQueryParamsOrderTypeEnum, RobinhoodOptionStopOrderPlaceQueryParamsPositionEffectEnum, RobinhoodOptionTrailingStopOrderPlaceQueryParamsActionEnum, RobinhoodOptionTrailingStopOrderPlaceQueryParamsAssetTypeEnum, RobinhoodOptionTrailingStopOrderPlaceQueryParamsCreditOrDebitEnum, RobinhoodOptionTrailingStopOrderPlaceQueryParamsDirectionEnum, RobinhoodOptionTrailingStopOrderPlaceQueryParamsOptionTypeEnum, RobinhoodOptionTrailingStopOrderPlaceQueryParamsOrderTypeEnum, RobinhoodOptionTrailingStopOrderPlaceQueryParamsPositionEffectEnum, RobinhoodOrderModifyRequestBrokerEnum, RobinhoodOrderPlaceRequestBrokerEnum, RobinhoodStopOrderModifyQueryParamsAmountInEnum, RobinhoodStopOrderModifyQueryParamsAssetTypeEnum, RobinhoodStopOrderModifyQueryParamsCreditOrDebitEnum, RobinhoodStopOrderModifyQueryParamsDirectionEnum, RobinhoodStopOrderModifyQueryParamsMarketHoursEnum, RobinhoodStopOrderModifyQueryParamsOptionTypeEnum, RobinhoodStopOrderModifyQueryParamsOrderTypeEnum, RobinhoodStopOrderModifyQueryParamsPositionEffectEnum, RobinhoodTrailingStopOrderModifyQueryParamsAmountInEnum, RobinhoodTrailingStopOrderModifyQueryParamsAssetTypeEnum, RobinhoodTrailingStopOrderModifyQueryParamsCreditOrDebitEnum, RobinhoodTrailingStopOrderModifyQueryParamsDirectionEnum, RobinhoodTrailingStopOrderModifyQueryParamsMarketHoursEnum, RobinhoodTrailingStopOrderModifyQueryParamsOptionTypeEnum, RobinhoodTrailingStopOrderModifyQueryParamsOrderTypeEnum, RobinhoodTrailingStopOrderModifyQueryParamsPositionEffectEnum, SessionStatus, SessionWrapper, TastyTradeLimitOrderModifyQueryParamsAssetTypeEnum, TastyTradeLimitOrderModifyQueryParamsOrderTypeEnum, TastyTradeLimitOrderPlaceQueryParamsActionEnum, TastyTradeLimitOrderPlaceQueryParamsAssetTypeEnum, TastyTradeLimitOrderPlaceQueryParamsOrderTypeEnum, TastyTradeLimitOrderPlaceQueryParamsPriceEffectEnum, TastyTradeLimitOrderPlaceQueryParamsValueEffectEnum, TastyTradeMarketOrderModifyQueryParamsAssetTypeEnum, TastyTradeMarketOrderModifyQueryParamsOrderTypeEnum, TastyTradeMarketOrderPlaceQueryParamsActionEnum, TastyTradeMarketOrderPlaceQueryParamsAssetTypeEnum, TastyTradeMarketOrderPlaceQueryParamsOrderTypeEnum, TastyTradeMarketOrderPlaceQueryParamsPriceEffectEnum, TastyTradeMarketOrderPlaceQueryParamsValueEffectEnum, TastyTradeOrderModifyRequestBrokerEnum, TastyTradeOrderPlaceRequestBrokerEnum, TastyTradeStopOrderModifyQueryParamsAssetTypeEnum, TastyTradeStopOrderModifyQueryParamsOrderTypeEnum, TastyTradeStopOrderPlaceQueryParamsActionEnum, TastyTradeStopOrderPlaceQueryParamsAssetTypeEnum, TastyTradeStopOrderPlaceQueryParamsOrderTypeEnum, TastyTradeStopOrderPlaceQueryParamsPriceEffectEnum, TastyTradeStopOrderPlaceQueryParamsValueEffectEnum, TastyTradeTrailingStopOrderModifyQueryParamsAssetTypeEnum, TastyTradeTrailingStopOrderModifyQueryParamsOrderTypeEnum, TastyTradeTrailingStopOrderPlaceQueryParamsActionEnum, TastyTradeTrailingStopOrderPlaceQueryParamsAssetTypeEnum, TastyTradeTrailingStopOrderPlaceQueryParamsOrderTypeEnum, TastyTradeTrailingStopOrderPlaceQueryParamsPriceEffectEnum, TastyTradeTrailingStopOrderPlaceQueryParamsValueEffectEnum, ValidationError, addErrorInterceptor, addRequestInterceptor, addResponseInterceptor, appendBrokerFilterToURL, appendThemeToURL, applyErrorInterceptors, applyRequestInterceptors, applyResponseInterceptors, coerceEnumValue, convertToPlainObject, defaultConfig, generateCacheKey, generateRequestId, getCache, getConfig, getLogger, handleError, numberSchema, retryApiCall, stringSchema, unwrapAxiosResponse, validateParams };
|
|
10671
|
-
export type { Accountnumber, Accounts, ValidationError$1 as ApiValidationError, Assettype, Availablebalance, Availabletowithdraw, Averagebuyprice, Averagefillprice, Averagesellprice, BrokerInfo, Buyingpower, Cashbalance, Closedquantity, Closepriceavg, Commission, Commission1, Commissionshare, ConfigurationParameters, Costbasis, Costbasis1, Costbasiswithcommission, Costbasiswithcommission1, Currentbalance, Currentprice, DayTIF, DisconnectCompanyFromBrokerConnectionResult, ErrorInterceptor, Eventtype, FDXBrokerOrder, FDXBrokerOrderEvent, FDXBrokerOrderFill, FDXBrokerOrderGroup, FDXBrokerPosition, FDXBrokerPositionLot, FDXBrokerPositionLotFill, FDXBrokerTransaction, FDXOrderGroupOrder, FDXOrderLeg, FOKTIF, Filledquantity, Fillprice, Fillquantity, FinaticAPIErrorResponse, FinaticBrokerFactoryBrokersRobinhoodExecutorsConsumerRobinhoodOrderModifyQueryParamsRobinhoodOptionSpreadLeg,
|
|
10464
|
+
export { ApiError, BrokerDataAccountTypeEnum, BrokerDataAssetTypeEnum, BrokerDataOptionTypeEnum, BrokerDataOrderSideEnum, BrokerDataPositionStatusEnum, BrokersWrapper, CompanyWrapper, Configuration, DayTIFTimeInForceEnum, EventEmitter, FDXAssetType, FDXOrderClass, FDXOrderEventType, FDXOrderGroupType, FDXOrderSide, FDXOrderStatus, FDXOrderType, FDXPositionSide, FDXPositionStatus, FDXSecurityIdType, FDXTimeInForce, FOKTIFTimeInForceEnum, FinaticBrokerFactoryBrokersRobinhoodExecutorsConsumerRobinhoodOrderModifyQueryParamsRobinhoodOptionSpreadLegEffectEnum, FinaticConnect, FinaticError, GTCTIFTimeInForceEnum, GTDTIFTimeInForceEnum, IOCTIFTimeInForceEnum, NinjaTraderLimitOrderModifyQueryParamsAssetTypeEnum, NinjaTraderLimitOrderModifyQueryParamsOrderTypeEnum, NinjaTraderLimitOrderPlaceQueryParamsActionEnum, NinjaTraderLimitOrderPlaceQueryParamsAssetTypeEnum, NinjaTraderLimitOrderPlaceQueryParamsOrderTypeEnum, NinjaTraderMarketOrderModifyQueryParamsAssetTypeEnum, NinjaTraderMarketOrderModifyQueryParamsOrderTypeEnum, NinjaTraderMarketOrderPlaceQueryParamsActionEnum, NinjaTraderMarketOrderPlaceQueryParamsAssetTypeEnum, NinjaTraderMarketOrderPlaceQueryParamsOrderTypeEnum, NinjaTraderOrderModifyRequestBrokerEnum, NinjaTraderOrderPlaceRequestBrokerEnum, NinjaTraderStopOrderModifyQueryParamsAssetTypeEnum, NinjaTraderStopOrderModifyQueryParamsOrderTypeEnum, NinjaTraderStopOrderPlaceQueryParamsActionEnum, NinjaTraderStopOrderPlaceQueryParamsAssetTypeEnum, NinjaTraderStopOrderPlaceQueryParamsOrderTypeEnum, NinjaTraderTrailingStopOrderModifyQueryParamsAssetTypeEnum, NinjaTraderTrailingStopOrderModifyQueryParamsOrderTypeEnum, NinjaTraderTrailingStopOrderPlaceQueryParamsActionEnum, NinjaTraderTrailingStopOrderPlaceQueryParamsAssetTypeEnum, NinjaTraderTrailingStopOrderPlaceQueryParamsOrderTypeEnum, Order1ActionEnum, Order1AmountInEnum, Order1AssetTypeEnum, Order1CreditOrDebitEnum, Order1DirectionEnum, Order1MarketHoursEnum, Order1OptionTypeEnum, Order1OrderTypeEnum, Order1PositionEffectEnum, PaginatedData, RobinhoodCryptoLimitOrderPlaceQueryParamsActionEnum, RobinhoodCryptoLimitOrderPlaceQueryParamsAmountInEnum, RobinhoodCryptoLimitOrderPlaceQueryParamsAssetTypeEnum, RobinhoodCryptoLimitOrderPlaceQueryParamsOrderTypeEnum, RobinhoodCryptoMarketOrderPlaceQueryParamsActionEnum, RobinhoodCryptoMarketOrderPlaceQueryParamsAmountInEnum, RobinhoodCryptoMarketOrderPlaceQueryParamsAssetTypeEnum, RobinhoodCryptoMarketOrderPlaceQueryParamsOrderTypeEnum, RobinhoodCryptoStopLimitOrderPlaceQueryParamsActionEnum, RobinhoodCryptoStopLimitOrderPlaceQueryParamsAmountInEnum, RobinhoodCryptoStopLimitOrderPlaceQueryParamsAssetTypeEnum, RobinhoodCryptoStopLimitOrderPlaceQueryParamsOrderTypeEnum, RobinhoodCryptoStopOrderPlaceQueryParamsActionEnum, RobinhoodCryptoStopOrderPlaceQueryParamsAmountInEnum, RobinhoodCryptoStopOrderPlaceQueryParamsAssetTypeEnum, RobinhoodCryptoStopOrderPlaceQueryParamsOrderTypeEnum, RobinhoodCryptoTrailingStopOrderPlaceQueryParamsActionEnum, RobinhoodCryptoTrailingStopOrderPlaceQueryParamsAmountInEnum, RobinhoodCryptoTrailingStopOrderPlaceQueryParamsAssetTypeEnum, RobinhoodCryptoTrailingStopOrderPlaceQueryParamsOrderTypeEnum, RobinhoodEquityLimitOrderPlaceQueryParamsActionEnum, RobinhoodEquityLimitOrderPlaceQueryParamsAssetTypeEnum, RobinhoodEquityLimitOrderPlaceQueryParamsMarketHoursEnum, RobinhoodEquityLimitOrderPlaceQueryParamsOrderTypeEnum, RobinhoodEquityMarketOrderPlaceQueryParamsActionEnum, RobinhoodEquityMarketOrderPlaceQueryParamsAssetTypeEnum, RobinhoodEquityMarketOrderPlaceQueryParamsMarketHoursEnum, RobinhoodEquityMarketOrderPlaceQueryParamsOrderTypeEnum, RobinhoodEquityStopLimitOrderPlaceQueryParamsActionEnum, RobinhoodEquityStopLimitOrderPlaceQueryParamsAssetTypeEnum, RobinhoodEquityStopLimitOrderPlaceQueryParamsMarketHoursEnum, RobinhoodEquityStopLimitOrderPlaceQueryParamsOrderTypeEnum, RobinhoodEquityStopOrderPlaceQueryParamsActionEnum, RobinhoodEquityStopOrderPlaceQueryParamsAssetTypeEnum, RobinhoodEquityStopOrderPlaceQueryParamsMarketHoursEnum, RobinhoodEquityStopOrderPlaceQueryParamsOrderTypeEnum, RobinhoodEquityTrailingStopOrderPlaceQueryParamsActionEnum, RobinhoodEquityTrailingStopOrderPlaceQueryParamsAssetTypeEnum, RobinhoodEquityTrailingStopOrderPlaceQueryParamsMarketHoursEnum, RobinhoodEquityTrailingStopOrderPlaceQueryParamsOrderTypeEnum, RobinhoodLimitOrderModifyQueryParamsAmountInEnum, RobinhoodLimitOrderModifyQueryParamsAssetTypeEnum, RobinhoodLimitOrderModifyQueryParamsCreditOrDebitEnum, RobinhoodLimitOrderModifyQueryParamsDirectionEnum, RobinhoodLimitOrderModifyQueryParamsMarketHoursEnum, RobinhoodLimitOrderModifyQueryParamsOptionTypeEnum, RobinhoodLimitOrderModifyQueryParamsOrderTypeEnum, RobinhoodLimitOrderModifyQueryParamsPositionEffectEnum, RobinhoodMarketOrderModifyQueryParamsAmountInEnum, RobinhoodMarketOrderModifyQueryParamsAssetTypeEnum, RobinhoodMarketOrderModifyQueryParamsCreditOrDebitEnum, RobinhoodMarketOrderModifyQueryParamsDirectionEnum, RobinhoodMarketOrderModifyQueryParamsMarketHoursEnum, RobinhoodMarketOrderModifyQueryParamsOptionTypeEnum, RobinhoodMarketOrderModifyQueryParamsOrderTypeEnum, RobinhoodMarketOrderModifyQueryParamsPositionEffectEnum, RobinhoodOptionLimitOrderPlaceQueryParamsActionEnum, RobinhoodOptionLimitOrderPlaceQueryParamsAssetTypeEnum, RobinhoodOptionLimitOrderPlaceQueryParamsCreditOrDebitEnum, RobinhoodOptionLimitOrderPlaceQueryParamsDirectionEnum, RobinhoodOptionLimitOrderPlaceQueryParamsOptionTypeEnum, RobinhoodOptionLimitOrderPlaceQueryParamsOrderTypeEnum, RobinhoodOptionLimitOrderPlaceQueryParamsPositionEffectEnum, RobinhoodOptionMarketOrderPlaceQueryParamsActionEnum, RobinhoodOptionMarketOrderPlaceQueryParamsAssetTypeEnum, RobinhoodOptionMarketOrderPlaceQueryParamsCreditOrDebitEnum, RobinhoodOptionMarketOrderPlaceQueryParamsDirectionEnum, RobinhoodOptionMarketOrderPlaceQueryParamsOptionTypeEnum, RobinhoodOptionMarketOrderPlaceQueryParamsOrderTypeEnum, RobinhoodOptionMarketOrderPlaceQueryParamsPositionEffectEnum, RobinhoodOptionSpreadLegPositionEffectEnum, RobinhoodOptionStopLimitOrderPlaceQueryParamsActionEnum, RobinhoodOptionStopLimitOrderPlaceQueryParamsAssetTypeEnum, RobinhoodOptionStopLimitOrderPlaceQueryParamsCreditOrDebitEnum, RobinhoodOptionStopLimitOrderPlaceQueryParamsDirectionEnum, RobinhoodOptionStopLimitOrderPlaceQueryParamsOptionTypeEnum, RobinhoodOptionStopLimitOrderPlaceQueryParamsOrderTypeEnum, RobinhoodOptionStopLimitOrderPlaceQueryParamsPositionEffectEnum, RobinhoodOptionStopOrderPlaceQueryParamsActionEnum, RobinhoodOptionStopOrderPlaceQueryParamsAssetTypeEnum, RobinhoodOptionStopOrderPlaceQueryParamsCreditOrDebitEnum, RobinhoodOptionStopOrderPlaceQueryParamsDirectionEnum, RobinhoodOptionStopOrderPlaceQueryParamsOptionTypeEnum, RobinhoodOptionStopOrderPlaceQueryParamsOrderTypeEnum, RobinhoodOptionStopOrderPlaceQueryParamsPositionEffectEnum, RobinhoodOptionTrailingStopOrderPlaceQueryParamsActionEnum, RobinhoodOptionTrailingStopOrderPlaceQueryParamsAssetTypeEnum, RobinhoodOptionTrailingStopOrderPlaceQueryParamsCreditOrDebitEnum, RobinhoodOptionTrailingStopOrderPlaceQueryParamsDirectionEnum, RobinhoodOptionTrailingStopOrderPlaceQueryParamsOptionTypeEnum, RobinhoodOptionTrailingStopOrderPlaceQueryParamsOrderTypeEnum, RobinhoodOptionTrailingStopOrderPlaceQueryParamsPositionEffectEnum, RobinhoodOrderModifyRequestBrokerEnum, RobinhoodOrderPlaceRequestBrokerEnum, RobinhoodStopOrderModifyQueryParamsAmountInEnum, RobinhoodStopOrderModifyQueryParamsAssetTypeEnum, RobinhoodStopOrderModifyQueryParamsCreditOrDebitEnum, RobinhoodStopOrderModifyQueryParamsDirectionEnum, RobinhoodStopOrderModifyQueryParamsMarketHoursEnum, RobinhoodStopOrderModifyQueryParamsOptionTypeEnum, RobinhoodStopOrderModifyQueryParamsOrderTypeEnum, RobinhoodStopOrderModifyQueryParamsPositionEffectEnum, RobinhoodTrailingStopOrderModifyQueryParamsAmountInEnum, RobinhoodTrailingStopOrderModifyQueryParamsAssetTypeEnum, RobinhoodTrailingStopOrderModifyQueryParamsCreditOrDebitEnum, RobinhoodTrailingStopOrderModifyQueryParamsDirectionEnum, RobinhoodTrailingStopOrderModifyQueryParamsMarketHoursEnum, RobinhoodTrailingStopOrderModifyQueryParamsOptionTypeEnum, RobinhoodTrailingStopOrderModifyQueryParamsOrderTypeEnum, RobinhoodTrailingStopOrderModifyQueryParamsPositionEffectEnum, SessionStatus, SessionWrapper, TastyTradeLimitOrderModifyQueryParamsAssetTypeEnum, TastyTradeLimitOrderModifyQueryParamsOrderTypeEnum, TastyTradeLimitOrderPlaceQueryParamsActionEnum, TastyTradeLimitOrderPlaceQueryParamsAssetTypeEnum, TastyTradeLimitOrderPlaceQueryParamsOrderTypeEnum, TastyTradeLimitOrderPlaceQueryParamsPriceEffectEnum, TastyTradeLimitOrderPlaceQueryParamsValueEffectEnum, TastyTradeMarketOrderModifyQueryParamsAssetTypeEnum, TastyTradeMarketOrderModifyQueryParamsOrderTypeEnum, TastyTradeMarketOrderPlaceQueryParamsActionEnum, TastyTradeMarketOrderPlaceQueryParamsAssetTypeEnum, TastyTradeMarketOrderPlaceQueryParamsOrderTypeEnum, TastyTradeMarketOrderPlaceQueryParamsPriceEffectEnum, TastyTradeMarketOrderPlaceQueryParamsValueEffectEnum, TastyTradeOrderModifyRequestBrokerEnum, TastyTradeOrderPlaceRequestBrokerEnum, TastyTradeStopOrderModifyQueryParamsAssetTypeEnum, TastyTradeStopOrderModifyQueryParamsOrderTypeEnum, TastyTradeStopOrderPlaceQueryParamsActionEnum, TastyTradeStopOrderPlaceQueryParamsAssetTypeEnum, TastyTradeStopOrderPlaceQueryParamsOrderTypeEnum, TastyTradeStopOrderPlaceQueryParamsPriceEffectEnum, TastyTradeStopOrderPlaceQueryParamsValueEffectEnum, TastyTradeTrailingStopOrderModifyQueryParamsAssetTypeEnum, TastyTradeTrailingStopOrderModifyQueryParamsOrderTypeEnum, TastyTradeTrailingStopOrderPlaceQueryParamsActionEnum, TastyTradeTrailingStopOrderPlaceQueryParamsAssetTypeEnum, TastyTradeTrailingStopOrderPlaceQueryParamsOrderTypeEnum, TastyTradeTrailingStopOrderPlaceQueryParamsPriceEffectEnum, TastyTradeTrailingStopOrderPlaceQueryParamsValueEffectEnum, ValidationError, addErrorInterceptor, addRequestInterceptor, addResponseInterceptor, appendBrokerFilterToURL, appendThemeToURL, applyErrorInterceptors, applyRequestInterceptors, applyResponseInterceptors, coerceEnumValue, convertToPlainObject, defaultConfig, generateCacheKey, generateRequestId, getCache, getConfig, getLogger, handleError, numberSchema, retryApiCall, stringSchema, unwrapAxiosResponse, validateParams };
|
|
10465
|
+
export type { Accountnumber, Accounts, ValidationError$1 as ApiValidationError, Assettype, Availablebalance, Availabletowithdraw, Averagebuyprice, Averagefillprice, Averagesellprice, BrokerInfo, Buyingpower, Cashbalance, Closedquantity, Closepriceavg, Commission, Commission1, Commissionshare, ConfigurationParameters, Costbasis, Costbasis1, Costbasiswithcommission, Costbasiswithcommission1, Currentbalance, Currentprice, DayTIF, DisconnectCompanyFromBrokerConnectionResult, ErrorInterceptor, Eventtype, FDXBrokerOrder, FDXBrokerOrderEvent, FDXBrokerOrderFill, FDXBrokerOrderGroup, FDXBrokerPosition, FDXBrokerPositionLot, FDXBrokerPositionLotFill, FDXBrokerTransaction, FDXOrderGroupOrder, FDXOrderLeg, FOKTIF, Filledquantity, Fillprice, Fillquantity, FinaticAPIErrorResponse, FinaticBrokerFactoryBrokersRobinhoodExecutorsConsumerRobinhoodOrderModifyQueryParamsRobinhoodOptionSpreadLeg, FinaticConnectOptions, FinaticResponse$3 as FinaticResponse, FinaticResponseAccounts, FinaticResponseDisconnectCompanyFromBrokerConnectionResult, FinaticResponseListBrokerInfo, FinaticResponseListFDXBrokerOrder, FinaticResponseListFDXBrokerOrderEvent, FinaticResponseListFDXBrokerOrderFill, FinaticResponseListFDXBrokerOrderGroup, FinaticResponseListFDXBrokerPosition, FinaticResponseListFDXBrokerPositionLot, FinaticResponseListFDXBrokerPositionLotFill, FinaticResponseListFDXBrokerTransaction, FinaticResponseListLegacyBrokerAccount, FinaticResponseListLegacyBrokerBalance, FinaticResponseListUserBrokerConnectionWithPermissions, FinaticResponseOrderActionResult, FinaticResponseSessionResponseData, FinaticResponseSessionUserResponse, FinaticapiCoreStandardModelsAbstractResponsesFinaticResponsePortalUrlResponse2, FinaticapiCoreStandardModelsAbstractResponsesFinaticResponseTokenResponseData2, Futureunderlyingassettype, GTCTIF, GTDTIF, Grouptype, HTTPValidationError, IOCTIF, Initialmargin, InterceptorChain, LegacyBrokerAccount, LegacyBrokerBalance, Limitprice, LocationInner, LogLevel, Logger, Maintenancemargin, Marketvalue, ModifyOrderApiBetaBrokersOrdersOrderIdPatchRequest, Netliquidationvalue, NinjaTraderLimitOrderModifyQueryParams, NinjaTraderLimitOrderPlaceQueryParams, NinjaTraderMarketOrderModifyQueryParams, NinjaTraderMarketOrderPlaceQueryParams, NinjaTraderOrderModifyRequest, NinjaTraderOrderPlaceRequest, NinjaTraderStopOrderModifyQueryParams, NinjaTraderStopOrderPlaceQueryParams, NinjaTraderTrailingStopOrderModifyQueryParams, NinjaTraderTrailingStopOrderPlaceQueryParams, Notional, Openprice, Openquantity, Order, Order1, Order1AnyOf, Order1AnyOf1, Order1AnyOf2, Order2, Order3, Order4, Order5, OrderActionResult, Orderclass, Orderstatus, Ordertype, PaginationMeta, ParsedFinaticError, Pendingbalance, PlaceOrderApiBetaBrokersOrdersPostRequest, PortalUrlResponse, Previousstatus, Price, Quantity, Quantity1, Quantity2, Realizedprofitloss, Realizedprofitloss1, Realizedprofitlosspercent, Realizedprofitlosswithcommission, Realizedprofitlosswithcommission1, Remainingquantity, Remainingquantity1, RequestInterceptor, ResponseInterceptor, RetryOptions, RobinhoodCryptoLimitOrderPlaceQueryParams, RobinhoodCryptoMarketOrderPlaceQueryParams, RobinhoodCryptoStopLimitOrderPlaceQueryParams, RobinhoodCryptoStopOrderPlaceQueryParams, RobinhoodCryptoTrailingStopOrderPlaceQueryParams, RobinhoodEquityLimitOrderPlaceQueryParams, RobinhoodEquityMarketOrderPlaceQueryParams, RobinhoodEquityStopLimitOrderPlaceQueryParams, RobinhoodEquityStopOrderPlaceQueryParams, RobinhoodEquityTrailingStopOrderPlaceQueryParams, RobinhoodLimitOrderModifyQueryParams, RobinhoodMarketOrderModifyQueryParams, RobinhoodOptionLimitOrderPlaceQueryParams, RobinhoodOptionMarketOrderPlaceQueryParams, RobinhoodOptionSpreadLeg, RobinhoodOptionStopLimitOrderPlaceQueryParams, RobinhoodOptionStopOrderPlaceQueryParams, RobinhoodOptionTrailingStopOrderPlaceQueryParams, RobinhoodOrderModifyRequest, RobinhoodOrderPlaceRequest, RobinhoodStopOrderModifyQueryParams, RobinhoodTrailingStopOrderModifyQueryParams, SdkConfig, Securityidtype, SessionResponseData, SessionStartRequest, SessionUserResponse, Side, Side1, Side2, Side3, Status, Status1, Stopprice, Strikeprice, SuccessPayloadAccounts, SuccessPayloadDisconnectCompanyFromBrokerConnectionResult, SuccessPayloadListBrokerInfo, SuccessPayloadListFDXBrokerOrder, SuccessPayloadListFDXBrokerOrderEvent, SuccessPayloadListFDXBrokerOrderFill, SuccessPayloadListFDXBrokerOrderGroup, SuccessPayloadListFDXBrokerPosition, SuccessPayloadListFDXBrokerPositionLot, SuccessPayloadListFDXBrokerPositionLotFill, SuccessPayloadListFDXBrokerTransaction, SuccessPayloadListLegacyBrokerAccount, SuccessPayloadListLegacyBrokerBalance, SuccessPayloadListUserBrokerConnectionWithPermissions, SuccessPayloadOrderActionResult, SuccessPayloadPortalUrlResponse, SuccessPayloadSessionResponseData, SuccessPayloadSessionUserResponse, SuccessPayloadTokenResponseData, TastyTradeLimitOrderModifyQueryParams, TastyTradeLimitOrderPlaceQueryParams, TastyTradeMarketOrderModifyQueryParams, TastyTradeMarketOrderPlaceQueryParams, TastyTradeOrderModifyRequest, TastyTradeOrderPlaceRequest, TastyTradeStopOrderModifyQueryParams, TastyTradeStopOrderPlaceQueryParams, TastyTradeTrailingStopOrderModifyQueryParams, TastyTradeTrailingStopOrderPlaceQueryParams, Timeinforce, Timeinforce1, TokenResponseData, Totalcashvalue, Totalrealizedpnl, Transactionamount, Units, Unrealizedprofitloss, Unrealizedprofitlosspercent, UserBrokerConnectionWithPermissions };
|