snaptrade-typescript-sdk 5.0.0 → 6.0.0

package/docs/ApiStatusApi.md

@@ -8,8 +8,10 @@ Method | HTTP request | Description
 
 
 # **check**
-> Status check()
 
+#### **GET** /
+
+### Description
 Check whether the API is operational and verify timestamps.
 
 ### Example
@@ -25,8 +27,9 @@ const snaptrade = new Snaptrade({
     clientId: "YOUR_CLIENT_ID",
 })
 
-const response = await snaptrade.apiStatus.check()
-console.log(response)
+const checkResponse = await snaptrade.apiStatus.check()
+
+console.log(checkResponse)
 
 ```
 
@@ -39,10 +42,6 @@ This endpoint does not need any parameter.
 
 **Status**
 
-### Authorization
-
-No authorization required
-
 ### HTTP request headers
 
  - **Content-Type**: Not defined

package/docs/AuthenticationApi.md

@@ -12,7 +12,8 @@ Method | HTTP request | Description
 
 
 # **deleteSnapTradeUser**
-> DeleteUserResponse deleteSnapTradeUser()
+
+#### **DELETE** /snapTrade/deleteUser
 
 
 ### Example
@@ -28,10 +29,11 @@ const snaptrade = new Snaptrade({
     clientId: "YOUR_CLIENT_ID",
 })
 
-const response = await snaptrade.authentication.deleteSnapTradeUser({
-    'userId': "John.doe@snaptrade.com",
-})
-console.log(response)
+const deleteSnapTradeUserResponse = await snaptrade.authentication.deleteSnapTradeUser({
+        "userId": "John.doe@snaptrade.com",
+    })
+
+console.log(deleteSnapTradeUserResponse)
 
 ```
 
@@ -47,10 +49,6 @@ Name | Type | Description  | Notes
 
 **DeleteUserResponse**
 
-### Authorization
-
-[PartnerClientId](README.md#PartnerClientId), [PartnerSignature](README.md#PartnerSignature), [PartnerTimestamp](README.md#PartnerTimestamp)
-
 ### HTTP request headers
 
  - **Content-Type**: Not defined
@@ -69,7 +67,8 @@ Name | Type | Description  | Notes
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 
 # **getUserJWT**
-> EncryptedResponse getUserJWT()
+
+#### **GET** /snapTrade/encryptedJWT
 
 
 ### Example
@@ -85,11 +84,12 @@ const snaptrade = new Snaptrade({
     clientId: "YOUR_CLIENT_ID",
 })
 
-const response = await snaptrade.authentication.getUserJWT({
-    'userId': "John.doe@snaptrade.com",
-    'userSecret': "USERSECRET123",
-})
-console.log(response)
+const getUserJWTResponse = await snaptrade.authentication.getUserJWT({
+        "userId": "John.doe@snaptrade.com",
+        "userSecret": "USERSECRET123",
+    })
+
+console.log(getUserJWTResponse)
 
 ```
 
@@ -106,10 +106,6 @@ Name | Type | Description  | Notes
 
 **EncryptedResponse**
 
-### Authorization
-
-[PartnerClientId](README.md#PartnerClientId), [PartnerSignature](README.md#PartnerSignature), [PartnerTimestamp](README.md#PartnerTimestamp)
-
 ### HTTP request headers
 
  - **Content-Type**: Not defined
@@ -128,7 +124,8 @@ Name | Type | Description  | Notes
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 
 # **listSnapTradeUsers**
-> Array<string> listSnapTradeUsers()
+
+#### **GET** /snapTrade/listUsers
 
 
 ### Example
@@ -144,8 +141,9 @@ const snaptrade = new Snaptrade({
     clientId: "YOUR_CLIENT_ID",
 })
 
-const response = await snaptrade.authentication.listSnapTradeUsers()
-console.log(response)
+const listSnapTradeUsersResponse = await snaptrade.authentication.listSnapTradeUsers()
+
+console.log(listSnapTradeUsersResponse)
 
 ```
 
@@ -158,10 +156,6 @@ This endpoint does not need any parameter.
 
 **Array<string>**
 
-### Authorization
-
-[PartnerClientId](README.md#PartnerClientId), [PartnerSignature](README.md#PartnerSignature), [PartnerTimestamp](README.md#PartnerTimestamp)
-
 ### HTTP request headers
 
  - **Content-Type**: Not defined
@@ -179,7 +173,8 @@ This endpoint does not need any parameter.
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 
 # **loginSnapTradeUser**
-> AuthenticationLoginSnapTradeUser200Response loginSnapTradeUser()
+
+#### **POST** /snapTrade/login
 
 
 ### Example
@@ -195,18 +190,17 @@ const snaptrade = new Snaptrade({
     clientId: "YOUR_CLIENT_ID",
 })
 
-const response = await snaptrade.authentication.loginSnapTradeUser({
-    'userId': "John.doe@snaptrade.com",
-    'userSecret': "USERSECRET123",
-    'requestBody': {
+const loginSnapTradeUserResponse = await snaptrade.authentication.loginSnapTradeUser({
+        "userId": "John.doe@snaptrade.com",
+        "userSecret": "USERSECRET123",
         "broker": "ALPACA",
         "immediate_redirect": true,
         "custom_redirect": "https://passiv.com",
         "reconnect": "8b5f262d-4bb9-365d-888a-202bd3b15fa1",
         "connection_type": "read",
-    },
-})
-console.log(response)
+    })
+
+console.log(loginSnapTradeUserResponse)
 
 ```
 
@@ -224,10 +218,6 @@ Name | Type | Description  | Notes
 
 **AuthenticationLoginSnapTradeUser200Response**
 
-### Authorization
-
-[PartnerClientId](README.md#PartnerClientId), [PartnerSignature](README.md#PartnerSignature), [PartnerTimestamp](README.md#PartnerTimestamp)
-
 ### HTTP request headers
 
  - **Content-Type**: application/json
@@ -246,7 +236,8 @@ Name | Type | Description  | Notes
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 
 # **registerSnapTradeUser**
-> UserIDandSecret registerSnapTradeUser(snapTradeRegisterUserRequestBody)
+
+#### **POST** /snapTrade/registerUser
 
 
 ### Example
@@ -262,13 +253,12 @@ const snaptrade = new Snaptrade({
     clientId: "YOUR_CLIENT_ID",
 })
 
-const response = await snaptrade.authentication.registerSnapTradeUser({
-    'requestBody': {
+const registerSnapTradeUserResponse = await snaptrade.authentication.registerSnapTradeUser({
         "user_id": "snaptrade-user-123",
         "rsa_public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQC7vbqajDw4o6gJy8UtmIbkcpnkO3Kwc4qsEnSZp/TR+fQi62F79RHWmwKOtFmwteURgLbj7D/WGuNLGOfa/2vse3G2eHnHl5CB8ruRX9fBl/KgwCVr2JaEuUm66bBQeP5XeBotdR4cvX38uPYivCDdPjJ1QWPdspTBKcxeFbccDw==",
-    },
-})
-console.log(response)
+    })
+
+console.log(registerSnapTradeUserResponse)
 
 ```
 
@@ -284,10 +274,6 @@ Name | Type | Description  | Notes
 
 **UserIDandSecret**
 
-### Authorization
-
-[PartnerClientId](README.md#PartnerClientId), [PartnerSignature](README.md#PartnerSignature), [PartnerTimestamp](README.md#PartnerTimestamp)
-
 ### HTTP request headers
 
  - **Content-Type**: application/json

package/docs/ConnectionsApi.md

@@ -10,7 +10,8 @@ Method | HTTP request | Description
 
 
 # **detailBrokerageAuthorization**
-> BrokerageAuthorization detailBrokerageAuthorization()
+
+#### **GET** /authorizations/{authorizationId}
 
 
 ### Example
@@ -26,12 +27,13 @@ const snaptrade = new Snaptrade({
     clientId: "YOUR_CLIENT_ID",
 })
 
-const response = await snaptrade.connections.detailBrokerageAuthorization({
-    'authorizationId': "2bcd7cc3-e922-4976-bce1-9858296801c3",
-    'userId': "John.doe@snaptrade.com",
-    'userSecret': "USERSECRET123",
-})
-console.log(response)
+const detailBrokerageAuthorizationResponse = await snaptrade.connections.detailBrokerageAuthorization({
+        "authorizationId": "2bcd7cc3-e922-4976-bce1-9858296801c3",
+        "userId": "John.doe@snaptrade.com",
+        "userSecret": "USERSECRET123",
+    })
+
+console.log(detailBrokerageAuthorizationResponse)
 
 ```
 
@@ -49,10 +51,6 @@ Name | Type | Description  | Notes
 
 **BrokerageAuthorization**
 
-### Authorization
-
-[PartnerClientId](README.md#PartnerClientId), [PartnerSignature](README.md#PartnerSignature), [PartnerTimestamp](README.md#PartnerTimestamp)
-
 ### HTTP request headers
 
  - **Content-Type**: Not defined
@@ -68,7 +66,8 @@ Name | Type | Description  | Notes
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 
 # **listBrokerageAuthorizations**
-> Array<BrokerageAuthorization> listBrokerageAuthorizations()
+
+#### **GET** /authorizations
 
 
 ### Example
@@ -84,11 +83,12 @@ const snaptrade = new Snaptrade({
     clientId: "YOUR_CLIENT_ID",
 })
 
-const response = await snaptrade.connections.listBrokerageAuthorizations({
-    'userId': "John.doe@snaptrade.com",
-    'userSecret': "USERSECRET123",
-})
-console.log(response)
+const listBrokerageAuthorizationsResponse = await snaptrade.connections.listBrokerageAuthorizations({
+        "userId": "John.doe@snaptrade.com",
+        "userSecret": "USERSECRET123",
+    })
+
+console.log(listBrokerageAuthorizationsResponse)
 
 ```
 
@@ -105,10 +105,6 @@ Name | Type | Description  | Notes
 
 **Array<BrokerageAuthorization>**
 
-### Authorization
-
-[PartnerClientId](README.md#PartnerClientId), [PartnerSignature](README.md#PartnerSignature), [PartnerTimestamp](README.md#PartnerTimestamp)
-
 ### HTTP request headers
 
  - **Content-Type**: Not defined
@@ -124,7 +120,8 @@ Name | Type | Description  | Notes
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 
 # **removeBrokerageAuthorization**
-> removeBrokerageAuthorization()
+
+#### **DELETE** /authorizations/{authorizationId}
 
 
 ### Example
@@ -140,12 +137,13 @@ const snaptrade = new Snaptrade({
     clientId: "YOUR_CLIENT_ID",
 })
 
-const response = await snaptrade.connections.removeBrokerageAuthorization({
-    'authorizationId': "2bcd7cc3-e922-4976-bce1-9858296801c3",
-    'userId': "John.doe@snaptrade.com",
-    'userSecret': "USERSECRET123",
-})
-console.log(response)
+const removeBrokerageAuthorizationResponse = await snaptrade.connections.removeBrokerageAuthorization({
+        "authorizationId": "2bcd7cc3-e922-4976-bce1-9858296801c3",
+        "userId": "John.doe@snaptrade.com",
+        "userSecret": "USERSECRET123",
+    })
+
+console.log(removeBrokerageAuthorizationResponse)
 
 ```
 
@@ -163,10 +161,6 @@ Name | Type | Description  | Notes
 
 void (empty response body)
 
-### Authorization
-
-[PartnerClientId](README.md#PartnerClientId), [PartnerSignature](README.md#PartnerSignature), [PartnerTimestamp](README.md#PartnerTimestamp)
-
 ### HTTP request headers
 
  - **Content-Type**: Not defined

package/docs/ErrorLogsApi.md

@@ -8,7 +8,8 @@ Method | HTTP request | Description
 
 
 # **listUserErrors**
-> Array<UserErrorLog> listUserErrors()
+
+#### **GET** /snapTrade/listUserErrors
 
 
 ### Example
@@ -24,11 +25,12 @@ const snaptrade = new Snaptrade({
     clientId: "YOUR_CLIENT_ID",
 })
 
-const response = await snaptrade.errorLogs.listUserErrors({
-    'userId': "John.doe@snaptrade.com",
-    'userSecret': "USERSECRET123",
-})
-console.log(response)
+const listUserErrorsResponse = await snaptrade.errorLogs.listUserErrors({
+        "userId": "John.doe@snaptrade.com",
+        "userSecret": "USERSECRET123",
+    })
+
+console.log(listUserErrorsResponse)
 
 ```
 
@@ -45,10 +47,6 @@ Name | Type | Description  | Notes
 
 **Array<UserErrorLog>**
 
-### Authorization
-
-[PartnerClientId](README.md#PartnerClientId), [PartnerSignature](README.md#PartnerSignature), [PartnerTimestamp](README.md#PartnerTimestamp)
-
 ### HTTP request headers
 
  - **Content-Type**: Not defined

package/docs/OptionsApi.md

@@ -12,7 +12,8 @@ Method | HTTP request | Description
 
 
 # **getOptionStrategy**
-> StrategyQuotes getOptionStrategy(optionsGetOptionStrategyRequest)
+
+#### **POST** /accounts/{accountId}/optionStrategy
 
 
 ### Example
@@ -28,16 +29,22 @@ const snaptrade = new Snaptrade({
     clientId: "YOUR_CLIENT_ID",
 })
 
-const response = await snaptrade.options.getOptionStrategy({
-    'userId': "John.doe@snaptrade.com",
-    'userSecret': "USERSECRET123",
-    'accountId': "accountId_example",
-    'requestBody': {
+const getOptionStrategyResponse = await snaptrade.options.getOptionStrategy({
+        "userId": "John.doe@snaptrade.com",
+        "userSecret": "USERSECRET123",
+        "accountId": "accountId_example",
         "underlying_symbol_id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
+        "legs": [
+            {
+                "action": "BUY_TO_OPEN",
+                "option_symbol_id": "SPY220819P00200000",
+                "quantity": 1,
+            }
+        ],
         "strategy_type": "CUSTOM",
-    },
-})
-console.log(response)
+    })
+
+console.log(getOptionStrategyResponse)
 
 ```
 
@@ -56,10 +63,6 @@ Name | Type | Description  | Notes
 
 **StrategyQuotes**
 
-### Authorization
-
-[PartnerClientId](README.md#PartnerClientId), [PartnerSignature](README.md#PartnerSignature), [PartnerTimestamp](README.md#PartnerTimestamp)
-
 ### HTTP request headers
 
  - **Content-Type**: application/json
@@ -75,7 +78,8 @@ Name | Type | Description  | Notes
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 
 # **getOptionsChain**
-> Array<OptionChainInner> getOptionsChain()
+
+#### **GET** /accounts/{accountId}/optionsChain
 
 
 ### Example
@@ -91,13 +95,14 @@ const snaptrade = new Snaptrade({
     clientId: "YOUR_CLIENT_ID",
 })
 
-const response = await snaptrade.options.getOptionsChain({
-    'userId': "John.doe@snaptrade.com",
-    'userSecret': "USERSECRET123",
-    'accountId': "accountId_example",
-    'symbol': "symbol_example",
-})
-console.log(response)
+const getOptionsChainResponse = await snaptrade.options.getOptionsChain({
+        "userId": "John.doe@snaptrade.com",
+        "userSecret": "USERSECRET123",
+        "accountId": "accountId_example",
+        "symbol": "symbol_example",
+    })
+
+console.log(getOptionsChainResponse)
 
 ```
 
@@ -116,10 +121,6 @@ Name | Type | Description  | Notes
 
 **Array<OptionChainInner>**
 
-### Authorization
-
-[PartnerClientId](README.md#PartnerClientId), [PartnerSignature](README.md#PartnerSignature), [PartnerTimestamp](README.md#PartnerTimestamp)
-
 ### HTTP request headers
 
  - **Content-Type**: Not defined
@@ -135,7 +136,8 @@ Name | Type | Description  | Notes
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 
 # **getOptionsStrategyQuote**
-> StrategyQuotes getOptionsStrategyQuote()
+
+#### **GET** /accounts/{accountId}/optionStrategy/{optionStrategyId}
 
 
 ### Example
@@ -151,13 +153,14 @@ const snaptrade = new Snaptrade({
     clientId: "YOUR_CLIENT_ID",
 })
 
-const response = await snaptrade.options.getOptionsStrategyQuote({
-    'userId': "John.doe@snaptrade.com",
-    'userSecret': "USERSECRET123",
-    'accountId': "accountId_example",
-    'optionStrategyId': "2bcd7cc3-e922-4976-bce1-9858296801c3",
-})
-console.log(response)
+const getOptionsStrategyQuoteResponse = await snaptrade.options.getOptionsStrategyQuote({
+        "userId": "John.doe@snaptrade.com",
+        "userSecret": "USERSECRET123",
+        "accountId": "accountId_example",
+        "optionStrategyId": "2bcd7cc3-e922-4976-bce1-9858296801c3",
+    })
+
+console.log(getOptionsStrategyQuoteResponse)
 
 ```
 
@@ -176,10 +179,6 @@ Name | Type | Description  | Notes
 
 **StrategyQuotes**
 
-### Authorization
-
-[PartnerClientId](README.md#PartnerClientId), [PartnerSignature](README.md#PartnerSignature), [PartnerTimestamp](README.md#PartnerTimestamp)
-
 ### HTTP request headers
 
  - **Content-Type**: Not defined
@@ -195,7 +194,8 @@ Name | Type | Description  | Notes
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 
 # **listOptionHoldings**
-> OptionsHoldings listOptionHoldings()
+
+#### **GET** /accounts/{accountId}/options
 
 
 ### Example
@@ -211,12 +211,13 @@ const snaptrade = new Snaptrade({
     clientId: "YOUR_CLIENT_ID",
 })
 
-const response = await snaptrade.options.listOptionHoldings({
-    'userId': "John.doe@snaptrade.com",
-    'userSecret': "USERSECRET123",
-    'accountId': "accountId_example",
-})
-console.log(response)
+const listOptionHoldingsResponse = await snaptrade.options.listOptionHoldings({
+        "userId": "John.doe@snaptrade.com",
+        "userSecret": "USERSECRET123",
+        "accountId": "accountId_example",
+    })
+
+console.log(listOptionHoldingsResponse)
 
 ```
 
@@ -234,10 +235,6 @@ Name | Type | Description  | Notes
 
 **OptionsHoldings**
 
-### Authorization
-
-[PartnerClientId](README.md#PartnerClientId), [PartnerSignature](README.md#PartnerSignature), [PartnerTimestamp](README.md#PartnerTimestamp)
-
 ### HTTP request headers
 
  - **Content-Type**: Not defined
@@ -253,7 +250,8 @@ Name | Type | Description  | Notes
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 
 # **placeOptionStrategy**
-> StrategyOrderRecord placeOptionStrategy(optionsPlaceOptionStrategyRequest)
+
+#### **POST** /accounts/{accountId}/optionStrategy/{optionStrategyId}/execute
 
 
 ### Example
@@ -269,18 +267,17 @@ const snaptrade = new Snaptrade({
     clientId: "YOUR_CLIENT_ID",
 })
 
-const response = await snaptrade.options.placeOptionStrategy({
-    'userId': "John.doe@snaptrade.com",
-    'userSecret': "USERSECRET123",
-    'accountId': "2bcd7cc3-e922-4976-bce1-9858296801c3",
-    'optionStrategyId': "2bcd7cc3-e922-4976-bce1-9858296801c3",
-    'requestBody': {
+const placeOptionStrategyResponse = await snaptrade.options.placeOptionStrategy({
+        "userId": "John.doe@snaptrade.com",
+        "userSecret": "USERSECRET123",
+        "accountId": "2bcd7cc3-e922-4976-bce1-9858296801c3",
+        "optionStrategyId": "2bcd7cc3-e922-4976-bce1-9858296801c3",
         "order_type": "Limit",
         "time_in_force": "DAY",
         "price": 31.33,
-    },
-})
-console.log(response)
+    })
+
+console.log(placeOptionStrategyResponse)
 
 ```
 
@@ -300,10 +297,6 @@ Name | Type | Description  | Notes
 
 **StrategyOrderRecord**
 
-### Authorization
-
-[PartnerClientId](README.md#PartnerClientId), [PartnerSignature](README.md#PartnerSignature), [PartnerTimestamp](README.md#PartnerTimestamp)
-
 ### HTTP request headers
 
  - **Content-Type**: application/json