> For the complete documentation index, see [llms.txt](https://www.notbank.com/learn/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://www.notbank.com/learn/api-reference/readme/models.md).

# Models

## The GetAccountTransactionsRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetAccountTransactionsRequest":{"type":"object","properties":{"OMSId":{"type":"integer","description":"The ID of the OMS on which the account transactions will be returned."},"AccountId":{"type":"integer","description":"The ID of the account for which transactions will be returned."},"Depth":{"type":"integer","description":"The number of transactions that will be returned, starting with the most recent transaction. If not defined, all transactions of the account will be returned (assuming not other search parameters are defined)."},"ProductId":{"type":"integer","description":"Can be used to filter results. If set, only transactions for the specific product id specified will be returned, else, all transactions regardless of the product will be returned (assuming not other search parameters are defined)."},"TransactionId":{"type":"integer","description":"Can be used to filter results. If set, only transaction with the specific id specified will be returned, else, all transactions regardless of the transaction id will be returned (assuming not other search parameters are defined)."},"ReferenceId":{"type":"integer","description":"Can be used to filter results. If set, only transaction with the specific id specified will be returned, else, all transactions regardless of the reference id will be returned (assuming not other search parameters are defined)."},"TransactionTypes":{"type":"array","items":{"type":"integer","enum":[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,21,22,23,24,25]},"description":"Can be used to filter results according to transaction type/s (can filter with either just 1 or more). If not set, transactions with any transaction type will be returned. A list of: **1** Fee, **2** Trade, **3** Other, **4** Reverse, **5** Hold, **6** Rebate, **7** MarginAcquisition, **8** MarginRelinquishByTrade, **9** MarginInterestTransfer, **10** MarginOperatorTransferToMarginAccount, **11** MarginOperatorTransferToAssetAccount, **12** MarginUserTransfer, **13** MarginRelinquishByTransfer, **14** MarginRelinquishByReverseTrade, **15** Distribution, **16** Payment, **21** OperatorLend, **22** OperatorReceived, **23** Rebalance, **24** Commission, **25** AirDrop."},"TransactionReferenceTypes":{"type":"array","items":{"type":"integer","enum":[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21]},"description":"Can be used to filter results according to transaction reference type/s (can filter with either just 1 or more). If not set, transactions with any transaction reference type will be returned. A list of: **1** Trade, **2** Deposit, **3** Withdraw, **4** Transfer, **5** OrderHold, **6** WithdrawHold, **7** DepositHold, **8** MarginHold, **9** ManualHold, **10** ManualEntry, **11** MarginAcquisition, **12** MarginRelinquish, **13** MarginInterestNetting, **14** MarginOperatorTransferToMarginAccount, **15** MarginOperatorTransferToAssetAccount, **16** MarginUserTransfer, **17** MarginPositionReverseTrade, **18** AffiliateRebate, **19** DistributionEntry, **20** TransferHold, **21** AirDrop."},"StartTimestamp":{"type":"integer","format":"int64","description":"Can be used to filter results based on timestamp the transaction has happened. This filter will return transactions that happened on or after (earliest possible time) the specified timestamp value, if not set, transactions that happened any time will be returned."},"EndTimeStamp":{"type":"integer","format":"int64","description":"Can be used to filter results based on timestamp the transaction has happened. This filter will return transactions that happened on or before (latest possible time) the specified timestamp value, if not set, transactions that happened any time will be returned."}},"required":["OMSId","AccountId"],"title":"GetAccountTransactionsRequest"}}}}
```

## The GetAccountTransactionsResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetAccountTransactionsResponse":{"type":"array","items":{"type":"object","properties":{"TransactionId":{"type":"integer","description":"The ID of the transaction."},"OMSId":{"type":"integer","description":"The ID of the OMS on which the requested transactions took place."},"AccountId":{"type":"integer","description":"The ID of the account which made the transactions."},"CR":{"type":"number","format":"decimal","description":"Credit entry for the account on the order book. Funds entering an account."},"DR":{"type":"number","format":"decimal","description":"Debit entry for the account on the order book. Funds leaving an account."},"Counterparty":{"type":"integer","format":"int64","description":"The corresponding counter party in the trade."},"TransactionType":{"type":"string","enum":["Fee","Trade","Other","Reverse","Hold","Rebate","MarginAcquisition","MarginRelinquishByTrade","MarginInterestTransfer","MarginOperatorTransferToMarginAccount","MarginOperatorTransferToAssetAccount","MarginUserTransfer","MarginRelinquishByTransfer","MarginRelinquishByReverseTrade","Distribution","Payment","OperatorLend","OperatorReceived","Rebalance","Commission","AirDrop"],"description":"The type of transaction. One of: **1** Fee, **2** Trade, **3** Other, **4** Reverse, **5** Hold, **6** Rebate, **7** MarginAcquisition, **8** MarginRelinquishByTrade, **9** MarginInterestTransfer, **10** MarginOperatorTransferToMarginAccount, **11** MarginOperatorTransferToAssetAccount, **12** MarginUserTransfer, **13** MarginRelinquishByTransfer, **14** MarginRelinquishByReverseTrade, **15** Distribution, **16** Payment, **21** OperatorLend, **22** OperatorReceived, **23** Rebalance, **24** Commission, **25** AirDrop."},"ReferenceId":{"type":"integer","format":"int64","description":"The ID of the action or event that triggered this transaction."},"ReferenceType":{"type":"integer","enum":[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21],"description":"The type of action or event that triggered this transaction. One of:- **1** Trade, **2** Deposit, **3** Withdraw, **4** Transfer, **5** OrderHold, **6** WithdrawHold, **7** DepositHold, **8** MarginHold, **9** ManualHold, **10** ManualEntry, **11** MarginAcquisition, **12** MarginRelinquish, **13** MarginInterestNetting, **14** MarginOperatorTransferToMarginAccount, **15** MarginOperatorTransferToAssetAccount, **16** MarginUserTransfer, **17** MarginPositionReverseTrade, **18** AffiliateRebate, **19** DistributionEntry, **20** TransferHold, **21** AirDrop."},"ProductId":{"type":"integer","description":"The ID of the product on this account’s side of the transaction. For example, in a dollars-for-Bitcoin transaction, one side will have the product Dollar and the other side will have the product Bitcoin. Use **GetProduct** to return information about a product based on its ID."},"Balance":{"type":"number","format":"decimal","description":"The balance in the account after the transaction."},"TimeStamp":{"type":"integer","format":"int64","description":"Time at which the transaction took place, in POSIX format."}},"required":["TransactionId","OMSId","AccountId","CR","DR","Counterparty","TransactionType","ReferenceId","ReferenceType","ProductId","Balance","TimeStamp"]},"title":"GetAccountTransactionsResponse"}}}}
```

## The GetAccountPositionsRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetAccountPositionsRequest":{"type":"object","properties":{"OMSId":{"type":"integer","description":"The ID of the OMS."},"AccountId":{"type":"integer","description":"The ID of the account on the OMS for which positions will be returned for."},"IncludePending":{"type":"boolean","default":false,"description":"If true, pending deposit and withdraw amounts will be included in the response, else they will not be included. Default is false."}},"required":["OMSId","AccountId"],"title":"GetAccountPositionsRequest"}}}}
```

## The GetAccountPositionsResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetAccountPositionsResponse":{"type":"array","items":{"type":"object","properties":{"OMSId":{"type":"integer","description":"The ID of the OMS to which the account is assigned."},"AccountId":{"type":"integer","description":"The ID of the account whose positions/balances were retrieved."},"ProductSymbol":{"type":"string","description":"The symbol of a specific product."},"ProductId":{"type":"integer","description":"The ID of a specific product."},"Amount":{"type":"number","format":"decimal","description":"The current actual balance of the account for a specific product."},"Hold":{"type":"number","format":"decimal","description":"The current actual hold amount against the current balance of the account for a specific product. A hold amount is part of the total balance or the **Amount** field value but is not available to be used for other transactions. A trade on working status of 100 units at $1 each will produce a $100 hold."},"PendingDeposits":{"type":"number","format":"decimal","description":"Deposit amount for a specific product that is not yet credited to the account."},"PendingWithdraws":{"type":"number","format":"decimal","description":"Withdraw amount for a specific product that is not yet debited from the account."},"TotalDayDeposits":{"type":"number","format":"decimal","description":"Total amount deposited by the account for a specific product in the current day; UTC Midnight and UTC Midnight."},"TotalMonthDeposits":{"type":"number","format":"decimal","description":"Total amount deposited by the account for a specific product in the current month."},"TotalYearDeposits":{"type":"number","format":"decimal","description":"Total amount deposited by the account for a specific product in the current year."},"TotalDayDepositNotional":{"type":"number","format":"decimal","description":"Total amount in notional value deposited by the account for a specific product in the current day."},"TotalMonthDepositNotional":{"type":"number","format":"decimal","description":"Total amount in notional value deposited by the account for a specific product in the current month."},"TotalYearDepositNotional":{"type":"number","format":"decimal","description":"Total amount in notional value deposited by the account for a specific product in the current year."},"TotalDayWithdraws":{"type":"number","format":"decimal","description":"Total amount withdrawn by the account for a specific product in the current day; UTC Midnight and UTC Midnight."},"TotalMonthWithdraws":{"type":"number","format":"decimal","description":"Total amount withdrawn by the account for a specific product in the current month."},"TotalYearWithdraws":{"type":"number","format":"decimal","description":"Total amount withdrawn by the account for a specific product in the current year."},"TotalDayWithdrawNotional":{"type":"number","format":"decimal","description":"Total amount in notional value withdrawn by the account for a specific product in the current day."},"TotalMonthWithdrawNotional":{"type":"number","format":"decimal","description":"Total amount in notional value withdrawn by the account for a specific product in the current month."},"TotalYearWithdrawNotional":{"type":"number","format":"decimal","description":"Total amount in notional value withdrawn by the account for a specific product in the current year."},"NotionalProductId":{"type":"integer","description":"The ID of the product set as the BaseNotionalProduct on the OMS."},"NotionalProductSymbol":{"type":"string","description":"The symbol of the product set as the BaseNotionalProduct on the OMS."},"NotionalValue":{"type":"number","format":"decimal","description":"The current actual balance in notional value of the account for a specific product."},"NotionalHoldAmount":{"type":"number","format":"decimal","description":"The current actual hold amount in notional value against the current balance of the account for a specific product."},"NotionalRate":{"type":"number","format":"decimal","description":"The current rate of a specific product against the notional product."},"TotalDayTransferNotional":{"type":"number","format":"decimal","description":"Total amount in notional value transfered by the account for a specific product in the current day."}},"required":["OMSId","AccountId","ProductSymbol","ProductId","Amount","Hold","PendingDeposits","PendingWithdraws","TotalDayDeposits","TotalMonthDeposits","TotalYearDeposits","TotalDayDepositNotional","TotalMonthDepositNotional","TotalYearDepositNotional","TotalDayWithdraws","TotalMonthWithdraws","TotalYearWithdraws","TotalDayWithdrawNotional","TotalMonthWithdrawNotional","TotalYearWithdrawNotional","NotionalProductId","NotionalProductSymbol","NotionalValue","NotionalHoldAmount","NotionalRate","TotalDayTransferNotional"]},"title":"GetAccountPositionsResponse"}}}}
```

## The GetAccountInstrumentStatisticsRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetAccountInstrumentStatisticsRequest":{"type":"object","properties":{"OMSId":{"type":"integer","description":"The ID of the OMS."},"AccountId":{"type":"integer","description":"The ID of the account on the OMS for which instrument statistics will be returned for."}},"required":["OMSId","AccountId"],"title":"GetAccountInstrumentStatisticsRequest"}}}}
```

## The GetAccountInstrumentStatisticsResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetAccountInstrumentStatisticsResponse":{"type":"array","items":{"type":"object","properties":{"OMSId":{"type":"integer","description":"The ID of the OMS."},"AccountId":{"type":"integer","description":"The ID of the account for which the instrument statistics is for."},"InstrumentId":{"type":"integer","description":"The ID of the account for which the instrument statistics is for."},"InstrumentSymbol":{"type":"string","description":"The symbol of a specific instrument."},"QuantityBought":{"type":"number","format":"decimal","description":"Quantity of the instrument bought by the account at the current trading day."},"QuantitySold":{"type":"integer","description":"Quantity of the instrument sold by the account at the current trading day."},"NotionalBought":{"type":"integer","description":"Notional value of the instrument bought by the account at the current trading day."},"NotionalSold":{"type":"integer","description":"Notional value of the instrument sold by the account at the current trading day."},"MonthlyQuantityBought":{"type":"integer","description":"Quantity of the instrument bought by the account for the current month."},"MonthlyQuantitySold":{"type":"integer","description":"Quantity of the instrument sold by the account for the current month."},"MonthlyNotionalBought":{"type":"integer","description":"Notional value of the instrument bought by the account at the current month."},"MonthlyNotionalSold":{"type":"integer","description":"Notional value of the instrument sold by the account at the current month."},"TradeVolume":{"type":"integer","description":"Total quantity of the instrument either sold or bought by the account at the current trading day."},"MonthlyTradeVolume":{"type":"integer","description":"Total quantity of the instrument either sold or bought by the account at the current month."},"TotalDayBuys":{"type":"integer","description":"Total number of times the account bought the instrument at the current trading day."},"TotalDaySells":{"type":"integer","description":"Total number of times the account sold the instrument at the current trading day."},"TotalMonthBuys":{"type":"integer","description":"Total number of times the account bought the instrument at the current month."},"TotalMonthSells":{"type":"integer","description":"Total number of times the account sold the instrument at the current month."},"NotionalConversionRate":{"type":"integer","description":"The notional conversion rate."},"NotionalConversionSymbol":{"type":"string","description":"The notional conversion symbol."},"RollingMonthlyStartDate":{"type":"integer","description":"The rolling monthly start date."},"LastTradeId":{"type":"integer","description":"The ID of the most recent trade the account has for the instrument."},"DailyNotionalTradeVolume":{"type":"integer","description":"The notional trade volume of the account for the specific instrument at the current trading day."},"MonthlyNotionalTradeVolume":{"type":"integer","description":"The notional trade volume of the account for the specific instrument at the current month."},"YearlyNotionalTradeVolume":{"type":"integer","description":"The notional trade volume of the account for the specific instrument at the current year."}},"required":["OMSId","AccountId","InstrumentId","InstrumentSymbol","QuantityBought","QuantitySold","NotionalBought","NotionalSold","MonthlyQuantityBought","MonthlyQuantitySold","MonthlyNotionalBought","MonthlyNotionalSold","TradeVolume","MonthlyTradeVolume","TotalDayBuys","TotalDaySells","TotalMonthBuys","TotalMonthSells","NotionalConversionRate","NotionalConversionSymbol","RollingMonthlyStartDate","LastTradeId","DailyNotionalTradeVolume","MonthlyNotionalTradeVolume","YearlyNotionalTradeVolume"]},"title":"GetAccountInstrumentStatisticsResponse"}}}}
```

## The GetAccountInfoRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetAccountInfoRequest":{"type":"object","properties":{"OMSId":{"type":"integer","description":"The ID of the OMS on which the account exists."},"AccountId":{"type":"integer","description":"The ID of the account on the OMS for which information will be returned. If not defined, the default account of the authenticated user will be retrieved."}},"required":["OMSId"],"title":"GetAccountInfoRequest"}}}}
```

## The GetAccountInfoResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetAccountInfoResponse":{"type":"object","properties":{"OMSID":{"type":"integer","description":"The ID of the OMS on which the account resides."},"AccountId":{"type":"integer","description":"The ID of the account for which information was requested."},"AccountName":{"type":"string","description":"A non-unique name for the account assigned by the user."},"AccountHandle":{"type":"string","description":"A unique user-assigned name that is checked at create time by the OMS to assure its uniqueness."},"FirmId":{"type":"string","description":"An arbitrary identifier assigned by a trading venue operator to a trading firm as part of the initial company, user, and account set up process. For example, Smith Financial Partners might have the ID SMFP."},"FirmName":{"type":"string","description":"A longer, non-unique version of the trading firm’s name; for example, Smith Financial Partners."},"AccountType":{"type":"integer","enum":[0,1],"default":0,"description":"The account type the specific account is currently set to. One of: 0 Asset, 1 Liability. Default is 0."},"FeeGroupId":{"type":"integer","description":"Defines account attributes relating to how fees are calculated and assessed. Set by trading venue operator."},"ParentID":{"type":"integer","description":"Reserved for future development."},"RiskType":{"type":"integer","enum":[0,1,2,3,4],"description":"One of: 0 Unkown (an error condition), 1 Normal, 2 NoRiskCheck, 3 NoTrading, 4 Credit. Returns **Normal** for virtually all market participants. Other types indicate account configurations assignable by the trading venue operator."},"VerificationLevel":{"type":"integer","description":"The verification level the account is currently at. Verification level limits the amounts of deposits and withdrawals. It is defined by and set by the trading venue operator for each account and is part of the KYC (\"Know Your Customer\") process, which may be automated or manual. An account can earn a higher Verification Level over time."},"VerificationLevelName":{"type":"string","description":"Name of the verification level."},"CreditTier":{"type":"integer","default":0,"description":"The credit tier the account is currently at. Default is 0. applicable to accounts with _RiskType_ **Credit**."},"FeeProductType":{"type":"string","enum":["BaseProduct","SingleProduct"],"description":"One of: BaseProduct, SingleProduct. Trading fees may be charged by a trading venue operator (Withdrawal fees may also be charged, but that is a separate setting dependent on product and instrument). This value shows whether fees for this account’s trades are charged in the product being traded (BaseProduct, for example Bitcoin) or whether the account has a preferred fee-paying product (SingleProduct, for example USD) to use in all cases and regardless of product being traded."},"FeeProduct":{"type":"integer","default":0,"description":"The ID of the preferred fee product, if any. Default is 0."},"RefererId":{"type":"integer","description":"Captures the ID of the entity who referred this account to the trading venue, usually captured for marketing purposes."},"LoyaltyProductId":{"type":"integer","description":"The Loyalty Token is a parallel fee structure that replaces the general set of transaction fees. An exchange can promote activity on a specific cryptocurrency token by offering discounted transaction fees denominated in that token to customers who choose that fee structure. This key is the ID of the loyalty product chosen by the Exchange. There can be one Loyalty Token per OMS."},"LoyaltyEnabled":{"type":"boolean","default":false,"description":"If _true_, this account has accepted the Loyalty Token fee structure. If _false_, the account has not accepted it. Default is _false_."},"PriceTier":{"type":"integer","default":0,"description":"The price tier where the account is currently at. Default is 0."},"Frozen":{"type":"boolean","default":false,"description":"If _true_, account is Frozen and will not be able to perform assets outgoing transactions such as a withdrawal. If _false_, account is not frozen and can perform any transaction. Default is _false_."}},"required":["OMSID","AccountId","AccountName","AccountHandle","FirmId","FirmName","AccountType","FeeGroupId","ParentID","RiskType","VerificationLevel","VerificationLevelName","CreditTier","FeeProductType","FeeProduct","RefererId","LoyaltyProductId","LoyaltyEnabled","PriceTier","Frozen"],"title":"GetAccountInfoResponse"}}}}
```

## The AuthenticateUserResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"AuthenticateUserResponse":{"type":"object","properties":{"Authenticated":{"type":"boolean","description":"_True_ if the user is authenticated; _false_ otherwise."},"SessionToken":{"type":"string","description":"The token used for authentication in requests."},"User":{"type":"object","description":"User data","properties":{"UserId":{"type":"integer","description":"The ID of the user being authenticated on the exchange."},"UserName":{"type":"string","description":"The name of the user."},"Email":{"type":"string","description":"The email address of the user."},"EmailVerified":{"type":"boolean","description":"Whether the email address has been verified by the registration process or directly by an Admin."},"AccountId":{"type":"integer","description":"The ID of the account with which the user is associated (each user has a default account)."},"OMSId":{"type":"integer","description":"The ID of the OMS on which the user and account are associated."},"Use2FA":{"type":"boolean","description":"_True_ if the user must use 2FA to log in; _false_ otherwise."}},"required":["UserId","UserName","Email","EmailVerified","AccountId","OMSId","Use2FA"]},"Locked":{"type":"boolean","description":"_True_ if the user is currently locked; _false_ otherwise. A user may be locked by trying to log in too many times in rapid succession. He must be _unlocked_ by an admin."},"Requires2FA":{"type":"boolean","description":"_True_ if the user must use two-factor authentication; _false_ otherwise."},"TwoFAType":{"type":"string","description":"The type of 2FA this user requires. For example, **Google**."},"TwoFAToken":{"type":"string","default":"null","description":"Default is null."},"errormsg":{"type":"string","description":"A successful receipt of the call returns _null_."}},"required":["Authenticated","SessionToken","User","Locked","Requires2FA","TwoFAType","TwoFAToken","errormsg"],"title":"AuthenticateUserResponse"}}}}
```

## The LogOutRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"LogOutRequest":{"type":"object","properties":{"result":{"type":"boolean","description":"A successful logout request returns _true_; and unsuccessful (an error condition) returns _false_."},"errormsg":{"type":"string","description":"A successful logout request returns _null_; the _errormsg_ parameter for an unsuccessful request returns one of the following messages:. Not Authorized (errorcode 20). Invalid Request (errorcode 100). Operation Failed (errorcode 101). Server Error (errorcode 102). Resource Not Found (errorcode 104)."},"errorcode":{"type":"integer","description":"A successful request returns 0. An unsuccessful request returns one of the _errorcodes_ shown in the _errormsg_ list."},"detail":{"type":"string","description":"Message text that the system may send. Usually _null_."}},"required":["result","errormsg","errorcode","detail"],"title":"LogOutRequest"}}}}
```

## The LogOutResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"LogOutResponse":{"type":"object","properties":{"result":{"type":"boolean","description":"A successful logout request returns _true_; and unsuccessful (an error condition) returns _false_."},"errormsg":{"type":"string","description":"A successful logout request returns _null_; the _errormsg_ parameter for an unsuccessful request returns one of the following messages:. Not Authorized (errorcode 20). Invalid Request (errorcode 100). Operation Failed (errorcode 101). Server Error (errorcode 102). Resource Not Found (errorcode 104)."},"errorcode":{"type":"integer","description":"A successful request returns 0. An unsuccessful request returns one of the _errorcodes_ shown in the _errormsg_ list."},"detail":{"type":"string","description":"Message text that the system may send. Usually _null_."}},"required":["result","errormsg","errorcode","detail"],"title":"LogOutResponse"}}}}
```

## The GetWithdrawFeeRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetWithdrawFeeRequest":{"type":"object","properties":{"OMSId":{"type":"integer","description":"The ID of the OMS on which the product is trade."},"AccountId":{"type":"integer","description":"The ID of the account making the withdrawal. Not explicitly required but needs to be defined to get the accurate estimate of withdraw fee especially if there are fee overrides."},"ProductId":{"type":"integer","description":"The ID of the product intended to be withdrawn. Fees may vary with product. Not explicitly required but needs to be defined to get the accurate estimate of withdraw fee."},"Amount":{"type":"number","format":"decimal","description":"The amount of product intended to be withdrawn, not explicitly required but needs to be defined to get the accurate estimate of withdraw fee."},"AccountProviderId":{"type":"integer","default":0,"description":"Defining an ID here makes sure the fee is accurate according to the account provider used to withdraw. Default is 0."}},"required":["OMSId","AccountId","ProductId","Amount"],"title":"GetWithdrawFeeRequest"}}}}
```

## The GetWithdrawFeeResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetWithdrawFeeResponse":{"type":"object","properties":{"FeeAmount":{"type":"number","format":"decimal","description":"The estimated amount of the fee for the indicated withdrawal."},"TicketAmount":{"type":"number","format":"decimal","description":"The amount of product intended to be withdrawn."}},"required":["FeeAmount","TicketAmount"],"title":"GetWithdrawFeeResponse"}}}}
```

## The GetDepositFeeRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetDepositFeeRequest":{"type":"object","properties":{"OMSId":{"type":"integer","description":"The ID of the OMS."},"AccountId":{"type":"integer","description":"The ID of the account making the deposit. Not explicitly required but needs to be defined to get the accurate estimate of deposit fee especially if there is/are fee override/s."},"ProductId":{"type":"integer","description":"The ID of the product intended to be deposited. Fees may vary with product. Not explicitly required but needs to be defined to get the accurate estimate of deposit fee."},"Amount":{"type":"number","format":"decimal","description":"The amount of product intended to be deposited. Not explicitly required but needs to be defined to get the accurate estimate of deposit fee."},"AccountProviderId":{"type":"integer","default":0,"description":"Defining an ID here makes sure the fee is accurate according to the account provider used to deposit. Default is 0."}},"required":["OMSId","AccountId","ProductId","Amount"],"title":"GetDepositFeeRequest"}}}}
```

## The GetDepositFeeResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetDepositFeeResponse":{"type":"object","properties":{"FeeAmount":{"type":"number","format":"decimal","description":"The estimated amount of the fee for the indicated deposit."},"TicketAmount":{"type":"number","format":"decimal","description":"The amount of product intended to be deposited."}},"required":["FeeAmount","TicketAmount"],"title":"GetDepositFeeResponse"}}}}
```

## The GetOMSWithdrawFeesRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetOMSWithdrawFeesRequest":{"type":"object","properties":{"OMSId":{"type":"integer","description":"The ID of the OMS."},"ProductId":{"type":"integer","description":"The ID of the product in the OMS you wish to retrieve withdraw fees of. If not defined, withdraw fees for all products will be returned."},"AccountProviderId":{"type":"integer","description":"The ID of account provider in the OMS you wish to retrieve withdraw fees of. If not defined, withdraw fees for all account providers will be returned."}},"required":["OMSId"],"title":"GetOMSWithdrawFeesRequest"}}}}
```

## The GetOMSWithdrawFeesResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetOMSWithdrawFeesResponse":{"type":"array","items":{"type":"object","properties":{"OMSId":{"type":"integer","description":"The ID of the OMS."},"AccountId":{"type":"integer","description":"The ID of the account to which the fee will apply. If its value is 0, fee will apply to any account doing a withdraw of the the specific product defined in the withdraw fee."},"AccountProviderId":{"type":"integer","description":"The ID of the account provider to which the fee will apply. If its value 0, fee will apply regardless of the account provider used for the withdraw transaction."},"FeeId":{"type":"integer","description":"The ID of the specific withdraw fee."},"FeeAmt":{"type":"number","format":"decimal","description":"The standard withdraw fee amount."},"FeeCalcType":{"type":"string","enum":["Percentage","Flat"],"description":"The way to calculate the standard fee amount. One of: **Percentage**, **Flat**."},"IsActive":{"type":"boolean","description":"If true, fee will apply, else it will not."},"ProductId":{"type":"integer","description":"The ID of the product for which the specific withdraw fee will apply."},"MinimalFeeAmt":{"type":"number","format":"decimal","description":"The minimum withdraw fee amount."},"MinimalFeeCalcType":{"type":"string","enum":["Percentage","Flat"],"description":"The way to calculate the minimum withdraw fee. One of: **Percentage**, **Flat**."}},"required":["OMSId","AccountId","AccountProviderId","FeeId","FeeAmt","FeeCalcType","IsActive","ProductId","MinimalFeeAmt","MinimalFeeCalcType"]},"title":"GetOMSWithdrawFeesResponse"}}}}
```

## The GetOMSDepositFeesRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetOMSDepositFeesRequest":{"type":"object","properties":{"OMSId":{"type":"integer","description":"The ID of the OMS."},"ProductId":{"type":"integer","description":"The ID of the product in the OMS you wish to retrieve deposit fees of. If not defined, deposit fees for all products will be returned."},"AccountProviderId":{"type":"integer","description":"The ID of account provider in the OMS you wish to retrieve deposit fees of. If not defined, deposit fees for all account providers will be returned."}},"required":["OMSId"],"title":"GetOMSDepositFeesRequest"}}}}
```

## The GetOMSDepositFeesResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetOMSDepositFeesResponse":{"type":"array","items":{"type":"object","properties":{"OMSId":{"type":"integer","description":"The ID of the OMS."},"AccountId":{"type":"integer","description":"The ID of the account to which the fee will apply, if set to 0, fee will apply to any account doing a deposit of the the specific product defined in the deposit fee."},"AccountProviderId":{"type":"integer","description":"The ID of the account provider to which the fee will apply, if set to 0, fee will apply regardless of the account provider used for the deposit transaction."},"FeeId":{"type":"integer","description":"The ID of the specific deposit fee."},"FeeAmt":{"type":"number","format":"decimal","description":"The standard deposit fee amount."},"FeeCalcType":{"type":"string","enum":["Percentage","Flat"],"description":"The way to calculate the standard fee amount. One of: **Percentage**, **Flat**."},"IsActive":{"type":"boolean","description":"If true, fee will apply, else it will not."},"ProductId":{"type":"integer","description":"The ID of the product for which the specific deposit fee will apply."},"MinimalFeeAmt":{"type":"number","format":"decimal","description":"Not yet supported in the current latest NotBank version; for future provision. The minimum deposit fee amount. This will be the lowest amount of fee charged for each deposit."},"MinimalFeeCalcType":{"type":"string","enum":["Percentage","Flat"],"description":"Not yet supported in the current latest NotBank version; for future provision. he way to calculate the minimum withdraw fee. One of: **Percentage**, **Flat**."}},"required":["OMSId","AccountId","AccountProviderId","FeeId","FeeAmt","FeeCalcType","IsActive","ProductId","MinimalFeeAmt","MinimalFeeCalcType"]},"title":"GetOMSDepositFeesResponse"}}}}
```

## The GetAccountFeesRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetAccountFeesRequest":{"type":"object","properties":{"AccountId":{"type":"integer","description":"The ID of the account whose fees will be retrieved."},"OMSId":{"type":"integer","description":"The ID of the OMS."}},"required":["AccountId","OMSId"],"title":"GetAccountFeesRequest"}}}}
```

## The GetAccountFeesResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetAccountFeesResponse":{"type":"array","items":{"type":"object","properties":{"FeeId":{"type":"integer","description":"The ID of the fee."},"OMSId":{"type":"integer","description":"The ID the OMS."},"FeeTier":{"type":"integer","description":"The tier of the fee, the same with the fee tier of the account."},"AccountId":{"type":"integer","description":"The ID of the account to which the fee will apply, 0 means it will apply to all accounts with the same fee tier."},"FeeAmt":{"type":"number","format":"decimal","description":"The actual fee amount if **FeeCalcType** is Flat. Otherwise if **Percentage**, this represents the percentage of the trade value."},"FeeCalcType":{"type":"string","enum":["Flat","Percentage"],"description":"One of: **Flat**, **Percentage**."},"FeeType":{"type":"string","enum":["Flat","MakerFee","TakerFee","PeggedProductFee","AffiliateFee"],"description":"One of: **Flat**, **MakerFee**, **TakerFee**, **PeggedProductFee**, **AffiliateFee**."},"LadderThreshold":{"type":"number","format":"decimal","description":"The ladder threshold of the fee."},"LadderSeconds":{"type":"integer","description":"."},"IsActive":{"type":"boolean","description":"If true, means can apply to a trade, else it will not even if criteria are met."},"InstrumentId":{"type":"integer","description":"The ID of the instrument to which the fee will apply."},"OrderType":{"type":"string","enum":["Market","Limit","StopMarket","StopLimit","TrailingStopMarket","TrailingStopLimit","BlockTrade","Unknown"],"description":"The type of order where fee will only apply. One of: **Market**, **Limit**, **StopMarket**, **StopLimit**,**TrailingStopMarket**, **TrailingStopLimit**, **BlockTrade**, **Unknown**. Unknown means all order types."},"PeggedProductId":{"type":"integer","description":"The ID of the pegged product if the FeeType is **PeggedProductFee**."}},"required":["FeeId","OMSId","FeeTier","AccountId","FeeAmt","FeeCalcType","FeeType","LadderThreshold","LadderSeconds","IsActive","InstrumentId","OrderType","PeggedProductId"]},"title":"GetAccountFeesResponse"}}}}
```

## The GetOrderFeeRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetOrderFeeRequest":{"type":"object","properties":{"OMSId":{"type":"integer","description":"The ID of the OMS on which the trade would take place."},"AccountId":{"type":"integer","description":"The ID of the account requesting the fee estimate."},"InstrumentId":{"type":"integer","description":"The ID of the instrument being or to be traded."},"Quantity":{"type":"number","format":"decimal","description":"The quantity or amount of the proposed trade for which the OMS would charge a fee."},"Price":{"type":"number","format":"decimal","description":"The price at which the proposed trade would take place. Supply your price for a limit order; the exact price is difficult to know before execution."},"OrderType":{"type":"integer","enum":[0,1,2,3,4,5,6,7],"description":"The type of the proposed order. One of: 0 Unknown, 1 Market, 2 Limit, 3 StopMarket, 4 StopLimit, 5 TrailingStopMarket, 6 TrailingStopLimit, 7 BlockTrade."},"MakerTaker":{"type":"integer","description":"Depending on the venue, there may be different fees for a maker (one who places the order on the books, either buy or sell) or taker (one who accepts the order, either buy or sell). If the user places a large order that is only partially filled, he is a partial maker. One of:. -0 Unknown. -1 Maker. -2 Taker."},"Side":{"type":"integer","enum":[0,1,2,3],"description":"Side of the trade. It will decide at which product will the fee be donominated. In NotBank, the fee is charged in the incoming product by default. One of: 0 Buy, 1 Sell, 2 Short, 3 Unknown."}},"required":["OMSId","AccountId","InstrumentId","Quantity","Price","OrderType","MakerTaker","Side"],"title":"GetOrderFeeRequest"}}}}
```

## The GetOrderFeeResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetOrderFeeResponse":{"type":"object","properties":{"OrderFee":{"type":"number","format":"decimal","description":"The estimated fee for the trade as described."},"ProductId":{"type":"integer","description":"The ID of the product (currency) in which the fee is denominated."}},"required":["OrderFee","ProductId"],"title":"GetOrderFeeResponse"}}}}
```

## The GetInstrumentRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetInstrumentRequest":{"type":"object","properties":{"OMSId":{"type":"integer","description":"The ID of the OMS."},"InstrumentId":{"type":"integer","description":"The ID of the instrument."}},"required":["OMSId","InstrumentId"],"title":"GetInstrumentRequest"}}}}
```

## The GetInstrumentResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetInstrumentResponse":{"type":"object","properties":{"OMSId":{"type":"integer","description":"The ID of the OMS on which the instrument is traded."},"InstrumentId":{"type":"integer","description":"The ID of the instrument."},"Symbol":{"type":"string","description":"Trading symbol of the instrument, for example BTCUSD."},"Product1":{"type":"integer","description":"The ID of the first product comprising the instrument or the ID of the base product/currency of the instrument."},"Product1Symbol":{"type":"string","description":"The symbol of the first product comprising the instrument or the symbol of the base product/currency of the instrument."},"Product2":{"type":"integer","description":"The ID of the second product comprising the instrument or the ID of the quote product/currency of the instrument."},"Product2Symbol":{"type":"string","description":"The symbol of the second product comprising the instrument or the symbol of the quote product/currency of the instrument."},"InstrumentType":{"type":"string","description":"A number representing the type of the instrument. All instrument types currently are _standard_, an exchange of one product for another (or _unknown_, an error condition), but this may expand to new types in the future., 0 Unknown (an error condition), 1 Standard."},"VenueInstrumentId":{"type":"integer","description":"A venue instrument is created at the exchange level as an instrument \"template\" for adding new instruments to the exchange. This is the ID of the venue instrument behind the instrument being requested."},"VenueId":{"type":"integer","description":"The ID of the trading venue on which the instrument trades."},"SortIndex":{"type":"integer","description":"The numerical position in which to sort the returned list of instruments on a visual display. Since this call returns information about a single instrument, _SortIndex_ should return 0."},"SessionStatus":{"type":"string","enum":["Unknown","Running","Paused","Stopped","Starting","RunningPostOnly"],"description":"The current session status of the instrument. One of: 0 Unknown, 1 Running, 2 Paused, 3 Stopped, 4 Starting, 5 RunningPostOnly."},"PreviousSessionStatus":{"type":"string","enum":["Unknown","Running","Paused","Stopped","Starting","RunningPostOnly"],"description":"The previous session status of the instrument. One of: 0 Unknown, 1 Running, 2 Paused, 3 Stopped, 4 Starting, 5 RunningPostOnly."},"SessionStatusDateTime":{"type":"string","description":"The time and date at which the session status was reported, in Microsoft Ticks format."},"SelfTradePrevention":{"type":"boolean","default":false,"description":"An account that is trading with itself still incurs fees. If this instrument prevents an account from trading the instrument with itself, the value returns _true_. Default is _false_."},"QuantityIncrement":{"type":"number","format":"decimal","description":"The smallest tradeable increment of the instrument. For example, for BTCUSD, the quantity increment might be 0.0005, but for ETHUSD, the quantity increment might be 50."},"PriceIncrement":{"type":"number","format":"decimal","description":"The smallest amount by which the instrument can rise or fall in the market."},"MinimumQuantity":{"type":"number","format":"decimal","description":"The smallest quantity at which the instrument can be traded."},"MinimumPrice":{"type":"number","format":"decimal","description":"The lowest price that the instrument can have."},"VenueSymbol":{"type":"string","description":"The symbol of the instrument in the trading venue or exchange."},"IsDisable":{"type":"boolean","description":"Identifies if the instrument is available to be traded or not, if true, instrument cannot be traded, else it can be traded but would still depend on the **SessionStatus**."},"PriceFloorLimit":{"type":"number","format":"decimal","description":"The lowest price that the instrument can be traded in a specific session; for instance, daily price floor limit of an instrument can change, it really depends on regulator requirements most of the time."},"PriceFloorLimitEnabled":{"type":"boolean","description":"If enabled price floor limit will apply."},"PriceCeilingLimit":{"type":"number","format":"decimal","description":"The highest price that the instrument can be traded in a specific session; for instance, daily price ceiling limit of an instrument can change, it really depends on regulator requirements most of the time."},"PriceCeilingLimitEnabled":{"type":"boolean","description":"If enabled price ceiling limit will apply."},"PriceTier":{"type":"integer","description":"The price tier the instrument."}},"required":["OMSId","InstrumentId","Symbol","Product1","Product1Symbol","Product2","Product2Symbol","InstrumentType","VenueInstrumentId","VenueId","SortIndex","SessionStatus","PreviousSessionStatus","SessionStatusDateTime","SelfTradePrevention","QuantityIncrement","PriceIncrement","MinimumQuantity","MinimumPrice","VenueSymbol","IsDisable","PriceFloorLimit","PriceFloorLimitEnabled","PriceCeilingLimit","PriceCeilingLimitEnabled","PriceTier"],"title":"GetInstrumentResponse"}}}}
```

## The GetInstrumentsRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetInstrumentsRequest":{"type":"object","properties":{"OMSId":{"type":"integer","description":"The ID of the OMS on which the instruments are available."},"InstrumentState":{"type":"string","enum":["Both","Inactive"],"description":"Filters the results, you can include disabled instruments in the results, or you can just get disabled instruments if you want. One of: **Both**, **Inactive**. If set to **Both**, response will include all the instruments even the disabled instruments, if set to **Inactive**, response will only include all the **disabled** instruments, if not set, response will only return **enabled or active** instruments."}},"required":["OMSId"],"title":"GetInstrumentsRequest"}}}}
```

## The GetInstrumentsResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetInstrumentsResponse":{"type":"array","items":{"type":"object","properties":{"OMSId":{"type":"integer","description":"The ID of the OMS on which the instrument is traded."},"InstrumentId":{"type":"integer","description":"The ID of the instrument."},"Symbol":{"type":"string","description":"Trading symbol of the instrument, for example BTCUSD."},"Product1":{"type":"integer","description":"The ID of the first product comprising the instrument or the ID of the base product/currency of the instrument."},"Product1Symbol":{"type":"string","description":"The symbol of the first product comprising the instrument or the symbol of the base product/currency of the instrument."},"Product2":{"type":"integer","description":"The ID of the second product comprising the instrument or the ID of the quote product/currency of the instrument."},"Product2Symbol":{"type":"string","description":"The symbol of the second product comprising the instrument or the symbol of the quote product/currency of the instrument."},"InstrumentType":{"type":"string","description":"A number representing the type of the instrument. All instrument types currently are _standard_, an exchange of one product for another (or _unknown_, an error condition), but this may expand to new types in the future., 0 Unknown (an error condition), 1 Standard."},"VenueInstrumentId":{"type":"integer","description":"A venue instrument is created at the exchange level as an instrument \"template\" for adding new instruments to the exchange. This is the ID of the venue instrument behind the instrument being requested."},"VenueId":{"type":"integer","description":"The ID of the trading venue on which the instrument trades."},"SortIndex":{"type":"integer","description":"The numerical position in which to sort the returned list of instruments on a visual display. Since this call returns information about a single instrument, _SortIndex_ should return 0."},"SessionStatus":{"type":"string","enum":["Unknown","Running","Paused","Stopped","Starting","RunningPostOnly"],"description":"The current session status of the instrument. One of: 0 Unknown, 1 Running, 2 Paused, 3 Stopped, 4 Starting, 5 RunningPostOnly."},"PreviousSessionStatus":{"type":"string","enum":["Unknown","Running","Paused","Stopped","Starting","RunningPostOnly"],"description":"The previous session status of the instrument. One of: 0 Unknown, 1 Running, 2 Paused, 3 Stopped, 4 Starting, 5 RunningPostOnly."},"SessionStatusDateTime":{"type":"string","description":"The time and date at which the session status was reported, in Microsoft Ticks format."},"SelfTradePrevention":{"type":"boolean","default":false,"description":"An account that is trading with itself still incurs fees. If this instrument prevents an account from trading the instrument with itself, the value returns _true_. Default is _false_."},"QuantityIncrement":{"type":"number","format":"decimal","description":"The smallest tradeable increment of the instrument. For example, for BTCUSD, the quantity increment might be 0.0005, but for ETHUSD, the quantity increment might be 50."},"PriceIncrement":{"type":"number","format":"decimal","description":"The smallest amount by which the instrument can rise or fall in the market."},"MinimumQuantity":{"type":"number","format":"decimal","description":"The smallest quantity at which the instrument can be traded."},"MinimumPrice":{"type":"number","format":"decimal","description":"The lowest price that the instrument can have."},"VenueSymbol":{"type":"string","description":"The symbol of the instrument in the trading venue or exchange."},"IsDisable":{"type":"boolean","description":"Identifies if the instrument is available to be traded or not, if true, instrument cannot be traded, else it can be traded but would still depend on the **SessionStatus**."},"PriceFloorLimit":{"type":"number","format":"decimal","description":"The lowest price that the instrument can be traded in a specific session; for instance, daily price floor limit of an instrument can change."},"PriceFloorLimitEnabled":{"type":"boolean","description":"If enabled price floor limit will apply."},"PriceCeilingLimit":{"type":"number","format":"decimal","description":"The highest price that the instrument can be traded in a specific session; for instance, daily price ceiling limit of an instrument can change."},"PriceCeilingLimitEnabled":{"type":"boolean","description":"If enabled price ceiling limit will apply."},"PriceTier":{"type":"integer","description":"The price tier the instrument."}},"required":["OMSId","InstrumentId","Symbol","Product1","Product1Symbol","Product2","Product2Symbol","InstrumentType","VenueInstrumentId","VenueId","SortIndex","SessionStatus","PreviousSessionStatus","SessionStatusDateTime","SelfTradePrevention","QuantityIncrement","PriceIncrement","MinimumQuantity","MinimumPrice","VenueSymbol","IsDisable","PriceFloorLimit","PriceFloorLimitEnabled","PriceCeilingLimit","PriceCeilingLimitEnabled","PriceTier"]},"title":"GetInstrumentsResponse"}}}}
```

## The GetInstrumentVerificationLevelConfigRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetInstrumentVerificationLevelConfigRequest":{"type":"object","properties":{"OMSId":{"type":"integer","description":"The ID of the OMS on which the account resides."},"AccountId":{"type":"integer","description":"The ID of the account for which you wish to get instrument verification level config for."}},"required":["OMSId","AccountId"],"title":"GetInstrumentVerificationLevelConfigRequest"}}}}
```

## The GetInstrumentVerificationLevelConfigResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetInstrumentVerificationLevelConfigResponse":{"type":"object","properties":{"Level":{"type":"integer","description":"The verification level the account specified is currently on."},"LevelName":{"type":"string","description":"The of the verification level the account specified is currently on."},"OMSId":{"type":"integer","description":"The ID of the OMS on which the account resides."},"Instruments":{"type":"array","description":"An array of objects, each object will contain the limits of a specific instrument.","items":{"type":"object","properties":{"InstrumentId":{"type":"integer","description":"The ID of the of the instrument for which the limits apply to."},"InstrumentName":{"type":"string","description":"The name of the instrument for which the limits apply to."},"DailyBuyLimit":{"type":"number","format":"decimal","description":"The maximum amount of the specific instrument that the specified account can buy within a day."},"DailySellLimit":{"type":"number","format":"decimal","description":"The maximum amount of the specific instrument that the specified account can sell within a day."},"MonthlyBuyLimit":{"type":"number","format":"decimal","description":"The maximum amount of the specific instrument that the specified account can buy within a month."},"MonthlySellLimit":{"type":"number","format":"decimal","description":"The maximum amount of the specific instrument that the specified account can sell within a month."},"NotionalProductId":{"type":"integer","description":"The Id of the notional product for the instrument."},"DailyNotionalLimit":{"type":"number","format":"decimal","description":"The maximum notional amount of the specific instrument that the specified account can buy and sell within a day. Buy and Sell trade amount are combined."},"MonthlyNotionalLimit":{"type":"number","format":"decimal","description":"The maximum notional amount of the specific instrument that the specified account can buy and sell within a month. Buy and Sell trade amount are combined."},"YearlyNotionalLimit":{"type":"number","format":"decimal","description":"The maximum notional amount of the specific instrument that the specified account can buy and sell within a year. Buy and Sell trade amount are combined."}},"required":["InstrumentId","InstrumentName","DailyBuyLimit","DailySellLimit","MonthlyBuyLimit","MonthlySellLimit","NotionalProductId","DailyNotionalLimit","MonthlyNotionalLimit","YearlyNotionalLimit"]}}},"required":["Level","LevelName","OMSId","Instruments"],"title":"GetInstrumentVerificationLevelConfigResponse"}}}}
```

## The GetProductRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetProductRequest":{"type":"object","properties":{"OMSId":{"type":"integer","description":"The ID of the OMS."},"ProductId":{"type":"integer","description":"The ID of the product on the specified OMS."}},"required":["OMSId","ProductId"],"title":"GetProductRequest"}}}}
```

## The GetProductResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetProductResponse":{"type":"object","properties":{"OMSId":{"type":"integer","description":"The ID of the OMS on which the product resides."},"ProductId":{"type":"integer","description":"The ID of the product."},"Product":{"type":"string","description":"The symbol of the product."},"ProductFullName":{"type":"string","description":"The full name of the product."},"MasterDataUniqueProductSymbol":{"type":"string","description":"Always an empty string, for future provision."},"ProductType":{"type":"string","enum":["Unknown","NationalCurrency","CryptoCurrency","Contract"],"description":"The nature of the product. Unknown represents an error. One of: 0 Unknown, 1 NationalCurrency, 2 CryptoCurrency, 3 Contract."},"DecimalPlaces":{"type":"integer","description":"The maximum number of decimal places allowed for the amount of product that an account may have."},"TickSize":{"type":"number","format":"decimal","description":"The smallest increment of the amount of the specific product that an account may have."},"DepositEnabled":{"type":"boolean","description":"If deposit for the product are enabled."},"WithdrawEnabled":{"type":"boolean","description":"If withdrawal for the product is enabled."},"NoFees":{"type":"boolean","description":"If _false_, fees incurred by the account can be charged in the denomination of the specific product. If _NoFees_ is _true_, fees incurred by the account will never be charged in the denomination of the specific product."},"IsDisabled":{"type":"boolean","description":"If true, product is disabled and cannot be used, no deposits and withdrawals can be done."},"MarginEnabled":{"type":"boolean","default":false,"description":"Margin is not yet supported so defaults to false; for future provisions."}},"required":["OMSId","ProductId","Product","ProductFullName","MasterDataUniqueProductSymbol","ProductType","DecimalPlaces","TickSize","DepositEnabled","WithdrawEnabled","NoFees","IsDisabled","MarginEnabled"],"title":"GetProductResponse"}}}}
```

## The GetProductsRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetProductsRequest":{"type":"object","properties":{"OMSId":{"type":"integer","description":"The ID of the OMS."},"Attribute":{"type":"string","description":"The attribute key or name for which you want to filter the results with."},"AttributeValue":{"type":"string","description":"Used to filter the results further, only products whose attribute value will match the one set will be returned."},"GetDisabled":{"type":"boolean","description":"Used to filter disabled products, setting this to true will return all products including the disabled ones."},"Depth":{"type":"integer","default":50,"description":"Used for pagination. Indicates the maximum number of results/products to be returned. Default is 50."},"StartIndex":{"type":"integer","default":0,"description":"Used for pagination. ProductId 1 represents index 0. A value of 2 for this field will not include ProductId 1 and 2 in the results. Default is 0."}},"required":["OMSId"],"title":"GetProductsRequest"}}}}
```

## The GetProductsResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetProductsResponse":{"type":"array","items":{"type":"object","properties":{"OMSId":{"type":"integer","description":"The ID of the OMS on which the product resides."},"ProductId":{"type":"integer","description":"The ID of the product."},"Product":{"type":"string","description":"The symbol of the product."},"ProductFullName":{"type":"string","description":"The full name of the product."},"MasterDataUniqueProductSymbol":{"type":"string","description":"Always an empty string, for future provision."},"ProductType":{"type":"string","enum":["Unknown","NationalCurrency","CryptoCurrency","Contract"],"description":"The nature of the product. Unknown represents an error. One of: 0 Unknown, 1 NationalCurrency, 2 CryptoCurrency, 3 Contract."},"DecimalPlaces":{"type":"integer","description":"The maximum number of decimal places allowed for the amount of product that an account may have."},"TickSize":{"type":"number","format":"decimal","description":"The smallest increment of the amount of the specific product that an account may have."},"DepositEnabled":{"type":"boolean","description":"If deposit for the product are enabled."},"WithdrawEnabled":{"type":"boolean","description":"If withdrawal for the product is enabled."},"NoFees":{"type":"boolean","description":"If _false_, fees incurred by the account can be charged in the denomination of the specific product. If _NoFees_ is _true_, fees incurred by the account will never be charged in the denomination of the specific product."},"IsDisabled":{"type":"boolean","description":"If true, product is disabled and cannot be used, no deposits and withdrawals can be done."},"MarginEnabled":{"type":"boolean","default":false,"description":"Margin is not yet supported so defaults to false; for future provisions."}},"required":["OMSId","ProductId","Product","ProductFullName","MasterDataUniqueProductSymbol","ProductType","DecimalPlaces","TickSize","DepositEnabled","WithdrawEnabled","NoFees","IsDisabled","MarginEnabled"]},"title":"GetProductsResponse"}}}}
```

## The GetVerificationLevelConfigRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetVerificationLevelConfigRequest":{"type":"object","properties":{"OMSId":{"type":"integer","description":"The ID of the OMS on which the account resides."},"AccountId":{"type":"integer","description":"The ID of the account for which you wish to get product verification level config for."}},"required":["OMSId","AccountId"],"title":"GetVerificationLevelConfigRequest"}}}}
```

## The GetVerificationLevelConfigResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetVerificationLevelConfigResponse":{"type":"object","properties":{"Level":{"type":"integer","description":"The verification level the account specified is currently on."},"LevelName":{"type":"string","description":"The of name the verification level the account specified is currently on."},"OMSId":{"type":"integer","description":"The ID of the OMS on which the account resides."},"Products":{"type":"array","items":{"type":"object","properties":{"ProductId":{"type":"integer","description":"The ID of the product to which the specific verification level limits applies."},"ProductName":{"type":"string","description":"The name of the product to which the specific verification level limits applies."},"AutoWithdrawThreshold":{"type":"decimal","description":"The maximum withdraw amount which can be autoaccepted."},"DailyDepositLimit":{"type":"decimal","description":"The maximum amount of the product that can be deposited daily."},"DailyDepositNotionalLimit":{"type":"decimal","description":"The maximum notional amount of the product that can be deposited daily."},"MonthlyDepositLimit":{"type":"decimal","description":"The maximum amount of the product that can be deposited monthly."},"MonthlyDepositNotionalLimit":{"type":"decimal","description":"The maximum notional amount of the product that can be deposited monthly."},"YearlyDepositLimit":{"type":"decimal","description":"The maximum amount of the product that can be deposited annually."},"YearlyDepositNotionalLimit":{"type":"decimal","description":"The maximum notional amount of the product that can be deposited annually."},"DailyWithdrawLimit":{"type":"decimal","description":"The maximum amount of the product that can be withdrawn daily."},"DailyWithdrawNotionalLimit":{"type":"decimal","description":"The maximum notional amount of the product that can be withdrawn daily."},"MonthlyWithdrawLimit":{"type":"decimal","description":"The maximum amount of the product that can be withdrawn monthly."},"MonthlyWithdrawNotionalLimit":{"type":"decimal","description":"The maximum notional amount of the product that can be withdrawn monthly."},"YearlyWithdrawLimit":{"type":"decimal","description":"The maximum amount of the product that can be withdrawn annually."},"YearlyWithdrawNotionalLimit":{"type":"decimal","description":"The maximum notional amount of the product that can be withdrawn annually."},"NotionalProductId":{"type":"integer","description":"The ID of the notional product."},"OverLimitRejected":{"type":"boolean","description":"If true, all deposit and withdrawals which exceeds limits will be automatically rejected, else those tickets will stay at the status New."},"WithdrawProcessingDelaySec":{"type":"integer","description":"The delay, in minutes, before a withdraw request will be Submitted onchain after getting accepted."},"DepositTicketWorkflow":{"type":"string","description":"The deposit workflow."},"WithdrawTicketWorkflow":{"type":"string","description":"The withdraw workflow."},"RequireWhitelistedAddress":{"type":"boolean","description":"If true, users can only withdraw to whitelisted withdraw address, if the user does not have a verified withdraw address, he/she will not be able to submit a withdraw request."}},"required":["ProductId","ProductName","AutoWithdrawThreshold","DailyDepositLimit","DailyDepositNotionalLimit","MonthlyDepositLimit","MonthlyDepositNotionalLimit","YearlyDepositLimit","YearlyDepositNotionalLimit","DailyWithdrawLimit","DailyWithdrawNotionalLimit","MonthlyWithdrawLimit","MonthlyWithdrawNotionalLimit","YearlyWithdrawLimit","YearlyWithdrawNotionalLimit","NotionalProductId","OverLimitRejected","WithdrawProcessingDelaySec","DepositTicketWorkflow","WithdrawTicketWorkflow","RequireWhitelistedAddress"]}}},"required":["Level","LevelName","OMSId","Products"],"title":"GetVerificationLevelConfigResponse"}}}}
```

## The GenerateTradeActivityReportRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GenerateTradeActivityReportRequest":{"type":"object","properties":{"accountIdList":{"type":"array","items":{"type":"integer"},"description":"A comma-delimited array of one ore more account IDs, each valid on a single OMS for the authenticated user. The account user may not be the only user of the account."},"omsId":{"type":"integer","description":"The ID of the OMS on which the array of account IDs resides."},"startTime":{"type":"string","description":"Identifies the time and date for the historic beginning of the trade activity report."},"endTime":{"type":"string","description":"Identifies the time and date for the historic end of the trade activity report."}},"required":["accountIdList","omsId","startTime","endTime"],"title":"GenerateTradeActivityReportRequest"}}}}
```

## The GenerateTradeActivityReportResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GenerateTradeActivityReportResponse":{"type":"object","properties":{"RequestingUser":{"type":"integer","description":"The User ID of the person requesting the trade activity report. This confirms the ID of the authenticated user who made the request by returning it as part of the response."},"OMSId":{"type":"integer","description":"The ID of the OMS on which the trade activity report will be run."},"reportFlavor":{"type":"string","description":"The type of report to be generated. In the case of GenerateTradeActivityReport, report flavor will always be **TradeActivity**."},"createTime":{"type":"string","description":"The time and date on which the request for the trade activity report was made."},"initialRunTime":{"type":"string","description":"The time and date at which the trade activity report was first run."},"intervalStartTime":{"type":"string","description":"The start of the period that the report will cover."},"intervalEndTime":{"type":"string","description":"The end of the period that the report will cover."},"RequestStatus":{"type":"string","enum":["Submitted","Validating","Scheduled","InProgress","Completed","Aborting","Aborted","UserCancelled","SysRetired","UserCancelled","Pending"],"description":"The status of the request for the trade activity report. A **Generate~Report** request will always return _Submitted_. One of: Submitted, Validating, Scheduled, InProgress, Completed, Aborting, Aborted, UserCancelled, SysRetired, UserCancelled, Pending."},"ReportFrequency":{"type":"string","enum":["OnDemand","Hourly","Daily","Weekly","Monthly","Annually"],"description":"When the report runs. For a **Generate~Report** request, this is always OnDemand. One of: OnDemand, Hourly, Daily, Weekly, Monthly, Annually."},"intervalDuration":{"type":"integer","format":"int64","description":"The period that the report covers relative to the run date. The **Generate~Report** request requires a start time and an end time. The Notbank software calculates the difference between them as _intervalDuration_. For example, say that you specify a 90-day start-date-to-end-date window for a report. The _intervalDuration_ value returns a value equivalent to 90 days. If you have called **Generate~Report**, that value simply confirms the length of time that the on-demand report covers."},"RequestId":{"type":"string","description":"The ID of the original request. Request IDs are long strings unique within the OMS."},"lastInstanceId":{"type":"string","description":"For scheduled reports, the report ID of the most recent previously run report. Will be _null_ for a **Generate~Report** call, because generated reports are on-demand."},"accountIds":{"type":"array","items":{"type":"integer"},"description":"A comma-delimited array of account IDs whose trades are reported in the trade activity report."}},"required":["RequestingUser","OMSId","reportFlavor","createTime","initialRunTime","intervalStartTime","intervalEndTime","RequestStatus","ReportFrequency","intervalDuration","RequestId","lastInstanceId","accountIds"],"title":"GenerateTradeActivityReportResponse"}}}}
```

## The GenerateTransactionActivityReportRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GenerateTransactionActivityReportRequest":{"type":"object","properties":{"accountIdList":{"type":"array","items":{"type":"integer"},"description":"A comma-delimited array of one ore more account IDs, each valid on a single OMS for the authenticated user. The account user may not be the only user of the account."},"omsId":{"type":"integer","description":"The ID of the OMS on which the array of account IDs resides."},"startTime":{"type":"string","description":"Identifies the time and date for the historic beginning of the transaction activity report."},"endTime":{"type":"string","description":"Identifies the time and date for the historic end of the transaction activity report."}},"required":["accountIdList","omsId","startTime","endTime"],"title":"GenerateTransactionActivityReportRequest"}}}}
```

## The GenerateTransactionActivityReportResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GenerateTransactionActivityReportResponse":{"type":"object","properties":{"RequestingUser":{"type":"integer","description":"The User ID of the person requesting the transaction activity report. This confirms the ID of the authenticated user who made the request by returning it as part of the response."},"OMSId":{"type":"integer","description":"The ID of the OMS on which the transaction activity report will be run."},"reportFlavor":{"type":"string","description":"The type of report to be generated. In the case of GenerateTransactionActivityReport, report flavor will always be **TransactionActivity**."},"createTime":{"type":"string","description":"The time and date on which the request for the transaction activity report was made."},"initialRunTime":{"type":"string","description":"The time and date at which the transaction activity report was first run."},"intervalStartTime":{"type":"string","description":"The start of the period that the report will cover."},"intervalEndTime":{"type":"string","description":"The end of the period that the report will cover."},"RequestStatus":{"type":"string","enum":["Submitted","Validating","Scheduled","InProgress","Completed","Aborting","Aborted","UserCancelled","SysRetired","UserCancelled","Pending"],"description":"The status of the request for the transaction activity report. A Generate~Report request will always return _Submitted_. One of: Submitted, Validating, Scheduled, InProgress, Completed, Aborting, Aborted, UserCancelled, SysRetired, UserCancelled, Pending."},"ReportFrequency":{"type":"string","enum":["OnDemand","Hourly","Daily","Weekly","Monthly","Annually"],"description":"When the report runs. For a **Generate~Report** call, this is always OnDemand. One of: OnDemand, Hourly, Daily, Weekly, Monthly, Annually."},"intervalDuration":{"type":"integer","format":"int64","description":"The period that the report covers relative to the run date. The **Generate~Report** call requires a start time and an end time. The Notbank software calculates the difference between them as _intervalDuration_. For example, say that you specify a 90-day start-date-to-end-date window for a report. The _intervalDuration_ value returns a value equivalent to 90 days. If you have called **Generate~Report**, that value simply confirms the length of time that the on-demand report covers."},"RequestId":{"type":"string","description":"The ID of the original request. Request IDs are long strings unique within the OMS."},"lastInstanceId":{"type":"string","description":"For scheduled reports, the report ID of the most recent previously run report. Will be _null_ for a **Generate~Report** call, because generated reports are on-demand."},"accountIds":{"type":"array","items":{"type":"integer"},"description":"A comma-delimited array of account IDs whose transactions are reported in the transaction activity report."}},"required":["RequestingUser","OMSId","reportFlavor","createTime","initialRunTime","intervalStartTime","intervalEndTime","RequestStatus","ReportFrequency","intervalDuration","RequestId","lastInstanceId","accountIds"],"title":"GenerateTransactionActivityReportResponse"}}}}
```

## The GenerateProductDeltaActivityReportRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GenerateProductDeltaActivityReportRequest":{"type":"object","properties":{"accountIdList":{"type":"array","items":{"type":"integer"},"description":"A comma-delimited array of one ore more account IDs, each valid on a single OMS for the authenticated user. The account user may not be the only user of the account."},"omsId":{"type":"integer","description":"The ID of the OMS on which the array of account IDs resides."},"startTime":{"type":"string","description":"Identifies the time and date for the historic beginning of the product delta activity report."},"endTime":{"type":"string","description":"Identifies the time and date for the historic end of the product delta activity report."}},"required":["accountIdList","omsId","startTime","endTime"],"title":"GenerateProductDeltaActivityReportRequest"}}}}
```

## The GenerateProductDeltaActivityReportResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GenerateProductDeltaActivityReportResponse":{"type":"object","properties":{"RequestingUser":{"type":"integer","description":"The User ID of the person requesting the product delta activity report. This confirms the ID of the authenticated user who made the request by returning it as part of the response."},"OMSId":{"type":"integer","description":"The ID of the OMS on which the product delta activity report will be run."},"reportFlavor":{"type":"string","description":"The type of report to be generated. In the case of GenerateProductDeltaActivityReport, report flavor will always be **ProductDelta**."},"createTime":{"type":"string","description":"The time and date on which the request for the product delta activity report was made."},"initialRunTime":{"type":"string","description":"The time and date at which the product delta activity report was first run."},"intervalStartTime":{"type":"string","description":"The start of the period that the report will cover."},"intervalEndTime":{"type":"string","description":"The end of the period that the report will cover."},"RequestStatus":{"type":"string","enum":["Submitted","Validating","Scheduled","InProgress","Completed","Aborting","Aborted","UserCancelled","SysRetired","UserCancelled","Pending"],"description":"The status of the request for the product delta activity report. A Generate~Report request will always return _Submitted_. One of: Submitted, Validating, Scheduled, InProgress, Completed, Aborting, Aborted, UserCancelled, SysRetired, UserCancelled, Pending."},"ReportFrequency":{"type":"string","enum":["OnDemand","Hourly","Daily","Weekly","Monthly","Annually"],"description":"When the report runs. For a **Generate~Report** call, this is always OnDemand. One of: OnDemand, Hourly, Daily, Weekly, Monthly, Annually."},"intervalDuration":{"type":"integer","format":"int64","description":"The period that the report covers relative to the run date. The **Generate~Report** call requires a start time and an end time. The Notbank software calculates the difference between them as _intervalDuration_. For example, say that you specify a 90-day start-date-to-end-date window for a report. The _intervalDuration_ value returns a value equivalent to 90 days. If you have called **Generate~Report**, that value simply confirms the length of time that the on-demand report covers."},"RequestId":{"type":"string","description":"The ID of the original request. Request IDs are long strings unique within the OMS."},"lastInstanceId":{"type":"string","description":"For scheduled reports, the report ID of the most recent previously run report. Will be _null_ for a **Generate~Report** call, because generated reports are on-demand."},"accountIds":{"type":"array","items":{"type":"integer"},"description":"A comma-delimited array of account IDs whose transactions are reported in the product delta activity report."}},"required":["RequestingUser","OMSId","reportFlavor","createTime","initialRunTime","intervalStartTime","intervalEndTime","RequestStatus","ReportFrequency","intervalDuration","RequestId","lastInstanceId","accountIds"],"title":"GenerateProductDeltaActivityReportResponse"}}}}
```

## The GeneratePnLActivityReportRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GeneratePnLActivityReportRequest":{"type":"object","properties":{"accountIdList":{"type":"array","items":{"type":"integer"},"description":"A comma-delimited array of one ore more account IDs, each valid on a single OMS for the authenticated user. The account user may not be the only user of the account."},"omsId":{"type":"integer","description":"The ID of the OMS on which the array of account IDs resides."},"startTime":{"type":"string","description":"Identifies the time and date for the historic beginning of the profit and loss activity report."},"endTime":{"type":"string","description":"Identifies the time and date for the historic end of the profit and loss activity report."}},"required":["accountIdList","omsId","startTime","endTime"],"title":"GeneratePnLActivityReportRequest"}}}}
```

## The GeneratePnLActivityReportResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GeneratePnLActivityReportResponse":{"type":"object","properties":{"RequestingUser":{"type":"integer","description":"The User ID of the person requesting the profit and loss activity report. This confirms the ID of the authenticated user who made the request by returning it as part of the response."},"OMSId":{"type":"integer","description":"The ID of the OMS on which the profit and loss activity report will be run."},"reportFlavor":{"type":"string","description":"The type of report to be generated. In the case of GeneratePnLActivityReport, report flavor will always be **ProfitAndLoss**."},"createTime":{"type":"string","description":"The time and date on which the request for the profit and loss activity report was made."},"initialRunTime":{"type":"string","description":"The time and date at which the profit and loss activity report was first run."},"intervalStartTime":{"type":"string","description":"The start of the period that the report will cover."},"intervalEndTime":{"type":"string","description":"The end of the period that the report will cover."},"RequestStatus":{"type":"string","enum":["Submitted","Validating","Scheduled","InProgress","Completed","Aborting","Aborted","UserCancelled","SysRetired","UserCancelled","Pending"],"description":"The status of the request for the profit and loss activity report. A Generate~Report request will always return _Submitted_. One of: Submitted, Validating, Scheduled, InProgress, Completed, Aborting, Aborted, UserCancelled, SysRetired, UserCancelled, Pending."},"ReportFrequency":{"type":"string","enum":["OnDemand","Hourly","Daily","Weekly","Monthly","Annually"],"description":"When the report runs. For a **Generate~Report** call, this is always OnDemand. One of: OnDemand, Hourly, Daily, Weekly, Monthly, Annually."},"intervalDuration":{"type":"integer","format":"int64","description":"The period that the report covers relative to the run date. The **Generate~Report** call requires a start time and an end time. The Notbank software calculates the difference between them as _intervalDuration_. For example, say that you specify a 90-day start-date-to-end-date window for a report. The _intervalDuration_ value returns a value equivalent to 90 days. If you have called **Generate~Report**, that value simply confirms the length of time that the on-demand report covers."},"RequestId":{"type":"string","description":"The ID of the original request. Request IDs are long strings unique within the OMS."},"lastInstanceId":{"type":"string","description":"For scheduled reports, the report ID of the most recent previously run report. Will be _null_ for a **Generate~Report** call, because generated reports are on-demand."},"accountIds":{"type":"array","items":{"type":"integer"},"description":"A comma-delimited array of account IDs whose transactions are reported in the profit and loss activity report."}},"required":["RequestingUser","OMSId","reportFlavor","createTime","initialRunTime","intervalStartTime","intervalEndTime","RequestStatus","ReportFrequency","intervalDuration","RequestId","lastInstanceId","accountIds"],"title":"GeneratePnLActivityReportResponse"}}}}
```

## The ScheduleTradeActivityReportRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"ScheduleTradeActivityReportRequest":{"type":"object","properties":{"Frequency":{"oneOf":[{"type":"integer"},{"type":"string"}],"enum":[0,1,2,3,4,5],"default":0,"description":"How often the report will run and a trade report get generated. One of: 0 Hourly, 1 Daily, 2 Weekly, 3 Monthly, 4 Annually, 5 onDemand. Default is 0 Hourly."},"accountIdList":{"type":"array","items":{"type":"integer"},"description":"Comma-separated integers; each element an account ID on the OMS whose trade activity will be reported on. All accounts must be from the same OMS."},"OMSId":{"type":"integer","description":"The ID of the OMS on which the accounts named in the list reside."},"beginTime":{"type":"string","description":"The time at which the periodic reports begin; the day and time when you want reporting to start, in Microsoft Ticks format."}},"required":["accountIdList","OMSId","beginTime"],"title":"ScheduleTradeActivityReportRequest"}}}}
```

## The ScheduleTradeActivityReportResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"ScheduleTradeActivityReportResponse":{"type":"object","properties":{"RequestingUser":{"type":"integer","description":"The User ID of the person requesting the trade activity report. This confirms the ID of the authenticated user who made the request by returning it as part of the response."},"OMSId":{"type":"integer","description":"The ID of the OMS on which the trade activity report will be run."},"reportFlavor":{"type":"string","description":"The type of report to be generated. In the case of ScheduleTradeActivityReport, report flavor will always be **TradeActivity**."},"createTime":{"type":"string","description":"The time and date on which the request for the trade activity report was made, in Microsoft Ticks format."},"initialRunTime":{"type":"string","description":"The time and date at which the trade activity report was first run, in Microsoft Ticks format."},"intervalStartTime":{"type":"string","description":"The start of the period that the report will cover, in Microsoft Ticks format."},"intervalEndTime":{"type":"string","description":"The end of the period that the report will cover, in Microsoft Ticks format."},"RequestStatus":{"type":"string","enum":["Submitted","Validating","Scheduled","InProgress","Completed","Aborting","Aborted","UserCancelled","SysRetired","UserCancelledPending"],"description":"The status of the request for the trade activity report. One of: Submitted, Validating, Scheduled, InProgress, Completed, Aborting, Aborted, UserCancelled, SysRetired, UserCancelledPending."},"ReportFrequency":{"type":"string","enum":["OnDemand","Hourly","Daily","Weekly","Monthly","Annually"],"description":"When the report runs. One of: OnDemand, Hourly, Daily, Weekly, Monthly, Annually."},"intervalDuration":{"type":"integer","format":"int64","description":"The period that the report covers relative to the run date, in POSIX format. The call specifies a start time and an _intervalDuration_. In a scheduled report, the interval duration depends on the frequency. If the frequency is **Weekly**, the interval duration will be 1 week."},"RequestId":{"type":"string","description":"The ID of the original request. Request IDs are long strings unique within the OMS."},"lastInstanceId":{"type":"string","description":"For scheduled reports, the report ID of the most recent previously run report."},"accountIds":{"type":"array","items":{"type":"integer"},"description":"A comma-delimited array of account IDs whose trades are reported in the trade activity report."}},"required":["RequestingUser","OMSId","reportFlavor","createTime","initialRunTime","intervalStartTime","intervalEndTime","RequestStatus","ReportFrequency","intervalDuration","RequestId","lastInstanceId","accountIds"],"title":"ScheduleTradeActivityReportResponse"}}}}
```

## The ScheduleTransactionActivityReportRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"ScheduleTransactionActivityReportRequest":{"type":"object","properties":{"frequency":{"oneOf":[{"type":"integer"},{"type":"string"}],"enum":[0,1,2,3,4,5],"default":"Hourly","description":"How often the report will run and a trade report get generated. One of: 0 Hourly, 1 Daily, 2 Weekly, 3 Monthly, 4 Annually, 5 onDemand. Default is Hourly."},"accountIdList":{"type":"array","items":{"type":"integer"},"description":"Comma-separated integers; each element an account ID on the OMS whose transaction activity will be reported on. All accounts must be from the same OMS."},"omsId":{"type":"integer","description":"The ID of the OMS on which the accounts named in the list reside."},"beginTime":{"type":"string","description":"The time at which the periodic reports begin; the day and time when you want reporting to start, in Microsoft Ticks format."}},"required":["accountIdList","omsId","beginTime"],"title":"ScheduleTransactionActivityReportRequest"}}}}
```

## The ScheduleTransactionActivityReportResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"ScheduleTransactionActivityReportResponse":{"type":"object","properties":{"RequestingUser":{"type":"integer","description":"The User ID of the person requesting the transaction activity report. This confirms the ID of the authenticated user who made the request by returning it as part of the response."},"OMSId":{"type":"integer","description":"The ID of the OMS on which the transaction activity report will be run."},"reportFlavor":{"type":"string","description":"The type of report to be generated. In the case of ScheduleTransactionActivityReport, report flavor will always be **Transaction**."},"createTime":{"type":"string","description":"The time and date on which the request for the transaction activity report was made, in Microsoft Ticks format."},"initialRunTime":{"type":"string","description":"The time and date at which the transaction activity report was first run, in Microsoft Ticks format."},"intervalStartTime":{"type":"string","description":"The start of the period that the report will cover, in Microsoft Ticks format."},"intervalEndTime":{"type":"string","description":"The end of the period that the report will cover, in Microsoft Ticks format."},"RequestStatus":{"type":"string","enum":["Submitted","Validating","Scheduled","InProgress","Completed","Aborting","Aborted","UserCancelled","SysRetired","UserCancelledPending"],"description":"The status of the request for the transaction activity report. One of: Submitted, Validating, Scheduled, InProgress, Completed, Aborting, Aborted, UserCancelled, SysRetired, UserCancelledPending."},"ReportFrequency":{"type":"string","enum":["OnDemand","Hourly","Daily","Weekly","Monthly","Annually"],"description":"When the report runs. One of: OnDemand, Hourly, Daily, Weekly, Monthly, Annually."},"intervalDuration":{"type":"integer","format":"int64","description":"The period that the report covers relative to the run date, in POSIX format. The call specifies a start time and an _intervalDuration_. In a scheduled report, the interval duration depends on the frequency, if the frequency is **Weekly**, the interval duration will be 1 week."},"RequestId":{"type":"string","description":"The ID of the original request. Request IDs are long strings unique within the OMS."},"lastInstanceId":{"type":"string","description":"For scheduled reports, the report ID of the most recent previously run report."},"accountIds":{"type":"array","items":{"type":"integer"},"description":"A comma-delimited array of account IDs whose transactions are reported in the transaction activity report."}},"required":["RequestingUser","OMSId","reportFlavor","createTime","initialRunTime","intervalStartTime","intervalEndTime","RequestStatus","ReportFrequency","intervalDuration","RequestId","lastInstanceId","accountIds"],"title":"ScheduleTransactionActivityReportResponse"}}}}
```

## The ScheduleProductDeltaActivityReportRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"ScheduleProductDeltaActivityReportRequest":{"type":"object","properties":{"frequency":{"oneOf":[{"type":"integer"},{"type":"string"}],"enum":[0,1,2,3,4,5],"default":0,"description":"How often the report will run and a product delta activity report get generated. One of: 0 Hourly, 1 Daily, 2 Weekly, 3 Monthly, 4 Annually, 5 onDemand. Default is 0 Hourly."},"accountIdList":{"type":"array","items":{"type":"integer"},"description":"Comma-separated integers; each element an account ID on the OMS whose product delta activity will be reported on. All accounts must be from the same OMS."},"omsId":{"type":"integer","description":"The ID of the OMS on which the accounts named in the list reside."},"beginTime":{"type":"string","description":"The time at which the periodic reports begin; the day and time when you want reporting to start, in Microsoft Ticks format."}},"required":["accountIdList","omsId","beginTime"],"title":"ScheduleProductDeltaActivityReportRequest"}}}}
```

## The ScheduleProductDeltaActivityReportResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"ScheduleProductDeltaActivityReportResponse":{"type":"object","properties":{"RequestingUser":{"type":"integer","description":"The User ID of the person requesting the product delta activity report. This confirms the ID of the authenticated user who made the request by returning it as part of the response."},"OMSId":{"type":"integer","description":"The ID of the OMS on which the product delta activity report will be run."},"reportFlavor":{"type":"string","description":"The type of report to be generated. In the case of ScheduleProductDeltaActivityReport, report flavor will always be **ProductDelta**."},"createTime":{"type":"string","description":"The time and date on which the request for the product delta activity report was made, in Microsoft Ticks format."},"initialRunTime":{"type":"string","description":"The time and date at which the product delta activity report was first run, in Microsoft Ticks format."},"intervalStartTime":{"type":"string","description":"The start of the period that the report will cover, in Microsoft Ticks format."},"intervalEndTime":{"type":"string","description":"The end of the period that the report will cover, in Microsoft Ticks format."},"RequestStatus":{"type":"string","enum":["Submitted","Validating","Scheduled","InProgress","Completed","Aborting","Aborted","UserCancelled","SysRetired","UserCancelledPending"],"description":"The status of the request for the product delta activity report. One of: Submitted, Validating, Scheduled, InProgress, Completed, Aborting, Aborted, UserCancelled, SysRetired, UserCancelledPending."},"ReportFrequency":{"type":"string","enum":["OnDemand","Hourly","Daily","Weekly","Monthly","Annually"],"description":"When the report runs. One of: OnDemand, Hourly, Daily, Weekly, Monthly, Annually."},"intervalDuration":{"type":"integer","format":"int64","description":"The period that the report covers relative to the run date, in POSIX format. The call specifies a start time and an _intervalDuration_. In a scheduled report, the interval duration depends on the frequency, if the frequency is **Weekly**, the interval duration will be 1 week."},"RequestId":{"type":"string","description":"The ID of the original request. Request IDs are long strings unique within the OMS."},"lastInstanceId":{"type":"string","description":"For scheduled reports, the report ID of the most recent previously run report."},"accountIds":{"type":"array","items":{"type":"integer"},"description":"A comma-delimited array of account IDs whose transactions are reported in the product delta activity report."}},"required":["RequestingUser","OMSId","reportFlavor","createTime","initialRunTime","intervalStartTime","intervalEndTime","RequestStatus","ReportFrequency","intervalDuration","RequestId","lastInstanceId","accountIds"],"title":"ScheduleProductDeltaActivityReportResponse"}}}}
```

## The ScheduleProfitAndLossActivityReportRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"ScheduleProfitAndLossActivityReportRequest":{"type":"object","properties":{"frequency":{"oneOf":[{"type":"integer"},{"type":"string"}],"enum":[0,1,2,3,4,5],"default":0,"description":"How often the report will run and a profit and lost activity report get generated. One of: 0 Hourly, 1 Daily, 2 Weekly, 3 Monthly, 4 Annually, 5 onDemand. Default is 0 Hourly."},"accountIdList":{"type":"array","items":{"type":"integer"},"description":"Comma-separated integers; each element an account ID on the OMS whose profit and loss activity will be reported on. All accounts must be from the same OMS."},"omsId":{"type":"integer","description":"The ID of the OMS on which the accounts named in the list reside."},"beginTime":{"type":"string","description":"The time at which the periodic reports begin; the day and time when you want reporting to start, in Microsoft Ticks format."}},"required":["accountIdList","omsId","beginTime"],"title":"ScheduleProfitAndLossActivityReportRequest"}}}}
```

## The ScheduleProfitAndLossActivityReportResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"ScheduleProfitAndLossActivityReportResponse":{"type":"object","properties":{"RequestingUser":{"type":"integer","description":"The User ID of the person requesting the profit and loss activity report. This confirms the ID of the authenticated user who made the request by returning it as part of the response."},"OMSId":{"type":"integer","description":"The ID of the OMS on which the profit and loss activity report will be run."},"reportFlavor":{"type":"string","description":"The type of report to be generated. In the case of ScheduleProfitandLossActivityReport, report flavor will always be **ProfitAndLoss**."},"createTime":{"type":"string","description":"The time and date on which the request for the profit and loss activity report was made, in Microsoft Ticks format."},"initialRunTime":{"type":"string","description":"The time and date at which the profit and loss activity report was first run, in Microsoft Ticks format."},"intervalStartTime":{"type":"string","description":"The start of the period that the report will cover, in Microsoft Ticks format."},"intervalEndTime":{"type":"string","description":"The end of the period that the report will cover, in Microsoft Ticks format."},"RequestStatus":{"type":"string","enum":["Submitted","Validating","Scheduled","InProgress","Completed","Aborting","Aborted","UserCancelled","SysRetired","UserCancelledPending"],"description":"The status of the request for the profit and loss activity report. One of: Submitted, Validating, Scheduled, InProgress, Completed, Aborting, Aborted, UserCancelled, SysRetired, UserCancelledPending."},"ReportFrequency":{"type":"string","enum":["OnDemand","Hourly","Daily","Weekly","Monthly","Annually"],"description":"When the report runs. One of: OnDemand, Hourly, Daily, Weekly, Monthly, Annually."},"intervalDuration":{"type":"integer","format":"int64","description":"The period that the report covers relative to the run date, in POSIX format. The call specifies a start time and an _intervalDuration_. In a scheduled report, the interval duration depends on the frequency, if the frequency is **Weekly**, the interval duration will be 1 week."},"RequestId":{"type":"string","description":"The ID of the original request. Request IDs are long strings unique within the OMS."},"lastInstanceId":{"type":"string","description":"For scheduled reports, the report ID of the most recent previously run report."},"accountIds":{"type":"array","items":{"type":"integer"},"description":"A comma-delimited array of account IDs whose transactions are reported in the profit and loss activity report."}},"required":["RequestingUser","OMSId","reportFlavor","createTime","initialRunTime","intervalStartTime","intervalEndTime","RequestStatus","ReportFrequency","intervalDuration","RequestId","lastInstanceId","accountIds"],"title":"ScheduleProfitAndLossActivityReportResponse"}}}}
```

## The CancelUserReportRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"CancelUserReportRequest":{"type":"object","properties":{"UserReportId":{"type":"string","description":"The GUID is a globally unique ID string that identifies the user report to be canceled. The OMS provides this ID when you create a report."}},"required":["UserReportId"],"title":"CancelUserReportRequest"}}}}
```

## The CancelUserReportResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"CancelUserReportResponse":{"type":"object","properties":{"result":{"type":"boolean","description":"A successful receipt of the cancellation returns true; and unsuccessful receipt of the cancellation (an error condition) returns false."},"errormsg":{"type":"string","description":"A successful receipt of the cancellation returns null; the _errormsg_ parameter for an unsuccessful receipt returns one of the following messages: Not Authorized (errorcode 20), Invalid Request (errorcode 100), Operation Failed (errorcode 101), Server Error (errorcode 102), Resource Not Found (errorcode 104)."},"errorcode":{"type":"integer","description":"A successful receipt of the cancellation returns 0. An unsuccessful receipt returns one of the _errorcodes_ shown in the _errormsg_ list."},"detail":{"type":"string","description":"Message text that the system may send. Usually _null_."}},"required":["result","errormsg","errorcode","detail"],"title":"CancelUserReportResponse"}}}}
```

## The GetUserReportWriterResultRecordsRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetUserReportWriterResultRecordsRequest":{"type":"object","properties":{"UserId":{"type":"integer","description":"The ID of the user whose report writer result records will be returned."},"Depth":{"type":"integer","description":"The count of records to be returned, beginning at _startIndex_ and working backwards into the past. If not defined, all report writer result records will be returned."},"StartIndex":{"type":"integer","description":"The record number at which the call starts returning records; from there, record return moves into the past. The most recent record is record is at startindex 0."}},"required":["UserId"],"title":"GetUserReportWriterResultRecordsRequest"}}}}
```

## The GetUserReportWriterResultRecordsResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetUserReportWriterResultRecordsResponse":{"type":"object","properties":{"RequestingUser":{"type":"integer","description":"The ID of the user requesting the report writer result records."},"urtTicketId":{"type":"string","description":"An alphanumeric string containing the unique report ID of the report."},"descriptorId":{"type":"string","description":"A GUID (globally-unique identifier) that describes the report separately from the report ticket."},"resultStatus":{"type":"string","enum":["NotStarted","NotComplete","ErrorComplete","SuccessComplete","Cancelled"],"description":"The status of each run of the reports. One of: 0 NotStarted, 1 NotComplete, 2 ErrorComplete, 3 SuccessComplete, 4 Cancelled."},"reportExecutionStartTime":{"type":"string","description":"The time that the report writer began execution, in Microsoft Ticks format."},"reportExecutionCompleteTime":{"type":"string","description":"The time that the report writer completed the report, in Microsoft Ticks format."},"reportOutputFilePathname":{"type":"string","description":"The pathname (location) of the report output file."},"reportDescriptiveHeader":{"type":"string","description":"A string describing the report."}},"required":["RequestingUser","urtTicketId","descriptorId","resultStatus","reportExecutionStartTime","reportExecutionCompleteTime","reportOutputFilePathname","reportDescriptiveHeader"],"title":"GetUserReportWriterResultRecordsResponse"}}}}
```

## The GetUserReportTicketsRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetUserReportTicketsRequest":{"type":"object","properties":{"UserId":{"type":"integer","description":"The ID of the user whose user report tickets will be returned."}},"required":["UserId"],"title":"GetUserReportTicketsRequest"}}}}
```

## The GetUserReportTicketsResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetUserReportTicketsResponse":{"type":"array","items":{"type":"object","properties":{"RequestingUser":{"type":"integer","description":"The User ID of the person requesting the report."},"OMSId":{"type":"integer","description":"The ID of the OMS on which the report was run."},"reportFlavor":{"type":"string","description":"The type of report. One of, Tradeactivity, Transaction, Treasury."},"createTime":{"type":"string","description":"The time and date at which the request for the report was made, Microsoft Ticks format."},"initialRunTime":{"type":"string","description":"The time and date at which the report was first run, Microsoft Ticks format."},"intervalStartTime":{"type":"string","description":"The start of the period that the report will cover, Microsoft Ticks format."},"intervalEndTime":{"type":"string","description":"The end of the period that the report will cover, Microsoft Ticks format."},"RequestStatus":{"type":"string","enum":["Submitted","Validating","Scheduled","InProgress","Completed","Aborting","Aborted","UserCancelled","SysRetired","UserCancelPending"],"description":"The status of the request for the report. Each status returns one of: Submitted, Validating, Scheduled, InProgress, Completed, Aborting, Aborted, UserCancelled, SysRetired, UserCancelPending."},"ReportFrequency":{"type":"string","description":"When the report runs: OnDemand, Hourly, Daily, Weekly, Monthly, Annually."},"intervalDuration":{"type":"integer","format":"int64","description":"The period that the report looks backward relative to the run date, in POSIX format. The system calculates _intervalDuration_ between _intervalStartTime_ and _intervalEndTime_ and reports it in POSIX format. For example, say that you specify a 90-day start-to-end-date window for a report. The _intervalDuration_ value returns a value equivalent to 90 days and represents the backward-looking period of the report. Say that you have set up a weekly report to look back 90 days. When the report runs again in a week's time, it again looks back 90 days -- but now those 90 days are offset by a week from the first report."},"RequestId":{"type":"string","description":"The ID of the original request. Request IDs are long strings unique within the OMS."},"lastInstanceId":{"type":"string","description":"For scheduled reports, the report ID of the most recent previously run report. This will be _null_ for a Generate~Report call, because generated reports are all on-demand."},"accountIds":{"type":"array","items":{"type":"integer"},"description":"A comma-delimited array of account IDs whose trades are reported in the trade activity report."}},"required":["RequestingUser","OMSId","reportFlavor","createTime","initialRunTime","intervalStartTime","intervalEndTime","RequestStatus","ReportFrequency","intervalDuration","RequestId","lastInstanceId","accountIds"]},"title":"GetUserReportTicketsResponse"}}}}
```

## The RemoveUserReportTicketRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"RemoveUserReportTicketRequest":{"type":"string","description":"the user report TicketId of the ticket to remove.","required":true,"title":"RemoveUserReportTicketRequest"}}}}
```

## The RemoveUserReportTicketResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"RemoveUserReportTicketResponse":{"type":"object","properties":{"result":{"type":"boolean","description":"A successful request returns _true_; and unsuccessful request (an error condition) returns _false_."},"errormsg":{"type":"string","description":"A successful request returns _null_; the _errormsg_ parameter for an unsuccessful request returns one of the following messages:. Not Authorized (errorcode 20). Invalid Request (errorcode 100). Operation Failed (errorcode 101). Server Error (errorcode 102). Resource Not Found (errorcode 104)."},"errorcode":{"type":"integer","description":"A successful request returns 0. An unsuccessful receipt returns one of the _errorcodes_ shown in the _errormsg_ list."},"detail":{"type":"string","description":"Additional message details sent by the system. Usually _null_."}},"required":["result","errormsg","errorcode","detail"],"title":"RemoveUserReportTicketResponse"}}}}
```

## The GetUserReportTicketsByStatusRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetUserReportTicketsByStatusRequest":{"type":"array","items":{"type":"object","description":"The statuses of user report tickets you wish to retrieve. Multiple statuses can be specified. If no Request status is defined, the default status that the backend will look for is Submitted.","properties":{"RequestStatus":{"type":"string","enum":["Submitted","Validating","Scheduled","InProgress","Completed","Aborting","Aborted","UserCancelled","SysRetired","UserCancelPending"],"description":"A status of user report tickets. One of: Submitted, Validating, Scheduled, InProgress, Completed, Aborting, Aborted, UserCancelled, SysRetired, UserCancelPending."}},"required":["RequestStatus"]},"title":"GetUserReportTicketsByStatusRequest"}}}}
```

## The GetUserReportTicketsByStatusResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetUserReportTicketsByStatusResponse":{"type":"array","items":{"type":"object","properties":{"RequestingUser":{"type":"integer","description":"The User ID of the person requesting the trade activity report. This confirms the ID of the authenticated user who made the request by returning it as part of the response."},"OMSId":{"type":"integer","description":"The ID of the OMS on which the trade activity report will be run."},"reportFlavor":{"type":"string","description":"The type of report to be generated. In the case of GenerateTradeActivityReport, report flavor will always be **TradeActivity**."},"createTime":{"type":"string","description":"The time and date on which the request for the trade activity report was made."},"initialRunTime":{"type":"string","description":"The time and date at which the trade activity report was first run."},"intervalStartTime":{"type":"string","description":"The start of the period that the report will cover."},"intervalEndTime":{"type":"string","description":"The end of the period that the report will cover."},"RequestStatus":{"type":"string","enum":["Submitted","Validating","Scheduled","InProgress","Completed","Aborting","Aborted","UserCancelled","SysRetired","UserCancelled","Pending"],"description":"The status of the request for the trade activity report. A **Generate~Report** request will always return _Submitted_. One of: Submitted, Validating, Scheduled, InProgress, Completed, Aborting, Aborted, UserCancelled, SysRetired, UserCancelled, Pending."},"ReportFrequency":{"type":"string","enum":["OnDemand","Hourly","Daily","Weekly","Monthly","Annually"],"description":"When the report runs. For a **Generate~Report** request, this is always OnDemand. One of: OnDemand, Hourly, Daily, Weekly, Monthly, Annually."},"intervalDuration":{"type":"integer","format":"int64","description":"The period that the report covers relative to the run date. The **Generate~Report** request requires a start time and an end time. The Notbank software calculates the difference between them as _intervalDuration_. For example, say that you specify a 90-day start-date-to-end-date window for a report. The _intervalDuration_ value returns a value equivalent to 90 days. If you have called **Generate~Report**, that value simply confirms the length of time that the on-demand report covers."},"RequestId":{"type":"string","description":"The ID of the original request. Request IDs are long strings unique within the OMS."},"lastInstanceId":{"type":"string","description":"For scheduled reports, the report ID of the most recent previously run report. Will be _null_ for a **Generate~Report** call, because generated reports are on-demand."},"accountIds":{"type":"array","items":{"type":"integer"},"description":"A comma-delimited array of account IDs whose trades are reported in the trade activity report."}},"required":["RequestingUser","OMSId","reportFlavor","createTime","initialRunTime","intervalStartTime","intervalEndTime","RequestStatus","ReportFrequency","intervalDuration","RequestId","lastInstanceId","accountIds"]},"title":"GetUserReportTicketsByStatusResponse"}}}}
```

## The DownloadDocumentRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"DownloadDocumentRequest":{"type":"object","properties":{"DescriptorId":{"type":"string","description":"The GUID that uniquely identifies a report that can be downloaded."}},"required":["DescriptorId"],"title":"DownloadDocumentRequest"}}}}
```

## The DownloadDocumentResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"DownloadDocumentResponse":{"type":"object","properties":{"DescriptorId":{"type":"string","description":"The GUID that uniquely identifies a report that can be downloaded."},"DocName":{"type":"string","description":"The actual filename of the document stored in the server."},"NumSlices":{"type":"integer","description":"The number of slices."},"statusCode":{"type":"string","enum":["Success","Error"],"description":"One of: **Success**, **Error**."},"statusMessage":{"type":"string","enum":["success","error"],"description":"One of: **success**, **error**."}},"required":["DescriptorId","DocName","NumSlices","statusCode","statusMessage"],"title":"DownloadDocumentResponse"}}}}
```

## The DownloadDocumentSliceRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"DownloadDocumentSliceRequest":{"type":"object","properties":{"DescriptorId":{"type":"string","description":"The GUID that uniquely identifies a report that can be downloaded."},"sliceNum":{"type":"integer","default":0,"description":"Default is 0."}},"required":["DescriptorId"],"title":"DownloadDocumentSliceRequest"}}}}
```

## The DownloadDocumentSliceResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"DownloadDocumentSliceResponse":{"type":"object","properties":{"DescriptorId":{"type":"string","description":"The GUID that uniquely identifies a report that can be downloaded."},"base64Bytes":{"type":"string","description":"The actual contents of the document in base64 format."},"statusCode":{"type":"string","enum":["Success","Error"],"description":"One of: **Success**, **Error**."},"statusMessage":{"type":"string","enum":["success","error"],"description":"One of: **success**, **error**."}},"required":["DescriptorId","base64Bytes","statusCode","statusMessage"],"title":"DownloadDocumentSliceResponse"}}}}
```

## The PingRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"PingRequest":{"type":"object","properties":{"msg":{"type":"string","description":"PONG means Ping request was successful and the gateway has responded."}},"required":["msg"],"title":"PingRequest"}}}}
```

## The PingResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"PingResponse":{"type":"object","properties":{"msg":{"type":"string","description":"PONG means Ping request was successful and the gateway has responded."}},"required":["msg"],"title":"PingResponse"}}}}
```

## The HealthCheckResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"HealthCheckResponse":{"type":"object","properties":{"result":{"type":"boolean","description":"A successful request returns true; and unsuccessful request (an error condition) returns false."},"errormsg":{"type":"string","description":"A successful request returns null; the _errormsg_ parameter for an unsuccessful request returns one of the following messages: Not Authorized (errorcode 20), Invalid Request (errorcode 100), Operation Failed (errorcode 101), Server Error (errorcode 102), Resource Not Found (errorcode 104)."},"errorcode":{"type":"integer","description":"A successful request returns 0. An unsuccessful request returns one of the _errorcodes_ shown in the _errormsg_ list."},"detail":{"type":"string","description":"A string description of the status of the exchange, plus the json string representation, defnied as: { \"LatencyMetadata\": { \"type\": \"object\", \"description\": \"Detailed timestamps and round-trip metrics for request tracing.\", \"properties\": { \"ExchangeId\": { \"type\": \"integer\", \"format\": \"int32\", \"description\": \"The unique ID of the Exchange.\", \"example\": 1 }, \"Data1\": { \"type\": \"integer\", \"format\": \"int64\", \"description\": \"Initial processing timestamp in UTC.\" }, \"Data2\": { \"type\": \"integer\", \"format\": \"int64\", \"description\": \"Internal flag.\", \"default\": 1 }, \"OmsId\": { \"type\": \"integer\", \"format\": \"int64\", \"default\": 0 }, \"GatewayIn\": { \"type\": \"integer\", \"format\": \"int64\", \"description\": \"Timestamp when the request reached the Gateway (UTC).\" }, \"OmsIn\": { \"type\": \"integer\", \"format\": \"int64\", \"description\": \"Timestamp when the request reached the OMS (UTC).\" }, \"MatchingEngineIn\": { \"type\": \"integer\", \"format\": \"int64\", \"description\": \"Timestamp when the request reached the Matching Engine (UTC).\" }, \"OmsOut\": { \"type\": \"integer\", \"format\": \"int64\", \"description\": \"Timestamp when the OMS finished the check (UTC).\" }, \"GatewayOut\": { \"type\": \"integer\", \"format\": \"int64\", \"description\": \"Timestamp when the response left the Gateway (UTC).\" }, \"RoundTripTimeMic\": { \"type\": \"integer\", \"format\": \"int64\", \"description\": \"Total duration of all internal checks in milliseconds.\", \"example\": 15 } } } }"}},"required":["result","errormsg","errorcode","detail"],"title":"HealthCheckResponse"}}}}
```

## The SendOrderListRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"SendOrderListRequest":{"type":"array","items":{"type":"object","properties":{"InstrumentId":{"type":"integer","description":"The ID of the instrument being traded."},"OMSId":{"type":"integer","description":"The ID of the OMS on which the instrument is being traded."},"AccountId":{"type":"integer","description":"The ID of the account the order will be placed for."},"TimeInForce":{"type":"integer","enum":[0,1,2,3,4,5,6],"description":"An integer that represents the period during which the new order is executable. One of: **0** Unknown (an error condition), **1** GTC (good 'til canceled, the default), **2** OPG (execute as close to opening price as possible: not yet used, for future provision), **3** IOC (immediate or canceled), **4** FOK (fill-or-kill — fill immediately or kill immediately), **5** GTX (good 'til executed: not yet used, for future provision), **6** GTD (good 'til date: not yet used, for future provision)."},"ClientOrderId":{"type":"integer","format":"int64","default":0,"description":"A user-assigned ID for the order (like a purchase-order number assigned by a company). This ID is useful for recognizing future states related to this order. Duplicate client orderid of two open orders of the same account is not allowed, the incoming order with the same ClientOrderId will get rejected. Default is 0."},"OrderIdOCO":{"type":"integer","format":"int64","description":"The order ID if One Cancels the Other — If this order is order A, _OrderIdOCO_ refers to the order ID of an order B (which is _not_ the order being created by this call). If order B executes, then order A created by this call is canceled. You can also set up order B to watch order A in the same way, but that may require an update to order B to make it watch this one, which could have implications for priority in the order book. See [**CancelReplaceOrder**](#operation/CancelReplaceOrder) and [**ModifyOrder**](#operation/ModifyOrder)."},"UseDisplayQuantity":{"type":"boolean","default":false,"description":"If you enter a Limit order with a reserve (reserve order), you must set _UseDisplayQuantity_ to _true_ else, the quantity of your order will be 0, defaults to **false**."},"Side":{"type":"integer","enum":[0,1],"description":"A number representing the side of a trade. One of: **0** Buy, **1** Sell."},"Quantity":{"type":"number","format":"decimal","description":"The quantity of the instrument being ordered. Not required if **OrderType** is Market (1) and as long as **Value** is defined."},"OrderType":{"type":"integer","enum":[0,1,2,3,4,5,6,7],"description":"The type of the order. One of: **0** Unknown, **1** Market, **2** Limit, **3** StopMarket, **4** StopLimit, **5** TrailingStopMarket, **6** TrailingStopLimit, **7** BlockTrade."},"PegPriceType":{"oneOf":[{"type":"integer"},{"type":"string"}],"enum":[1,2,3,4],"default":1,"description":"Only applicable to TrailingStop and Stop orders. The type of price that pegs the stop. One of: 1 Last, 2 Bid, 3 Ask, 4 Midpoint (Currently unsupported; for future provision). Default is 1 Last."},"LimitPrice":{"type":"number","format":"decimal","description":"The price at which the order will be placed. Required if OrderType is **2 Limit** or **4 StopLimit** or **7 TrailingStopLimit**."},"StopPrice":{"type":"number","format":"decimal","default":0,"description":"Applicable to TrailingStop (Limit and Market) and Stop (Limit and Market) orders only; the price at which the order will get activated. Is not required to be defined for TrailingStop order as this price will be determined automatically based on the **TrailingAmount**, **PegPriceType** and most importantly the movement of the price where the order is pegged (**PegPriceType**). Default is 0."},"TrailingAmount":{"type":"number","format":"decimal","description":"Applicable to TrailingStopLimit and TrailingStopMarket orders only; a number that will be either added to (buy side) or subtracted from (sell side) the price where the order is pegged(depends on the **PegPriceType**); the sum or the difference will be the **StopPrice** of the **TrailingStop** order. On the buy side, if the price where the order is pegged increases and never goes down below the value when the order was placed, the resulting StopPrice will be the sum of the price where the order is pegged during submission and the TrailingAmount; however, if the price where the order is pegged decreases, the StopPrice will change, it will be the sum of the whatever is the lowest value the pegged price will have and the TrailingAmount: the logic on the sell side is the opposite."},"LimitOffset":{"type":"number","format":"decimal","description":"Applicable to TrailingStopLimit only; a number that will be either added (buy side) or subtracted (sell side) to the **StopPrice**, the sum or the difference will be the LimitPrice of the order when it gets activated."},"DisplayQuantity":{"type":"integer","description":"If _UseDisplayQuantity_ is set to _true_, you must set a value of this field greater than 0, else, order will not appear in the orderbook."},"Value":{"type":"number","format":"decimal","description":"The total value of the trade. Only applicable in a market order type: a user can opt to input a value instead of defining the quantity which will then be automatically calculated: value/marketprice."},"PostOlny":{"type":"boolean","description":"If the order is post only."}},"required":["InstrumentId","OMSId","AccountId","TimeInForce","Side","Quantity","OrderType","LimitPrice","StopPrice","TrailingAmount","LimitOffset"]},"title":"SendOrderListRequest"}}}}
```

## The SendOrderListResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"SendOrderListResponse":{"type":"object","properties":{"result":{"type":"boolean","description":"Specifically for this API method only, it returns false even if the request went through."},"errormsg":{"type":"string","description":"A successful request returns **Operation In Process**; the _errormsg_ parameter for an unsuccessful request returns one of the following messages: Not Authorized (errorcode 20), Invalid Request (errorcode 100), Operation Failed (errorcode 101), Server Error (errorcode 102), Resource Not Found (errorcode 104)."},"errorcode":{"type":"integer","description":"A successful request returns 107. An unsuccessful request returns one of the _errorcodes_ shown in the _errormsg_ list."},"detail":{"type":"string","description":"Message text that the system may send. Usually _null_."}},"required":["result","errormsg","errorcode","detail"],"title":"SendOrderListResponse"}}}}
```

## The SendCancelListRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"SendCancelListRequest":{"type":"array","items":{"type":"object","properties":{"OMSId":{"type":"integer","description":"The ID of the OMS on which the original order was placed."},"OrderId":{"type":"integer","description":"The ID of the order/s to be canceled. To get orderid/s of open orders, you can use the [**GetOpenOrders**](#operation/GetOpenOrders) API method."},"AccountId":{"type":"integer","description":"Account for which order/s will be canceled. If not specified, order/s will not be cancelled."}},"required":["OMSId","OrderId","AccountId"]},"title":"SendCancelListRequest"}}}}
```

## The SendCancelListResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"SendCancelListResponse":{"type":"object","properties":{"result":{"type":"boolean","description":"A successful request returns true; and unsuccessful request (an error condition) returns false."},"errormsg":{"type":"string","description":"A successful request returns null; the _errormsg_ parameter for an unsuccessful request returns one of the following messages: Not Authorized (errorcode 20), Invalid Request (errorcode 100), Operation Failed (errorcode 101), Server Error (errorcode 102), Resource Not Found (errorcode 104)."},"errorcode":{"type":"integer","description":"A successful request returns 0. An unsuccessful request returns one of the _errorcodes_ shown in the _errormsg_ list."},"detail":{"type":"string","description":"Message text that the system may send. Usually _null_."}},"required":["result","errormsg","errorcode","detail"],"title":"SendCancelListResponse"}}}}
```

## The SendCancelReplaceListRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"SendCancelReplaceListRequest":{"type":"array","items":{"type":"object","properties":{"OmsId":{"type":"integer","description":"The ID of the OMS on which the order is being canceled and replaced by another order."},"ReplaceOrderId":{"type":"integer","format":"int64","description":"The ID of the order to be replaced."},"ReplaceClientOrderId":{"type":"integer","format":"int64","description":"The ClientOrderId of the existing order to be replaced."},"ClientOrderId":{"type":"integer","format":"int64","default":0,"description":"A custom ID that can identify the replacement order later on. It is required for this field to be unique for every working order. Default is 0."},"OrderType":{"oneOf":[{"type":"integer"},{"type":"string"}],"enum":[0,1,2,3,4,5,6,7],"description":"The type of the replacement order. Either the integer or string value is accepted. One of: 0 Unknown, 1 Market, 2 Limit, 3 StopMarket, 4 StopLimit, 5 TrailingStopMarket, 6 TrailingStopLimit, 7 BlockTrade."},"Side":{"type":"integer","enum":[0,1],"description":"An integer representing the side of the replacement order. One of: 0 Buy, 1 Sell."},"AccountId":{"type":"integer","description":"The ID of the account who owns the order and is replacing the order, AccountId of the replacement order must match the AccountId of the existing order."},"InstrumentId":{"type":"integer","description":"The ID of the instrument being traded."},"UseDisplayQuantity":{"type":"boolean","description":"The display quantity is the quantity of a product shown to the market to buy or sell. A larger quantity may be wanted or available, but it may disadvantageous to display it when buying or selling. The display quantity is set when placing an order (using **SendOrder** or **CancelReplaceOrder** for instance). If you enter a Limit order with reserve, you must set _useDisplayQuantity_ to _true_."},"DisplayQuantity":{"type":"number","format":"decimal","default":0,"description":"The quantity of a product that is available to buy or sell that is publicly displayed to the market or simply in the orderbook. Will be used when **UseDisplayQuantity** is set to true, and in that case it needs to be defined else order will not appear in the order book as it defaults to 0."},"LimitPrice":{"type":"number","format":"decimal","description":"The price at which to execute the new order, if the new order is a limit order. If the replacement order is a market order, there is no need to define this field. Expressed in ticks for trailing stops."},"StopPrice":{"type":"number","format":"decimal","description":"The price at which to execute the new order if the replacement order is a stop order. If the replacement order is a not a stop order, there is no need to define this field. Expressed in ticks for trailing stops."},"ReferencePrice":{"type":"number","format":"decimal","description":"Used if the replacement order is trailing order. If the replacement order is not a trailing order, there is no need to define this field."},"PegPriceType":{"oneOf":[{"type":"integer"},{"type":"string"}],"enum":[0,1,2,3,4],"description":"The type of price you set in a stop/trailing order to \"peg the stop\". One of: 0 Unknown, 1 Last, 2 Bid, 3 Ask, 4 Midpoint. If the replacement order is not a trailing/stop order, there is no need to define this field."},"TimeInForce":{"oneOf":[{"type":"integer"},{"type":"string"}],"enum":[0,1,2,3,4,5,6],"description":"Represents the period during which the new order is executable. One of: 0 Unknown (an error condition), 1 GTC (good 'til canceled, the default), 2 OPG (execute as close to opening price as possible: not yet used, for future provision), 3 IOC (immediate or canceled), 4 FOK (fill or kill — fill the order immediately, or cancel it immediately), 5 GTX (good 'til executed: not yet used, for future provision), 6 GTD (good 'til date: not yet used, for future provision)."},"OrderIdOCO":{"type":"integer","description":"If the order being canceled in this call is order A, and the order replacing order A in this call is order B, then _OrderIdOCO_ refers to an order C that is currently open. If order C executes, then order B is canceled. You can also set up order C to watch order B in this way, but that will require an update to order C. Orderid to link this order to for OCO, negative values represent ordinal offset to current orderid, i.e., -1 = previous order."},"Quantity":{"type":"number","format":"decimal","description":"The quantity of the replacement order."}},"required":["OmsId","ReplaceOrderId","OrderType","Side","AccountId","InstrumentId","LimitPrice","StopPrice","ReferencePrice","PegPriceType","TimeInForce","Quantity"]},"title":"SendCancelReplaceListRequest"}}}}
```

## The SendCancelReplaceListResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"SendCancelReplaceListResponse":{"type":"object","properties":{"result":{"type":"boolean","description":"A successful request returns true; and unsuccessful request (an error condition) returns false."},"errormsg":{"type":"string","description":"A successful request returns null; the _errormsg_ parameter for an unsuccessful request returns one of the following messages: Not Authorized (errorcode 20), Invalid Request (errorcode 100), Operation Failed (errorcode 101), Server Error (errorcode 102), Resource Not Found (errorcode 104), Order Not Found (errorcode 104)."},"errorcode":{"type":"integer","description":"A successful request returns 0. An unsuccessful request returns one of the _errorcodes_ shown in the _errormsg_ list."},"detail":{"type":"string","description":"Message text that the system may send. Usually _null_."}},"required":["result","errormsg","errorcode","detail"],"title":"SendCancelReplaceListResponse"}}}}
```

## The ModifyOrderRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"ModifyOrderRequest":{"type":"object","properties":{"OMSId":{"type":"integer","description":"The ID of the OMS on which the original order was placed."},"OrderId":{"type":"integer","format":"int64","description":"The ID of the order to be modified. The ID was supplied by the server when the order was created."},"InstrumentId":{"type":"integer","description":"The ID of the instrument traded in the order."},"Quantity":{"type":"number","format":"decimal","description":"The new quantity of the order. This value can only be reduced from a previous quantity."},"AccountId":{"type":"integer","description":"Account for which order will be modified."}},"required":["OMSId","OrderId","InstrumentId","Quantity","AccountId"],"title":"ModifyOrderRequest"}}}}
```

## The ModifyOrderResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"ModifyOrderResponse":{"type":"object","properties":{"result":{"type":"boolean","description":"The successful receipt of a modify order request returns _true_; otherwise, returns _false_. This is the acknowledgment of receipt of the request to modify, not a confirmation that the modification has taken place."},"errormsg":{"type":"string","description":"A successful receipt of a modify request returns _null_; the _errormsg_ parameter for an unsuccessful request returns one of the following messages:. Not Authorized (errorcode 20). Invalid Request (errorcode 100). Invalid Quantity (errorcode 100). Operation Failed (errorcode 101). Server Error (errorcode 102). Resource Not Found (errorcode 104)."},"errorcode":{"type":"integer","description":"The receipt of a successful request to modify returns 0. An unsuccessful request returns one of the _errorcodes_ shown in the _errormsg_ list."},"detail":{"type":"string","description":"Message text that the system may send. Usually _null_."}},"required":["result","errormsg","errorcode","detail"],"title":"ModifyOrderResponse"}}}}
```

## The CancelAllOrdersRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"CancelAllOrdersRequest":{"type":"object","properties":{"OMSId":{"type":"integer","description":"The ID of the OMS on which the account operates."},"AccountId":{"type":"integer","description":"The account for which all orders are being canceled. If no AccountId is defined, orders for all accounts will be cancelled."},"IntrumentId":{"type":"integer","description":"The instrument for which all orders are being canceled. If there is no instrumentid defined, all orders for all instruments will be cancelled."}},"required":["OMSId"],"title":"CancelAllOrdersRequest"}}}}
```

## The CancelAllOrdersResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"CancelAllOrdersResponse":{"type":"object","properties":{"result":{"type":"boolean","description":"If the call has been successfully received by the OMS, _result_ is _true;_ otherwise it is _false._."},"errormsg":{"type":"string","description":"A successful receipt of the call returns _null._ The _errormsg_ key for an unsuccessful call returns one of the following messages:. Not Authorized (errorcode 20). Invalid Response (errorcode 100). Operation Failed (errorcode 101). Server Error (errorcode 102). Resource Not Found (errorcode 104). Operation Not Supported (errorcode 106)."},"errorcode":{"type":"integer","description":"A successful receipt of the call returns 0. An unsuccessful receipt of the call returns one of the _errorcodes_ shown in the _errormsg_ list."},"detail":{"type":"string","description":"Message text that the system may send."}},"required":["result","errormsg","errorcode","detail"],"title":"CancelAllOrdersResponse"}}}}
```

## The GetOrderStatusRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetOrderStatusRequest":{"type":"object","properties":{"OMSId":{"type":"integer","description":"The ID of the OMS on which the order was placed."},"AccountId":{"type":"integer","description":"The ID of the account under which the order was placed."},"OrderId":{"type":"integer","description":"The ID of the order whose status will be returned."}},"required":["AccountId","OrderId"],"title":"GetOrderStatusRequest"}}}}
```

## The GetOrderStatusResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetOrderStatusResponse":{"type":"object","properties":{"Side":{"type":"string","enum":["Buy","Sell"],"description":"The side of a trade. One of: **0** Buy, **1** Sell."},"OrderId":{"type":"integer","format":"int64","description":"The ID of the open order. The _OrderID_ is unique in each OMS."},"Price":{"type":"number","format":"decimal","description":"The price at which the buy or sell has been ordered."},"Quantity":{"type":"number","format":"decimal","description":"The quantity of the product to be bought or sold."},"DisplayQuantity":{"type":"number","format":"decimal","description":"The quantity available to buy or sell that is publicly displayed to the market. To display a _displayQuantity_ value, an order must be a Limit order with a reserve."},"Instrument":{"type":"integer","description":"The ID of the instrument being traded. The call [**GetInstruments**](#operation/GetInstruments) can supply the instrument IDs that are available."},"Account":{"type":"integer","description":"The ID of the of the account which submitted the order."},"AccountName":{"type":"string","description":"Name of the of the account which submitted the order."},"OrderType":{"type":"string","description":"Will always be **BlockTrade** as this GetOpenTradeReports API will only return open blocktrades."},"ClientOrderId":{"type":"integer","format":"int64","default":0,"description":"An ID supplied by the client to identify the order (like a purchase order number). Default is 0."},"OrderState":{"type":"string","enum":["Unknown","Working","Rejected","Canceled","Expired","FullyExecuted"],"description":"The state of the order. One of: 0 Unknown, 1 Working, 2 Rejected, 3 Canceled, 4 Expired, 5 FullyExecuted."},"ReceiveTime":{"type":"integer","format":"int64","description":"Time stamp of the order in POSIX format x 1000 (milliseconds since 1/1/1970 in UTC time zone)."},"ReceiveTimeTicks":{"type":"integer","format":"int64","description":"Time stamp of the order Microsoft Ticks format and UTC time zone. **Note:** Microsoft Ticks format is usually provided as a string. Here it is provided as a long integer."},"OrigQuantity":{"type":"number","format":"decimal","description":"If the open order has been changed or partially filled, this value shows the original quantity of the order."},"QuantityExecuted":{"type":"number","format":"decimal","description":"If the open order has been at least partially executed, this value shows the amount that has been executed."},"GrossValueExecuted":{"type":"number","format":"decimal","description":"If the open order has been at least partially executed, this value shows the gross amount that has been executed."},"AvgPrice":{"type":"number","format":"decimal","description":"The average executed price of the order."},"CounterPartyId":{"type":"integer","description":"The ID of the account who is the counterparty for the trade if order is already executed, either partial or fully executed."},"ChangeReason":{"type":"string","enum":["Unknown","NewInputAccepted","NewInputRejected","OtherRejected","Expired","Trade","SystemCanceled_NoMoreMarket","SystemCanceled_BelowMinimum","SystemCanceled_PriceCollar","SystemCanceled_MarginFailed","UserModified"],"description":"If the order has been changed, this string value holds the reason. One of: 0 Unknown, 1 NewInputAccepted, 2 NewInputRejected, 3 OtherRejected, 4 Expired, 5 Trade, 6 SystemCanceled_NoMoreMarket, 7 SystemCanceled_BelowMinimum, 8 SystemCanceled_PriceCollar, 9 SystemCanceled_MarginFailed, 100 UserModified. An order that is newly added to book will have **NewInputAccepted** value by default."},"OrigOrderId":{"type":"integer","description":"If the order is a replacement order, this is the ID of the original order."},"OrigClOrdId":{"type":"integer","description":"If the order is a replacement order, this is the client order ID or the original order."},"EnteredBy":{"type":"integer","description":"The ID of the user who submitted the order."},"Username":{"type":"string","description":"The username of the user who submitted the order. Usually returns as an empty string."},"IsQuote":{"type":"boolean","description":"If this order is a quote, the value for _IsQuote_ is _true_, otherwise it is _false._."},"InsideAsk":{"type":"number","format":"decimal","description":"If this order is a quote, this value is the Inside Ask price."},"InsideAskSize":{"type":"number","format":"decimal","description":"If this order is a quote, this value is the quantity of the Inside Ask quote."},"InsideBid":{"type":"number","format":"decimal","description":"If this order is a quote, this value is the Inside Bid price."},"InsideBidSize":{"type":"number","format":"decimal","description":"If this order is a quote, this value is the quantity of the Inside Bid quote."},"LastTradePrice":{"type":"number","format":"decimal","description":"The last price that this instrument traded at."},"RejectReason":{"type":"string","description":"If this open order has been rejected, this string holds the reason for the rejection."},"IsLockedIn":{"type":"boolean","description":"For a block trade, if both parties to the block trade agree that one of the parties will report the trade for both sides, this value is _true._ Othersise, _false._."},"CancelReason":{"type":"string","description":"If this order has been canceled, this string holds the cancellation reason."},"OrderFlag":{"type":"string","description":"One or more of: **NoAccountRiskCheck**, **AddedToBook**, **RemovedFromBook**, **PostOnly**, **Liquidation**, **ReverseMarginPosition**, **Synthetic**."},"UseMargin":{"type":"boolean","default":false,"description":"Margin is not yet supported so this always defaults to false."},"StopPrice":{"type":"number","format":"decimal","description":"The price at which the order executes, if the order is a stop order. Defaults to 0 if order is another type."},"PegPriceType":{"type":"string","description":"The type of price to peg the Stop to for Stop/Trailing orders."},"PegOffset":{"type":"number","format":"decimal","description":"Only applicable to trailing/stop orders. Defaults to 0 if order is another type."},"PegLimitOffset":{"type":"number","format":"decimal","description":"Only applicable to trailing/stop orders. Defaults to 0 if order is another type."},"IpAddress":{"type":"string","description":"The IP address from where the order was submitted."},"OMSId":{"type":"integer","description":"The ID of the OMS."}},"required":["Side","OrderId","Price","Quantity","DisplayQuantity","Instrument","Account","AccountName","OrderType","ClientOrderId","OrderState","ReceiveTime","ReceiveTimeTicks","OrigQuantity","QuantityExecuted","GrossValueExecuted","AvgPrice","CounterPartyId","ChangeReason","OrigOrderId","OrigClOrdId","EnteredBy","Username","IsQuote","InsideAsk","InsideAskSize","InsideBid","InsideBidSize","LastTradePrice","RejectReason","IsLockedIn","CancelReason","OrderFlag","UseMargin","StopPrice","PegPriceType","PegOffset","PegLimitOffset","IpAddress","OMSId"],"title":"GetOrderStatusResponse"}}}}
```

## The GetOrdersHistoryRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetOrdersHistoryRequest":{"type":"object","properties":{"OMSId":{"type":"integer","description":"The ID of the OMS on which the orders took place."},"AccountId":{"type":"integer","description":"The account ID that made the trades. A user with NotbankTrading permission must be associated with this account, although other users also can be associated with the account. Not explicitly required if the authenticated user has elevated permission/s."},"OrderState":{"type":"string","enum":["Unknown","Working","Rejected","Canceled","Expired","FullyExecuted"],"description":"The current state of the order. Can be used to filter results. If not specified all orders regardless of the order state will be returned. One of: 0 Unknown, 1 Working, 2 Rejected, 3 Canceled, 4 Expired, 5 FullyExecuted."},"OrderId":{"type":"integer","format":"int64","description":"The ID of the order. Can be used to filter results. Can be used to filter for a specific orderid. There is a specific API call **GetOrderHistoryByOrderId** for filtering orders by **OrderId**."},"ClientOrderId":{"type":"integer","format":"int64","default":0,"description":"A user-assigned ID for the order (like a purchase-order number assigned by a company). Can be used to filter results. Default is 0."},"OriginalOrderId":{"type":"integer","format":"int64","description":"The original ID of the order. If specified, the call returns changed orders associated with this order ID. Can be used to filter results."},"OriginalClientOrderId":{"type":"integer","format":"int64","description":"If the order has been changed, shows the original client order ID, a value that the client can create (much like a purchase order). Can be used to filter results."},"UserId":{"type":"integer","description":"The ID of the user whose account orders will be returned. If not specified, the call returns the orders of the logged-in user. Can be used to filter results."},"InstrumentId":{"type":"integer","format":"int64","description":"The ID of the instrument named in the order. If not specified, the call returns orders for all instruments traded by this account. Can be used to filter results."},"StartTimestamp":{"type":"integer","format":"int64","description":"Date and time at which to begin the orders history, in POSIX format. Can be used to filter results."},"EndTimestamp":{"type":"integer","format":"int64","description":"Date and time at which to end the orders report, in POSIX format. Can be used to filter results."},"Depth":{"type":"integer","description":"In this case, the maximum number/count of unique orders to return, counting from the _StartIndex_ if it is also specified. If not specified, returns the 100 most recent to orders; results can vary depending if other optional fields are defined such as _StartIndex_, _StartTimestamp_, and _EndTimestamp_. Can be used to filter results and for pagination."},"Limit":{"type":"integer","description":"Functions exactly the same as the **Depth** field."},"StartIndex":{"type":"integer","default":0,"description":"A value of 0 means the first object in the result will be the the most recent order, a value of 2 means that the first object in the result set will be the third most recent order. Can be used to filter results or for pagination. Default is 0."}},"required":["OMSId","AccountId"],"title":"GetOrdersHistoryRequest"}}}}
```

## The GetOrdersHistoryResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetOrdersHistoryResponse":{"type":"array","items":{"type":"object","properties":{"Side":{"type":"string","enum":["Buy","Sell"],"description":"The side of a trade. One of: **0** Buy, **1** Sell."},"OrderId":{"type":"integer","format":"int64","description":"The ID of the open order. The _OrderID_ is unique in each OMS."},"Price":{"type":"number","format":"decimal","description":"The price at which the buy or sell has been ordered."},"Quantity":{"type":"number","format":"decimal","description":"The quantity of the product to be bought or sold."},"DisplayQuantity":{"type":"number","format":"decimal","description":"The quantity available to buy or sell that is publicly displayed to the market. To display a _displayQuantity_ value, an order must be a Limit order with a reserve."},"Instrument":{"type":"integer","description":"The ID of the instrument being traded. The API method [**GetInstruments**](#operation/GetInstruments) can supply the instrument IDs that are available."},"Account":{"type":"integer","description":"The ID of the of the account which the order belongs to."},"AccountName":{"type":"string","description":"Name of the of the account which which the order belongs to."},"OrderType":{"type":"string","enum":["Unknown an error condition","Market order","Limit","StopMarket","StopLimit","TrailingStopMarket","TrailingStopLimit","BlockTrade"],"description":"Describes the type of order this is. One of: 0 Unknown (an error condition), 1 Market order, 2 Limit, 3 StopMarket, 4 StopLimit, 5 TrailingStopMarket, 6 TrailingStopLimit, 7 BlockTrade."},"ClientOrderId":{"type":"integer","format":"int64","default":0,"description":"An ID supplied by the client to identify the order (like a purchase order number). Default is 0."},"OrderState":{"type":"string","enum":["Unknown","Working","Rejected","Canceled","Expired","Fully Executed"],"description":"The current or the latest state of the order. One of: 0 Unknown, 1 Working, 2 Rejected, 3 Canceled, 4 Expired, 5 Fully Executed."},"ReceiveTime":{"type":"integer","format":"int64","description":"Time stamp of the order in POSIX format x 1000 (milliseconds since 1/1/1970 in UTC time zone)."},"ReceiveTimeTicks":{"type":"integer","format":"int64","description":"Time stamp of the order Microsoft Ticks format and UTC time zone. **Note:** Microsoft Ticks format is usually provided as a string. Here it is provided as a long integer."},"LastUpdatedTime":{"type":"integer","format":"int64","description":"Time stamp when the order was last updated, in POSIX format x 1000 (milliseconds since 1/1/1970 in UTC time zone)."},"LastUpdatedTimeTicks":{"type":"integer","format":"int64","description":"Time stamp when the order was last updated, in Microsoft Ticks format and UTC time zone. **Note:** Microsoft Ticks format is usually provided as a string. Here it is provided as a long integer."},"OrigQuantity":{"type":"number","format":"decimal","description":"If the open order has been changed or partially filled, this value shows the original quantity of the order."},"QuantityExecuted":{"type":"number","format":"decimal","description":"If the open order has been at least partially executed, this value shows the amount that has been executed."},"GrossValueExecuted":{"type":"number","format":"decimal","description":"If the open order has been at least partially executed, this value shows the gross amount that has been executed."},"ExecutableValue":{"type":"number","format":"decimal","description":"Defaults to 0. For future provision."},"AvgPrice":{"type":"number","format":"decimal","description":"The average executed price of the order."},"CounterPartyId":{"type":"integer","description":"The ID of the account who is the counterparty for the trade if order is already executed, either partial or fully executed."},"ChangeReason":{"type":"string","enum":["Unknown","NewInputAccepted","NewInputRejected","OtherRejected","Expired","Trade","SystemCanceled_NoMoreMarket","SystemCanceled_BelowMinimum","SystemCanceled_PriceCollar","SystemCanceled_MarginFailed","UserModified"],"description":"If the order has been changed, this string value holds the reason. One of: 0 Unknown, 1 NewInputAccepted, 2 NewInputRejected, 3 OtherRejected, 4 Expired, 5 Trade, 6 SystemCanceled_NoMoreMarket, 7 SystemCanceled_BelowMinimum, 8 SystemCanceled_PriceCollar, 9 SystemCanceled_MarginFailed, 100 UserModified. An order that is newly added to book will have **NewInputAccepted** value by default."},"OrigOrderId":{"type":"integer","format":"int64","description":"If the order is a replacement order, this is the ID of the original order."},"OrigClOrdId":{"type":"integer","format":"int64","description":"If the order is a replacement order, this is the client order ID or the original order."},"EnteredBy":{"type":"integer","description":"The ID of the user who submitted the order."},"Username":{"type":"string","description":"The username of the user who submitted the order."},"IsQuote":{"type":"boolean","description":"If this order is a quote, the value for _IsQuote_ is _true_, otherwise it is _false._."},"InsideAsk":{"type":"number","format":"decimal","description":"If this order is a quote, this value is the Inside Ask price."},"InsideAskSize":{"type":"number","format":"decimal","description":"If this order is a quote, this value is the quantity of the Inside Ask quote."},"InsideBid":{"type":"number","format":"decimal","description":"If this order is a quote, this value is the Inside Bid price."},"InsideBidSize":{"type":"number","format":"decimal","description":"If this order is a quote, this value is the quantity of the Inside Bid quote."},"LastTradePrice":{"type":"number","format":"decimal","description":"The last price that this instrument traded at."},"RejectReason":{"type":"string","description":"If this open order has been rejected, this string holds the reason for the rejection."},"IsLockedIn":{"type":"boolean","description":"For a block trade, if both parties to the block trade agree that one of the parties will report the trade for both sides, this value is _true._ Othersise, _false._."},"CancelReason":{"type":"string","description":"If this order has been canceled, this string holds the cancellation reason."},"OrderFlag":{"oneOf":[{"type":"integer"},{"type":"string"}],"description":"One or more of:. 1 NoAccountRiskCheck. 2 AddedToBook. 4 RemovedFromBook. 8 PostOnly. 16 Liquidation. 32 ReverseMarginPosition."},"UseMargin":{"type":"boolean","default":false,"description":"Margin is not yet supported so this always defaults to false."},"StopPrice":{"type":"number","format":"decimal","description":"The price at which the order executes, if the order is a stop order. Defaults to 0 if order is another type."},"PegPriceType":{"type":"string","description":"The type of price to peg the Stop to for Stop/Trailing orders."},"PegOffset":{"type":"number","format":"decimal","description":"Only applicable to trailing/stop orders. Defaults to 0 if order is another type."},"PegLimitOffset":{"type":"number","format":"decimal","description":"Only applicable to trailing/stop orders. Defaults to 0 if order is another type."},"IpAddress":{"type":"string","description":"The IP address from where the order was submitted."},"IPv6a":{"type":"string","description":"**UInt64**. The IPv6 where the order was submitted from. Currently not being used, for future provision. Defaults to 0."},"OMSId":{"type":"integer","description":"The ID of the OMS."}},"required":["Side","OrderId","Price","Quantity","DisplayQuantity","Instrument","Account","AccountName","OrderType","ClientOrderId","OrderState","ReceiveTime","ReceiveTimeTicks","LastUpdatedTime","LastUpdatedTimeTicks","OrigQuantity","QuantityExecuted","GrossValueExecuted","ExecutableValue","AvgPrice","CounterPartyId","ChangeReason","OrigOrderId","OrigClOrdId","EnteredBy","Username","IsQuote","InsideAsk","InsideAskSize","InsideBid","InsideBidSize","LastTradePrice","RejectReason","IsLockedIn","CancelReason","OrderFlag","UseMargin","StopPrice","PegPriceType","PegOffset","PegLimitOffset","IpAddress","IPv6a","IPv6a","OMSId"]},"title":"GetOrdersHistoryResponse"}}}}
```

## The GetTradesHistoryRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetTradesHistoryRequest":{"type":"object","properties":{"OMSId":{"type":"integer","description":"The ID of the OMS on which the trades took place."},"AccountId":{"type":"integer","description":"The account ID that made the trades. If no account ID is supplied, the system assumes the default account for the logged-in user making the call."},"InstrumentId":{"type":"integer","default":0,"description":"The ID of the instrument whose trade history is reported. If not specified, defaults to 0 which means results won't be filtered according to it."},"TradeId":{"type":"integer","format":"int64","description":"The ID of a specific trade."},"OrderId":{"type":"integer","format":"int64","default":0,"description":"The ID of the order resulting in the trade. If specified, the call returns all trades associated with the order. If not specified, defaults to 0 which means results won't be filtered according to it."},"UserId":{"type":"integer","description":"If not specified, the call returns trades associated with the users belonging to the default account for the logged-in user."},"StartTimeStamp":{"type":"integer","format":"int64","default":0,"description":"The historical date and time at which to begin the trade report, in POSIX format. If not specified, defaults to 0 which means results won't be filtered according to it. Value must be in **milliseconds** if to be used."},"EndTimeStamp":{"type":"integer","format":"int64","default":0,"description":"Date and time at which to end the trade report, in POSIX format. If not specified, defaults to 0 which means results won't be filtered according to it. Value must be in **milliseconds** if to be used."},"Depth":{"type":"integer","description":"In this case, the count of trades to return, counting from the _StartIndex_. If _Depth_ is not specified, returns all trades between _BeginTimeStamp_ and _EndTimeStamp_, beginning at _StartIndex_. If no other filter parameter is defined, the maximum will result set will be according to the **MaxApiResponseResultSet** Gateway config value."},"StartIndex":{"type":"integer","default":0,"description":"The starting index into the history of trades, from 0 (the most recent trade) and moving backwards in time. If not specified, defaults to 0 which means results won't be filtered according to it."},"ExecutionId":{"type":"integer","default":0,"description":"The ID of the individual buy or sell execution. If not specified, defaults to 0 which means results won't be filtered according to it."}},"required":["OMSId"],"title":"GetTradesHistoryRequest"}}}}
```

## The GetTradesHistoryResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetTradesHistoryResponse":{"type":"array","items":{"type":"object","properties":{"OMSId":{"type":"integer","description":"The ID of the OMS on which the account resides."},"ExecutionId":{"type":"integer","description":"The ID of this account's side of the trade. Every trade has two sides."},"TradeId":{"type":"integer","format":"int64","description":"The ID of the overall trade."},"OrderId":{"type":"integer","format":"int64","description":"The ID of the order causing the trade (buy or sell)."},"AccountId":{"type":"integer","description":"The ID of the account that made the trade (buy or sell)."},"AccountName":{"type":"string","description":"The Name of the account that made the trade (buy or sell)."},"SubAccountId":{"type":"integer","description":"Not currently used; reserved for future use. Defaults to 0."},"ClientOrderId":{"type":"integer","format":"int64","default":0,"description":"An ID supplied by the client to identify the order (like a purchase order number). Default is 0."},"InstrumentId":{"type":"integer","description":"The ID of the instrument being traded. An instrument comprises two products, for example Dollars and Bitcoin."},"Side":{"type":"string","enum":["Buy","Sell"],"description":"One of: **0** Buy, **1** Sell."},"OrderType":{"type":"string","enum":["Market","Limit","BlockTrade","StopMarket","StopLimit","TrailingStopLimit","StopMarket","TrailingStopMarket"],"description":"One of: Market, Limit, BlockTrade, StopMarket, StopLimit, TrailingStopLimit, StopMarket, TrailingStopMarket."},"Quantity":{"type":"number","format":"decimal","description":"The unit quantity of this side of the trade."},"RemainingQuantity":{"type":"number","format":"decimal","description":"The number of units remaining to be traded by the order after this execution. This number is not revealed to the other party in the trade. This value is also known as \"leave size\" or \"leave quantity.\"."},"Price":{"type":"number","format":"decimal","description":"The unit price at which the instrument traded."},"Value":{"type":"number","format":"decimal","description":"The total value of the deal. The system calculates this as:. unit price X quantity executed."},"CounterParty":{"type":"string","description":"The ID of the other party in a block trade. Usually, IDs are stated as integers; this value is an integer written as a string."},"OrderTradeRevision":{"type":"integer","description":"The revision number of this trade; usually 1."},"Direction":{"type":"integer","enum":[0,1,2],"description":"The effect of the trade on the instrument's market price. One of: **0** No change, **1** Uptick, **2** DownTick."},"IsBlockTrade":{"type":"boolean","description":"A value of _true_ means that this trade was a block trade; a value of _false_ that it was not a block trade."},"Fee":{"type":"number","format":"decimal","description":"Any fee levied against the trade by the Exchange."},"FeeProductId":{"type":"integer","description":"The ID of the product in which the fee was levied."},"OrderOriginator":{"type":"integer","description":"The ID of the user who initiated the trade."},"UserName":{"type":"string","description":"The UserName of the user who initiated the trade."},"TradeTimeMS":{"type":"integer","format":"int64","description":"The date and time that the trade took place, in milliseconds and POSIX format. All dates and times are UTC."},"MakerTaker":{"type":"string","enum":["Maker","Taker"],"description":"One of: Maker, Taker."},"AdapterTradeId":{"type":"integer","description":"The ID of the adapter of the overall trade."},"InsideBid":{"type":"number","format":"decimal","description":"The best (highest) price level of the buy side of the book at the time of the trade."},"InsideBidSize":{"type":"number","format":"decimal","description":"The quantity of the best (highest) price level of the buy side of the book at the time of the trade."},"InsideAsk":{"type":"number","format":"decimal","description":"The best (lowest) price level of the sell side of the book at the time of the trade."},"InsideAskSize":{"type":"number","format":"decimal","description":"The quantity of the best (lowest) price level of the sell side of the book at the time of the trade."},"CounterPartyClientUserId":{"type":"integer","description":"Indicates counterparty source of trade (OMS, Remarketer, FIX)."},"NotionalProductId":{"type":"integer","description":"The id of the notional product the notional value was captured in."},"NotionalRate":{"type":"number","format":"decimal","description":"Notional rate from base currency at time of trade."},"NotionalValue":{"type":"number","format":"decimal","description":"Notional value in base currency of venue at time of trade."},"TradeTime":{"type":"integer","format":"int64","description":"The date and time that the trade took place, in C# Ticks. All dates and times are UTC."}},"required":["OMSId","ExecutionId","TradeId","OrderId","AccountId","AccountName","SubAccountId","ClientOrderId","InstrumentId","Side","OrderType","Quantity","RemainingQuantity","Price","Value","CounterParty","OrderTradeRevision","Direction","IsBlockTrade","Fee","FeeProductId","OrderOriginator","UserName","TradeTimeMS","MakerTaker","AdapterTradeId","InsideBid","InsideBidSize","InsideAsk","InsideAskSize","CounterPartyClientUserId","NotionalProductId","NotionalRate","NotionalValue","TradeTime"]},"title":"GetTradesHistoryResponse"}}}}
```

## The GetOrderHistoryByOrderIdRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetOrderHistoryByOrderIdRequest":{"type":"object","properties":{"OMSId":{"type":"integer","description":"The ID of the OMS."},"OrderId":{"type":"integer","format":"int64","description":"The ID of the of the order which you want to get details and history of."}},"required":["OMSId","OrderId"],"title":"GetOrderHistoryByOrderIdRequest"}}}}
```

## The GetOrderHistoryByOrderIdResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetOrderHistoryByOrderIdResponse":{"type":"array","items":{"type":"object","properties":{"Side":{"type":"string","enum":["Buy","Sell"],"description":"The side of a trade. One of: **0** Buy, **1** Sell."},"OrderId":{"type":"integer","format":"int64","description":"The ID of the open order. The _OrderID_ is unique in each OMS."},"Price":{"type":"number","format":"decimal","description":"The price at which the buy or sell has been ordered."},"Quantity":{"type":"number","format":"decimal","description":"The quantity of the product to be bought or sold."},"DisplayQuantity":{"type":"number","format":"decimal","description":"The quantity available to buy or sell that is publicly displayed to the market. To display a _displayQuantity_ value, an order must be a Limit order with a reserve."},"Instrument":{"type":"integer","description":"The ID of the instrument being traded. The call **GetInstruments** can supply the instrument IDs that are available."},"Account":{"type":"integer","description":"The ID of the of the account which the order belongs to."},"AccountName":{"type":"string","description":"Name of the of the account which which the order belongs to."},"OrderType":{"type":"string","enum":["Unknown an error condition","Market order","Limit","StopMarket","StopLimit","TrailingStopMarket","TrailingStopLimit","BlockTrade"],"description":"Describes the type of order this is. One of: 0 Unknown (an error condition), 1 Market order, 2 Limit, 3 StopMarket, 4 StopLimit, 5 TrailingStopMarket, 6 TrailingStopLimit, 7 BlockTrade."},"ClientOrderId":{"type":"integer","format":"int64","default":0,"description":"An ID supplied by the client to identify the order (like a purchase order number). Default is 0."},"OrderState":{"type":"string","enum":["Unknown","Working","Rejected","Canceled","Expired","Fully Executed"],"description":"The current or the latest state of the order. One of: 0 Unknown, 1 Working, 2 Rejected, 3 Canceled, 4 Expired, 5 Fully Executed."},"ReceiveTime":{"type":"integer","format":"int64","description":"Time stamp of the order in POSIX format x 1000 (milliseconds since 1/1/1970 in UTC time zone)."},"ReceiveTimeTicks":{"type":"integer","format":"int64","description":"Time stamp of the order Microsoft Ticks format and UTC time zone. **Note:** Microsoft Ticks format is usually provided as a string. Here it is provided as a long integer."},"LastUpdatedTime":{"type":"integer","format":"int64","description":"Time stamp when the order was last updated, UNIX timestamp format x 1000 (milliseconds since 1/1/1970 in UTC time zone)."},"LastUpdatedTimeTicks":{"type":"integer","format":"int64","description":"Time stamp when the order was last updated, in Microsoft Ticks format and UTC time zone. **Note:** Microsoft Ticks format is usually provided as a string. Here it is provided as a long integer."},"OrigQuantity":{"type":"number","format":"decimal","description":"If the open order has been changed or partially filled, this value shows the original quantity of the order."},"QuantityExecuted":{"type":"number","format":"decimal","description":"If the open order has been at least partially executed, this value shows the amount that has been executed."},"GrossValueExecuted":{"type":"number","format":"decimal","description":"If the open order has been at least partially executed, this value shows the gross amount that has been executed."},"ExecutableValue":{"type":"number","format":"decimal","description":"Defaults to 0. For future provision."},"AvgPrice":{"type":"number","format":"decimal","description":"The average executed price of the order."},"CounterPartyId":{"type":"integer","description":"The ID of the account who is the counterparty for the trade if order is already executed, either partial or fully executed."},"ChangeReason":{"type":"string","enum":["Unknown","NewInputAccepted","NewInputRejected","OtherRejected","Expired","Trade","SystemCanceled_NoMoreMarket","SystemCanceled_BelowMinimum","SystemCanceled_PriceCollar","SystemCanceled_MarginFailed","UserModified"],"description":"If the order has been changed, this string value holds the reason. One of: 0 Unknown, 1 NewInputAccepted, 2 NewInputRejected, 3 OtherRejected, 4 Expired, 5 Trade, 6 SystemCanceled_NoMoreMarket, 7 SystemCanceled_BelowMinimum, 8 SystemCanceled_PriceCollar, 9 SystemCanceled_MarginFailed, 100 UserModified. An order that is newly added to book will have **NewInputAccepted** value by default."},"OrigOrderId":{"type":"integer","format":"int64","description":"If the order is a replacement order, this is the ID of the original order."},"OrigClOrdId":{"type":"integer","format":"int64","description":"If the order is a replacement order, this is the client order ID or the original order."},"EnteredBy":{"type":"integer","description":"The ID of the user who submitted the order."},"Username":{"type":"string","description":"The username of the user who submitted the order."},"IsQuote":{"type":"boolean","description":"If this order is a quote, the value for _IsQuote_ is _true_, otherwise it is _false._."},"InsideAsk":{"type":"number","format":"decimal","description":"If this order is a quote, this value is the Inside Ask price."},"InsideAskSize":{"type":"number","format":"decimal","description":"If this order is a quote, this value is the quantity of the Inside Ask quote."},"InsideBid":{"type":"number","format":"decimal","description":"If this order is a quote, this value is the Inside Bid price."},"InsideBidSize":{"type":"number","format":"decimal","description":"If this order is a quote, this value is the quantity of the Inside Bid quote."},"LastTradePrice":{"type":"number","format":"decimal","description":"The last price that this instrument traded at."},"RejectReason":{"type":"string","description":"If this open order has been rejected, this string holds the reason for the rejection."},"IsLockedIn":{"type":"boolean","description":"For a block trade, if both parties to the block trade agree that one of the parties will report the trade for both sides, this value is _true._ Othersise, _false._."},"CancelReason":{"type":"string","description":"If this order has been canceled, this string holds the cancellation reason."},"OrderFlag":{"oneOf":[{"type":"integer"},{"type":"string"}],"description":"One or more of:. 1 NoAccountRiskCheck. 2 AddedToBook. 4 RemovedFromBook. 8 PostOnly. 16 Liquidation. 32 ReverseMarginPosition."},"UseMargin":{"type":"boolean","default":false,"description":"Margin is not yet supported so this always defaults to false."},"StopPrice":{"type":"number","format":"decimal","description":"The price at which the order executes, if the order is a stop order. Defaults to 0 if order is another type."},"PegPriceType":{"type":"string","description":"The type of price to peg the Stop to for Stop/Trailing orders."},"PegOffset":{"type":"number","format":"decimal","description":"Only applicable to trailing/stop orders. Defaults to 0 if order is another type."},"PegLimitOffset":{"type":"number","format":"decimal","description":"Only applicable to trailing/stop orders. Defaults to 0 if order is another type."},"IpAddress":{"type":"string","description":"The IP address from where the order was submitted."},"IPv6a":{"type":"string","description":"**UInt64**. The IPv6 where the order was submitted from. Currently not being used, for future provision. Defaults to 0."},"OMSId":{"type":"integer","description":"The ID of the OMS."}},"required":["Side","OrderId","Price","Quantity","DisplayQuantity","Instrument","Account","AccountName","OrderType","ClientOrderId","OrderState","ReceiveTime","ReceiveTimeTicks","LastUpdatedTime","LastUpdatedTimeTicks","OrigQuantity","QuantityExecuted","GrossValueExecuted","ExecutableValue","AvgPrice","CounterPartyId","ChangeReason","OrigOrderId","OrigClOrdId","EnteredBy","Username","IsQuote","InsideAsk","InsideAskSize","InsideBid","InsideBidSize","LastTradePrice","RejectReason","IsLockedIn","CancelReason","OrderFlag","UseMargin","StopPrice","PegPriceType","PegOffset","PegLimitOffset","IpAddress","IPv6a","IPv6a","OMSId"]},"title":"GetOrderHistoryByOrderIdResponse"}}}}
```

## The GetTickerHistoryRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetTickerHistoryRequest":{"type":"object","properties":{"OMSId":{"type":"integer","description":"The ID of the OMS."},"InstrumentId":{"type":"integer","description":"The ID of a specific instrument."},"Interval":{"type":"integer","description":"The time between ticks, in seconds. For example, a value of 60 returns ticker array elements between _FromDate_ to _ToDate_ in 60-second increments."},"FromDate":{"type":"string","default":"00:00:00","description":"Oldest date from which the ticker history will start; in DateTime format (hour:minutes:seconds). Default is 00:00:00."},"ToDate":{"type":"string","default":"00:00:00","description":"Most recent date, at which the ticker history will end; in DateTime format (hour:minutes:seconds). Default is 00:00:00."}},"required":["OMSId","InstrumentId","Interval","FromDate","ToDate"],"title":"GetTickerHistoryRequest"}}}}
```

## The GetTickerHistoryResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetTickerHistoryResponse":{"type":"array","items":{"type":"array","prefixItems":[{"type":"integer","format":"int64","description":"EndDateTime. The end/closing date and time of the ticker, in UTC and POSIX format."},{"type":"number","format":"decimal","description":"High. The Highest Trade Price for the Time-Period ( 0 if no trades )."},{"type":"number","format":"decimal","description":"Low. The Lowest Trade Price for the Time-Period ( 0 if no trades )."},{"type":"number","format":"decimal","description":"Open. The Opening Trade Price for the Time-Period ( 0 if no trades )."},{"type":"number","format":"decimal","description":"Close. The Last Trade Price for the Time-Period ( 0 if no trades )."},{"type":"number","format":"decimal","description":"Volume. The Total Trade Volume since the last Tick."},{"type":"number","format":"decimal","description":"Bid. The best bid price at the time of the Tick."},{"type":"number","format":"decimal","description":"Ask. The best ask price at the time of the Tick."},{"type":"integer","description":"InstrumentId. The ID of the instrument."},{"type":"integer","format":"int64","description":"BeginDateTime. The start/opening date and time of the ticker, in UTC and POSIX format."}]},"title":"GetTickerHistoryResponse"}}}}
```

## The GetLastTradesRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetLastTradesRequest":{"type":"object","properties":{"OMSId":{"type":"string","description":"The ID of the OMS on which the instrument is being traded."},"InstrumentId":{"type":"string","description":"The ID of the instrument."},"Count":{"type":"string","default":100,"description":"Value represents the number of trades you want to get, value of 10 will return 10 most recent trades. Default is 100."}},"required":["OMSId","InstrumentId"],"title":"GetLastTradesRequest"}}}}
```

## The GetLastTradesResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetLastTradesResponse":{"type":"array","items":{"type":"array","items":false,"prefixItems":[{"type":"integer","description":"TradeId. The ID of this trade."},{"type":"integer","description":"InstrumentId. The ID of the instrument."},{"type":"number","format":"decimal","description":"Quantity. The quantity of the instrument traded."},{"type":"number","format":"decimal","description":"Price.The price at which the instrument was traded."},{"type":"integer","description":"Order1. The ID of the first order that resulted in the trade, either Buy or Sell."},{"type":"integer","description":"Order2. The ID of the second order that resulted in the trade, either Buy or Sell."},{"type":"integer","format":"int64","description":"Tradetime. UTC trade time in Total Milliseconds. POSIX format."},{"type":"integer","enum":[0,1,2],"description":"Direction. Effect of the trade on the instrument’s market price. One of: 0 NoChange, 1 UpTick, 2 DownTick."},{"type":"integer","enum":[0,1],"description":"TakerSide. Which side of the trade took liquidity? One of: 0 Buy, 1 Sell. The maker side of the trade provides liquidity by placing the order on the book (this can be a buy or a sell order). The other, taker, side takes the liquidity. It, too, can be buy-side or sell-side."},{"type":"boolean","default":false,"description":"BlockTrade. True if it was a privately negotiated trade. Private trade returns 1 (_true_); otherwise 0 (_false_). Default is _false_."},{"type":"integer","description":"order1ClientId or order2ClientId. The client-supplied order ID for the trade. Internal logic determines whether the program reports the _order1ClientId_ or the _order2ClientId_."}]},"title":"GetLastTradesResponse"}}}}
```

## The GetLevel1SummaryRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetLevel1SummaryRequest":{"type":"object","properties":{"OMSId":{"type":"integer","description":"The ID of the OMS."}},"required":["OMSId"],"title":"GetLevel1SummaryRequest"}}}}
```

## The GetLevel1SummaryResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetLevel1SummaryResponse":{"type":"array","items":{"type":"string","description":"Level1 summary information in JSON format. The format is as follows { \"TickerUpdate\": { \"type\": \"object\", \"description\": \"Standard market data update containing quote and session statistics.\", \"properties\": { \"OMSId\": { \"type\": \"integer\", \"description\": \"The ID of the OMS.\" }, \"InstrumentId\": { \"type\": \"integer\", \"description\": \"The ID of the instrument.\" }, \"BestBid\": { \"type\": \"number\", \"format\": \"decimal\", \"description\": \"Current best bid price.\" }, \"BestOffer\": { \"type\": \"number\", \"format\": \"decimal\", \"description\": \"Current best offer price.\" }, \"LastTradedPx\": { \"type\": \"number\", \"format\": \"decimal\", \"description\": \"Last-traded price.\" }, \"LastTradedQty\": { \"type\": \"number\", \"format\": \"decimal\", \"description\": \"Last-traded quantity.\" }, \"LastTradeTime\": { \"type\": \"integer\", \"format\": \"int64\", \"description\": \"Time of last trade (POSIX).\" }, \"SessionOpen\": { \"type\": \"number\", \"format\": \"decimal\", \"description\": \"Opening price. In markets with openings and closings, this is the opening price for the current session; in 24-hour markets, it is the price as of UTC Midnight.\" }, \"SessionHigh\": { \"type\": \"number\", \"format\": \"decimal\", \"description\": \"Highest price during the trading day, either during a session with opening and closing prices or UTC midnight to UTC midnight.\" }, \"SessionLow\": { \"type\": \"number\", \"format\": \"decimal\", \"description\": \"Lowest price during the trading day, either during a session with opening and closing prices or UTC midnight to UTC midnight.\" }, \"SessionClose\": { \"type\": \"number\", \"format\": \"decimal\", \"description\": \"The closing price. In markets with openings and closings, this is the closing price for the current session; in 24-hour markets, it is the price as of UTC Midnight.\" }, \"Volume\": { \"type\": \"number\", \"format\": \"decimal\", \"description\": \"The last-traded quantity for the instrument, same value as LastTradedQty.\" }, \"CurrentDayVolume\": { \"type\": \"number\", \"format\": \"decimal\", \"description\": \"The unit volume of the instrument traded either during a session with openings and closings or in 24-hour markets, the period from UTC Midnight to UTC Midnight.\" }, \"CurrentDayNumTrades\": { \"type\": \"integer\", \"description\": \"The number of trades during the current day, either during a session with openings and closings or in 24-hour markets, the period from UTC Midnight to UTC Midnight.\" }, \"CurrentDayPxChange\": { \"type\": \"number\", \"format\": \"decimal\", \"description\": \"Current day price change, either during a trading session or UTC Midnight to UTC midnight.\" }, \"CurrentNotional\": { \"type\": \"number\", \"format\": \"decimal\", \"description\": \"Current day quote volume (resets at UTC Midnight).\" }, \"Rolling24HrNotional\": { \"type\": \"number\", \"format\": \"decimal\", \"description\": \"Rolling 24 hours quote volume.\" }, \"Rolling24HrVolume\": { \"type\": \"number\", \"format\": \"decimal\", \"description\": \"Unit volume (quantity traded, in the product 1 or in the base currency denomination) of the instrument during the past 24 hours, regardless of time zone. Recalculates continuously.\" }, \"Rolling24HrNumTrades\": { \"type\": \"integer\", \"description\": \"Number of trades during the past 24 hours, regardless of time zone. Recalculates continuously.\" }, \"Rolling24HrPxChange\": { \"type\": \"number\", \"format\": \"decimal\", \"description\": \"Price change during the past 24 hours, regardless of time zone. Recalculates continuously.\" }, \"Rolling24HrPxChangePercent\": { \"type\": \"number\", \"format\": \"decimal\", \"description\": \"Percent change in price during the past 24hours regardless of the timezone. Recalculates continuously.\" }, \"TimeStamp\": { \"type\": \"string\", \"description\": \"The time this information was provided, in POSIX format.\" }, \"BidQty\": { \"type\": \"number\", \"format\": \"decimal\", \"description\": \"Quantity currently being bid.\" }, \"AskQty\": { \"type\": \"number\", \"format\": \"decimal\", \"description\": \"Quantity currently being asked.\" }, \"BidOrderCt\": { \"type\": \"integer\", \"description\": \"Count of bid orders.\" }, \"AskOrderCt\": { \"type\": \"integer\", \"description\": \"Count of ask orders.\" } } } }"},"title":"GetLevel1SummaryResponse"}}}}
```

## The GetLevel1SummaryMinRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetLevel1SummaryMinRequest":{"type":"object","properties":{"OMSId":{"type":"integer","description":"The ID of the OMS."},"InstrumentIds":{"type":"string","description":"An array but will be passed as a string. List of instrument ids to get level1 summaries of. If this field is not specified, level1 summary of all instruments will be returned."}},"required":["OMSId"],"title":"GetLevel1SummaryMinRequest"}}}}
```

## The GetLevel1SummaryMinResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetLevel1SummaryMinResponse":{"type":"array","items":{"type":"array","items":false,"prefixItems":[{"type":"integer","description":"InstrumentId. The ID of the instrument."},{"type":"string","description":"InstrumentSymbol. The symbol of the instrument."},{"type":"number","format":"decimal","description":"LastTradedPX. The last-traded price for the instrument."},{"type":"number","format":"decimal","description":"Rolling24HrVolume. Unit volume (quantity traded, in the product 1 or in the base currency denomination) of the instrument during the past 24 hours, regardless of time zone. Recalculates continuously."},{"type":"number","format":"decimal","description":"Rolling24HrPxChange. Change in price during the past 24 hours regardless of the timezone. Recalculates continuously."},{"type":"number","format":"decimal","description":"Rolling24HrPxChangePercent. Percent change in price during the past 24 hours regardless of the timezone. Recalculates continuously."}]},"title":"GetLevel1SummaryMinResponse"}}}}
```

## The GetOpenTradeReportsRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetOpenTradeReportsRequest":{"type":"object","properties":{"OMSId":{"type":"integer","description":"The ID of the OMS."},"AccountId":{"type":"integer","description":"The ID of the account whose open blocktrade/s will be retrieved."}},"required":["OMSId","AccountId"],"title":"GetOpenTradeReportsRequest"}}}}
```

## The GetOpenTradeReportsResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetOpenTradeReportsResponse":{"type":"array","items":{"type":"object","properties":{"Side":{"type":"string","enum":["Buy","Sell"],"description":"The side of a trade. One of: 0 Buy, 1 Sell."},"OrderId":{"type":"integer","format":"int64","description":"The ID of the open order. The _OrderID_ is unique in each OMS."},"Price":{"type":"number","format":"decimal","description":"The price at which the buy or sell has been ordered."},"Quantity":{"type":"number","format":"decimal","description":"The quantity of the product to be bought or sold."},"DisplayQuantity":{"type":"number","format":"decimal","description":"The quantity available to buy or sell that is publicly displayed to the market. To display a _displayQuantity_ value, an order must be a Limit order with a reserve."},"Instrument":{"type":"integer","description":"The ID of the instrument being traded. The call **GetInstruments** can supply the instrument IDs that are available."},"Account":{"type":"integer","description":"The ID of the of the account which submitted the order."},"AccountName":{"type":"string","description":"Name of the of the account which submitted the order."},"OrderType":{"type":"string","description":"Will always be **BlockTrade** as this GetOpenTradeReports API will only return open blocktrades."},"ClientOrderId":{"type":"integer","format":"int64","default":0,"description":"An ID supplied by the client to identify the order (like a purchase order number). Default is 0."},"OrderState":{"type":"string","enum":["Unknown","Working","Rejected","Canceled","Expired","FullyExecuted"],"description":"The current state of the order. One of: 0 Unknown, 1 Working, 2 Rejected, 3 Canceled, 4 Expired, 5 FullyExecuted."},"ReceiveTime":{"type":"integer","format":"int64","description":"Time stamp of the order in POSIX format x 1000 (milliseconds since 1/1/1970 in UTC time zone)."},"ReceiveTimeTicks":{"type":"integer","format":"int64","description":"Time stamp of the order Microsoft Ticks format and UTC time zone. **Note:** Microsoft Ticks format is usually provided as a string. Here it is provided as a long integer."},"OrigQuantity":{"type":"number","format":"decimal","description":"If the open order has been changed or partially filled, this value shows the original quantity of the order."},"QuantityExecuted":{"type":"number","format":"decimal","description":"If the open order has been at least partially executed, this value shows the amount that has been executed."},"GrossValueExecuted":{"type":"number","format":"decimal","description":"If the open order has been at least partially executed, this value shows the gross amount that has been executed."},"AvgPrice":{"type":"number","format":"decimal","description":"The average executed price of the order."},"CounterPartyId":{"type":"integer","description":"The ID of the account who will be the counter party of the blocktrade."},"ChangeReason":{"type":"string","enum":["Unknown","NewInputAccepted","NewInputRejected","OtherRejected","Expired","Trade","SystemCanceled_NoMoreMarket","SystemCanceled_BelowMinimum","SystemCanceled_PriceCollar","SystemCanceled_MarginFailed","UserModified"],"description":"If the order has been changed, this string value holds the reason. One of: 0 Unknown, 1 NewInputAccepted, 2 NewInputRejected, 3 OtherRejected, 4 Expired, 5 Trade, 6 SystemCanceled_NoMoreMarket, 7 SystemCanceled_BelowMinimum, 8 SystemCanceled_PriceCollar, 9 SystemCanceled_MarginFailed, 100 UserModified."},"OrigOrderId":{"type":"integer","description":"If the order has been changed, this is the ID of the original order."},"OrigClOrdId":{"type":"integer","description":"If the order has been changed, this is the ID of the original client order ID."},"EnteredBy":{"type":"integer","description":"The ID of the user who submitted the order."},"Username":{"type":"integer","description":"The username of the user who submitted the order."},"IsQuote":{"type":"boolean","description":"If this order is a quote (created using [**CreateDirectQuote**](#operation/CreateDirectQuote) API method or the [**CreateInverseQuote**](#operation/CreateInverseQuote) API method), the value for _IsQuote_ is _true_, else _false._."},"InsideAsk":{"type":"number","format":"decimal","description":"If this order is a quote, this value is the Inside Ask price."},"InsideAskSize":{"type":"number","format":"decimal","description":"If this order is a quote, this value is the quantity of the Inside Ask quote."},"InsideBid":{"type":"number","format":"decimal","description":"If this order is a quote, this value is the Inside Bid price."},"InsideBidSize":{"type":"number","format":"decimal","description":"If this order is a quote, this value is the quantity of the Inside Bid quote."},"LastTradePrice":{"type":"number","format":"decimal","description":"The last price that this instrument traded at."},"RejectReason":{"type":"string","description":"If this open order has been rejected, this string holds the reason for the rejection."},"IsLockedIn":{"type":"boolean","description":"For a block trade, if both parties to the block trade agree that one of the parties will report the trade for both sides, this value is _true._ Othersise, _false._."},"CancelReason":{"type":"string","description":"If this order has been canceled, this string holds the cancellation reason."},"UseMargin":{"type":"boolean","default":false,"description":"Margin is not yet supported so this always defaults to false."},"StopPrice":{"type":"number","format":"decimal","description":"The price at which the order executes, if the order is a stop order. Defaults to 0 if order is another type."},"PegPriceType":{"type":"string","description":"Not applicable for an order resulting from **SubmitBlockTrade**."},"PegOffset":{"type":"number","format":"decimal","description":"Not applicable for an order resulting from **SubmitBlockTrade**."},"PegLimitOffset":{"type":"number","format":"decimal","description":"Not applicable for an order resulting from **SubmitBlockTrade**."},"IpAddress":{"type":"string","description":"The IP address from where the order was submitted."},"OMSId":{"type":"integer","description":"The ID of the OMS."}},"required":["Side","OrderId","Price","Quantity","DisplayQuantity","Instrument","Account","AccountName","OrderType","ClientOrderId","OrderState","ReceiveTime","ReceiveTimeTicks","OrigQuantity","QuantityExecuted","GrossValueExecuted","AvgPrice","CounterPartyId","ChangeReason","OrigOrderId","OrigClOrdId","EnteredBy","Username","IsQuote","InsideAsk","InsideAskSize","InsideBid","InsideBidSize","LastTradePrice","RejectReason","IsLockedIn","CancelReason","UseMargin","StopPrice","PegPriceType","PegOffset","PegLimitOffset","IpAddress","OMSId"]},"title":"GetOpenTradeReportsResponse"}}}}
```

## The GetOrdersRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetOrdersRequest":{"type":"object","properties":{"OMSId":{"type":"integer","description":"The ID of the OMS on which the orders took place."},"AccountId":{"type":"integer","description":"The account ID that made the trades. A user with NotbankTrading permission must be associated with this account, although other users also can be associated with the account."},"OrderState":{"type":"string","enum":["Unknown","Working","Rejected","Canceled","Expired","FullyExecuted"],"description":"The current state of the order. Can be used to filter results. If not specified all orders regardless of the order state will be returned. One of: 0 Unknown, 1 Working, 2 Rejected, 3 Canceled, 4 Expired, 5 FullyExecuted."},"OrderId":{"type":"integer","format":"int64","description":"The ID for the order. Can be used to filter results. Can be used to filter for a specific orderId. There is a specific API call [**GetOrderHistoryByOrderId**](#operation/GetOrderHistoryByOrderId) for filtering orders by **OrderId**."},"ClientOrderId":{"type":"integer","format":"int64","default":0,"description":"A user-assigned ID for the order (like a purchase-order number assigned by a company). Can be used to filter results. Default is 0."},"OriginalOrderId":{"type":"integer","format":"int64","description":"The original ID of the order. If specified, the call returns changed orders associated with this order ID. Can be used to filter results."},"OriginalClientOrderId":{"type":"integer","format":"int64","description":"If the order has been changed, shows the original client order ID, a value that the client can create (much like a purchase order). Can be used to filter results."},"UserId":{"type":"integer","description":"The ID of the user whose account orders will be returned. If not specified, the call returns the orders of the logged-in user. Can be used to filter results."},"InstrumentId":{"type":"integer","format":"int64","description":"The ID of the instrument named in the order. If not specified, the call returns orders for all instruments traded by this account. Can be used to filter results."},"StartTimestamp":{"type":"integer","format":"int64","description":"Date and time at which to begin the orders history, in POSIX format. Can be used to filter results."},"EndTimestamp":{"type":"integer","format":"int64","description":"Date and time at which to end the orders report, in POSIX format. Can be used to filter results."},"Depth":{"type":"integer","description":"In this case, the maximum number/count of orders to return, counting from the _StartIndex_ if it is also specified. If not specified, returns all orders from the most recent to oldest; results can vary depending if other optional fields are defined such as _StartIndex_, _StartTimestamp_, and _EndTimestamp_. Can be used to filter results and for pagination."},"Limit":{"type":"integer","description":"Functions exactly the same as the **Depth** field."},"StartIndex":{"type":"integer","default":0,"description":"A value of 0 means the first object in the result will be the the most recent order, a value of 2 means that the first object in the result set will be the third most recent order. Can be used to filter results or for pagination. Default is 0."}},"required":["OMSId","AccountId"],"title":"GetOrdersRequest"}}}}
```

## The GetOrdersResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetOrdersResponse":{"type":"array","items":{"type":"object","properties":{"Side":{"type":"string","enum":["Buy","Sell"],"description":"The side of a trade. One of: **0** Buy, **1** Sell."},"OrderId":{"type":"integer","format":"int64","description":"The ID of the open order. The _OrderID_ is unique in each OMS."},"Price":{"type":"number","format":"decimal","description":"The price at which the buy or sell has been ordered."},"Quantity":{"type":"number","format":"decimal","description":"The quantity of the product to be bought or sold."},"DisplayQuantity":{"type":"number","format":"decimal","description":"The quantity available to buy or sell that is publicly displayed to the market. To display a _displayQuantity_ value, an order must be a Limit order with a reserve."},"Instrument":{"type":"integer","description":"The ID of the instrument being traded. The API method [**GetInstruments**](#operation/GetInstruments) can supply the instrument IDs that are available."},"Account":{"type":"integer","description":"The ID of the of the account which the order belongs to."},"AccountName":{"type":"string","description":"Name of the of the account which which the order belongs to."},"OrderType":{"type":"string","enum":["Unknown an error condition","Market","Limit","StopMarket","StopLimit","TrailingStopMarket","TrailingStopLimit","BlockTrade"],"description":"Describes the type of order this is. One of: 0 Unknown (an error condition), 1 Market, 2 Limit, 3 StopMarket, 4 StopLimit, 5 TrailingStopMarket, 6 TrailingStopLimit, 7 BlockTrade."},"ClientOrderId":{"type":"integer","format":"int64","default":0,"description":"An ID supplied by the client to identify the order (like a purchase order number). Default is 0."},"OrderState":{"type":"string","enum":["Unknown","Working","Rejected","Canceled","Expired","Fully Executed"],"description":"The current or the latest state of the order. One of: 0 Unknown, 1 Working, 2 Rejected, 3 Canceled, 4 Expired, 5 Fully Executed."},"ReceiveTime":{"type":"integer","format":"int64","description":"Time stamp of the order in POSIX format x 1000 (milliseconds since 1/1/1970 in UTC time zone)."},"ReceiveTimeTicks":{"type":"integer","format":"int64","description":"Time stamp of the order Microsoft Ticks format and UTC time zone. **Note:** Microsoft Ticks format is usually provided as a string. Here it is provided as a long integer."},"LastUpdatedTime":{"type":"integer","format":"int64","description":"Time stamp when the order was last updated, in POSIX format x 1000 (milliseconds since 1/1/1970 in UTC time zone)."},"LastUpdatedTimeTicks":{"type":"integer","format":"int64","description":"Time stamp when the order was last updated, in Microsoft Ticks format and UTC time zone. **Note:** Microsoft Ticks format is usually provided as a string. Here it is provided as a long integer."},"OrigQuantity":{"type":"number","format":"decimal","description":"If the open order has been changed or partially filled, this value shows the original quantity of the order."},"QuantityExecuted":{"type":"number","format":"decimal","description":"If the open order has been at least partially executed, this value shows the amount that has been executed."},"GrossValueExecuted":{"type":"number","format":"decimal","description":"If the open order has been at least partially executed, this value shows the gross amount that has been executed."},"ExecutableValue":{"type":"number","format":"decimal","description":"Defaults to 0. For future provision."},"AvgPrice":{"type":"number","format":"decimal","description":"The average executed price of the order."},"CounterPartyId":{"type":"integer","description":"The ID of the account who is the counterparty for the trade if order is already executed, either partial or fully executed."},"ChangeReason":{"type":"string","enum":["Unknown","NewInputAccepted","NewInputRejected","OtherRejected","Expired","Trade","SystemCanceled_NoMoreMarket","SystemCanceled_BelowMinimum","SystemCanceled_PriceCollar","SystemCanceled_MarginFailed","UserModified"],"description":"If the order has been changed, this string value holds the reason. One of: 0 Unknown, 1 NewInputAccepted, 2 NewInputRejected, 3 OtherRejected, 4 Expired, 5 Trade, 6 SystemCanceled_NoMoreMarket, 7 SystemCanceled_BelowMinimum, 8 SystemCanceled_PriceCollar, 9 SystemCanceled_MarginFailed, 100 UserModified. An order that is newly added to book will have **NewInputAccepted** value by default."},"OrigOrderId":{"type":"integer","format":"int64","description":"If the order is a replacement order, this is the ID of the original order."},"OrigClOrdId":{"type":"integer","format":"int64","description":"If the order is a replacement order, this is the client order ID or the original order."},"EnteredBy":{"type":"integer","description":"The ID of the user who submitted the order."},"Username":{"type":"string","description":"The username of the user who submitted the order."},"IsQuote":{"type":"boolean","description":"If this order is a quote, the value for _IsQuote_ is _true_, otherwise it is _false._."},"InsideAsk":{"type":"number","format":"decimal","description":"If this order is a quote, this value is the Inside Ask price."},"InsideAskSize":{"type":"number","format":"decimal","description":"If this order is a quote, this value is the quantity of the Inside Ask quote."},"InsideBid":{"type":"number","format":"decimal","description":"If this order is a quote, this value is the Inside Bid price."},"InsideBidSize":{"type":"number","format":"decimal","description":"If this order is a quote, this value is the quantity of the Inside Bid quote."},"LastTradePrice":{"type":"number","format":"decimal","description":"The last price that this instrument traded at."},"RejectReason":{"type":"string","description":"If this open order has been rejected, this string holds the reason for the rejection."},"IsLockedIn":{"type":"boolean","description":"For a block trade, if both parties to the block trade agree that one of the parties will report the trade for both sides, this value is _true._ Othersise, _false._."},"CancelReason":{"type":"string","description":"If this order has been canceled, this string holds the cancellation reason."},"OrderFlag":{"oneOf":[{"type":"integer"},{"type":"string"}],"description":"One or more of:. 1 NoAccountRiskCheck. 2 AddedToBook. 4 RemovedFromBook. 8 PostOnly. 16 Liquidation. 32 ReverseMarginPosition."},"UseMargin":{"type":"boolean","default":false,"description":"Margin is not yet supported so this always defaults to false."},"StopPrice":{"type":"number","format":"decimal","description":"The price at which the order executes, if the order is a stop order. Defaults to 0 if order is another type."},"PegPriceType":{"type":"string","description":"The type of price to peg the Stop to for Stop/Trailing orders."},"PegOffset":{"type":"number","format":"decimal","description":"Only applicable to trailing/stop orders. Defaults to 0 if order is another type."},"PegLimitOffset":{"type":"number","format":"decimal","description":"Only applicable to trailing/stop orders. Defaults to 0 if order is another type."},"IpAddress":{"type":"string","description":"The IP address from where the order was submitted."},"IPv6a":{"type":"string","description":"**UInt64**. The IPv6 where the order was submitted from. Currently not being used, for future provision. Defaults to 0."},"OMSId":{"type":"integer","description":"The ID of the OMS."}},"required":["Side","OrderId","Price","Quantity","DisplayQuantity","Instrument","Account","AccountName","OrderType","ClientOrderId","OrderState","ReceiveTime","ReceiveTimeTicks","LastUpdatedTime","LastUpdatedTimeTicks","OrigQuantity","QuantityExecuted","GrossValueExecuted","ExecutableValue","AvgPrice","CounterPartyId","ChangeReason","OrigOrderId","OrigClOrdId","EnteredBy","Username","IsQuote","InsideAsk","InsideAskSize","InsideBid","InsideBidSize","LastTradePrice","RejectReason","IsLockedIn","CancelReason","OrderFlag","UseMargin","StopPrice","PegPriceType","PegOffset","PegLimitOffset","IpAddress","IPv6a","IPv6a","OMSId"]},"title":"GetOrdersResponse"}}}}
```

## The GetOrderHistoryRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetOrderHistoryRequest":{"type":"object","properties":{"OMSId":{"type":"integer","description":"The ID of the OMS on which the orders took place."},"AccountId":{"type":"integer","description":"The account ID that made the trades. A user with NotbankTrading permission must be associated with this account, although other users also can be associated with the account."},"OrderState":{"type":"string","enum":["Unknown","Working","Rejected","Canceled","Expired","FullyExecuted"],"description":"The current state of the order. Can be used to filter results. If not specified all orders regardless of the order state will be returned. One of: 0 Unknown, 1 Working, 2 Rejected, 3 Canceled, 4 Expired, 5 FullyExecuted."},"OrderId":{"type":"integer","format":"int64","description":"The ID for the order. Can be used to filter results. Can be used to filter for a specific orderId. There is a specific API call [**GetOrderHistoryByOrderId**](#operation/GetOrderHistoryByOrderId) for filtering orders by **OrderId**."},"ClientOrderId":{"type":"integer","format":"int64","default":0,"description":"A user-assigned ID for the order (like a purchase-order number assigned by a company). Can be used to filter results. Default is 0."},"OriginalOrderId":{"type":"integer","format":"int64","description":"The original ID of the order. If specified, the call returns changed orders associated with this order ID. Can be used to filter results."},"OriginalClientOrderId":{"type":"integer","format":"int64","description":"If the order has been changed, shows the original client order ID, a value that the client can create (much like a purchase order). Can be used to filter results."},"UserId":{"type":"integer","description":"The ID of the user whose account orders will be returned. If not specified, the call returns the orders of the logged-in user. Can be used to filter results."},"InstrumentId":{"type":"integer","format":"int64","description":"The ID of the instrument named in the order. If not specified, the call returns orders for all instruments traded by this account. Can be used to filter results."},"StartTimestamp":{"type":"integer","format":"int64","description":"Date and time at which to begin the orders history, in POSIX format. Can be used to filter results."},"EndTimestamp":{"type":"integer","format":"int64","description":"Date and time at which to end the orders report, in POSIX format. Can be used to filter results."},"Depth":{"type":"integer","description":"In this case, the maximum number/count of orders to return, counting from the _StartIndex_ if it is also specified. If not specified, returns 100 most recent orders; results can vary depending if other optional fields are defined such as _StartIndex_, _StartTimestamp_, and _EndTimestamp_. Can be used to filter results and for pagination."},"Limit":{"type":"integer","description":"Functions exactly the same as the **Depth** field."},"StartIndex":{"type":"integer","default":0,"description":"A value of 0 means the first object in the result will be the the most recent order, a value of 2 means that the first object in the result set will be the third most recent order. Can be used to filter results or for pagination. Default is 0."}},"required":["OMSId","AccountId"],"title":"GetOrderHistoryRequest"}}}}
```

## The GetOrderHistoryResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetOrderHistoryResponse":{"type":"array","items":{"type":"object","properties":{"Side":{"type":"string","enum":["Buy","Sell"],"description":"The side of a trade. One of: 0 Buy, 1 Sell."},"OrderId":{"type":"integer","format":"int64","description":"The ID of the open order. The _OrderID_ is unique in each OMS."},"Price":{"type":"number","format":"decimal","description":"The price at which the buy or sell has been ordered."},"Quantity":{"type":"number","format":"decimal","description":"The quantity of the product to be bought or sold."},"DisplayQuantity":{"type":"number","format":"decimal","description":"The quantity available to buy or sell that is publicly displayed to the market. To display a _displayQuantity_ value, an order must be a Limit order with a reserve."},"Instrument":{"type":"integer","description":"The ID of the instrument being traded. The call [**GetInstruments**](#operation/GetInstruments) can supply the instrument IDs that are available."},"Account":{"type":"integer","description":"The ID of the of the account which the order belongs to."},"AccountName":{"type":"string","description":"Name of the of the account which which the order belongs to."},"OrderType":{"type":"string","enum":["Unknown an error condition","Market order","Limit","StopMarket","StopLimit","TrailingStopMarket","TrailingStopLimit","BlockTrade"],"description":"Describes the type of order this is. One of: 0 Unknown (an error condition), 1 Market order, 2 Limit, 3 StopMarket, 4 StopLimit, 5 TrailingStopMarket, 6 TrailingStopLimit, 7 BlockTrade."},"ClientOrderId":{"type":"integer","format":"int64","default":0,"description":"An ID supplied by the client to identify the order (like a purchase order number). Default is 0."},"OrderState":{"type":"string","enum":["Unknown","Working","Rejected","Canceled","Expired","Fully Executed"],"description":"The current or the latest state of the order. One of: 0 Unknown, 1 Working, 2 Rejected, 3 Canceled, 4 Expired, 5 Fully Executed."},"ReceiveTime":{"type":"integer","format":"int64","description":"Time stamp of the order in POSIX format x 1000 (milliseconds since 1/1/1970 in UTC time zone)."},"ReceiveTimeTicks":{"type":"integer","format":"int64","description":"Time stamp of the order Microsoft Ticks format and UTC time zone. **Note:** Microsoft Ticks format is usually provided as a string. Here it is provided as a long integer."},"LastUpdatedTime":{"type":"integer","format":"int64","description":"Time stamp when the order was last updated, in POSIX format x 1000 (milliseconds since 1/1/1970 in UTC time zone)."},"LastUpdatedTimeTicks":{"type":"integer","format":"int64","description":"Time stamp when the order was last updated, in Microsoft Ticks format and UTC time zone. **Note:** Microsoft Ticks format is usually provided as a string. Here it is provided as a long integer."},"OrigQuantity":{"type":"number","format":"decimal","description":"If the open order has been changed or partially filled, this value shows the original quantity of the order."},"QuantityExecuted":{"type":"number","format":"decimal","description":"If the open order has been at least partially executed, this value shows the amount that has been executed."},"GrossValueExecuted":{"type":"number","format":"decimal","description":"If the open order has been at least partially executed, this value shows the gross amount that has been executed."},"ExecutableValue":{"type":"number","format":"decimal","description":"Defaults to 0. For future provision."},"AvgPrice":{"type":"number","format":"decimal","description":"The average executed price of the order."},"CounterPartyId":{"type":"integer","description":"The ID of the account who is the counterparty for the trade if order is already executed, either partial or fully executed."},"ChangeReason":{"type":"string","enum":["Unknown","NewInputAccepted","NewInputRejected","OtherRejected","Expired","Trade","SystemCanceled_NoMoreMarket","SystemCanceled_BelowMinimum","SystemCanceled_PriceCollar","SystemCanceled_MarginFailed","UserModified"],"description":"If the order has been changed, this string value holds the reason. One of: 0 Unknown, 1 NewInputAccepted, 2 NewInputRejected, 3 OtherRejected, 4 Expired, 5 Trade, 6 SystemCanceled_NoMoreMarket, 7 SystemCanceled_BelowMinimum, 8 SystemCanceled_PriceCollar, 9 SystemCanceled_MarginFailed, 100 UserModified. An order that is newly added to book will have **NewInputAccepted** value by default."},"OrigOrderId":{"type":"integer","format":"int64","description":"If the order is a replacement order, this is the ID of the original order."},"OrigClOrdId":{"type":"integer","format":"int64","description":"If the order is a replacement order, this is the client order ID or the original order."},"EnteredBy":{"type":"integer","description":"The ID of the user who submitted the order."},"Username":{"type":"string","description":"The username of the user who submitted the order."},"IsQuote":{"type":"boolean","description":"If this order is a quote, the value for _IsQuote_ is _true_, otherwise it is _false._."},"InsideAsk":{"type":"number","format":"decimal","description":"If this order is a quote, this value is the Inside Ask price."},"InsideAskSize":{"type":"number","format":"decimal","description":"If this order is a quote, this value is the quantity of the Inside Ask quote."},"InsideBid":{"type":"number","format":"decimal","description":"If this order is a quote, this value is the Inside Bid price."},"InsideBidSize":{"type":"number","format":"decimal","description":"If this order is a quote, this value is the quantity of the Inside Bid quote."},"LastTradePrice":{"type":"number","format":"decimal","description":"The last price that this instrument traded at."},"RejectReason":{"type":"string","description":"If this open order has been rejected, this string holds the reason for the rejection."},"IsLockedIn":{"type":"boolean","description":"For a block trade, if both parties to the block trade agree that one of the parties will report the trade for both sides, this value is _true._ Othersise, _false._."},"CancelReason":{"type":"string","description":"If this order has been canceled, this string holds the cancellation reason."},"OrderFlag":{"oneOf":[{"type":"integer"},{"type":"string"}],"description":"One or more of:. 1 NoAccountRiskCheck. 2 AddedToBook. 4 RemovedFromBook. 8 PostOnly. 16 Liquidation. 32 ReverseMarginPosition."},"UseMargin":{"type":"boolean","default":false,"description":"Margin is not yet supported so this always defaults to false."},"StopPrice":{"type":"number","format":"decimal","description":"The price at which the order executes, if the order is a stop order. Defaults to 0 if order is another type."},"PegPriceType":{"type":"string","description":"The type of price to peg the Stop to for Stop/Trailing orders."},"PegOffset":{"type":"number","format":"decimal","description":"Only applicable to trailing/stop orders. Defaults to 0 if order is another type."},"PegLimitOffset":{"type":"number","format":"decimal","description":"Only applicable to trailing/stop orders. Defaults to 0 if order is another type."},"IpAddress":{"type":"string","description":"The IP address from where the order was submitted."},"IPv6a":{"type":"string","description":"**UInt64**. The IPv6 where the order was submitted from. Currently not being used, for future provision. Defaults to 0."},"OMSId":{"type":"integer","description":"The ID of the OMS."}},"required":["Side","OrderId","Price","Quantity","DisplayQuantity","Instrument","Account","AccountName","OrderType","ClientOrderId","OrderState","ReceiveTime","ReceiveTimeTicks","LastUpdatedTime","LastUpdatedTimeTicks","OrigQuantity","QuantityExecuted","GrossValueExecuted","ExecutableValue","AvgPrice","CounterPartyId","ChangeReason","OrigOrderId","OrigClOrdId","EnteredBy","Username","IsQuote","InsideAsk","InsideAskSize","InsideBid","InsideBidSize","LastTradePrice","RejectReason","IsLockedIn","CancelReason","OrderFlag","UseMargin","StopPrice","PegPriceType","PegOffset","PegLimitOffset","IpAddress","IPv6a","IPv6a","OMSId"]},"title":"GetOrderHistoryResponse"}}}}
```

## The SendOrderRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"SendOrderRequest":{"type":"object","properties":{"InstrumentId":{"type":"integer","description":"The ID of the instrument being traded."},"OMSId":{"type":"integer","description":"The ID of the OMS on which the instrument is being traded."},"AccountId":{"type":"integer","description":"The ID of the account the order will be placed for."},"TimeInForce":{"type":"integer","enum":[0,1,2,3,4,5,6],"description":"An integer that represents the period during which the new order is executable. One of: **0** Unknown (an error condition), **1** GTC (good 'til canceled, the default), **2** OPG (execute as close to opening price as possible: not yet used, for future provision), **3** IOC (immediate or canceled), **4** FOK (fill-or-kill — fill immediately or kill immediately), **5** GTX (good 'til executed: not yet used, for future provision), **6** GTD (good 'til date: not yet used, for future provision)."},"ClientOrderId":{"type":"integer","format":"int64","default":0,"description":"A user-assigned ID for the order (like a purchase-order number assigned by a company). This ID is useful for recognizing future states related to this order. Duplicate client orderid of two open orders of the same account is not allowed, the incoming order with the same ClientOrderId will get rejected. Default is 0."},"OrderIdOCO":{"type":"integer","format":"int64","description":"The order ID if One Cancels the Other — If this order is order A, _OrderIdOCO_ refers to the order ID of an order B (which is _not_ the order being created by this call). If order B executes, then order A created by this call is canceled. You can also set up order B to watch order A in the same way, but that may require an update to order B to make it watch this one, which could have implications for priority in the order book. See [**CancelReplaceOrder**](#operation/CancelReplaceOrder) and [**ModifyOrder**](#operation/ModifyOrder)."},"UseDisplayQuantity":{"type":"boolean","default":false,"description":"If you enter a Limit order with a reserve (reserve order), you must set _UseDisplayQuantity_ to _true_ else, the quantity of your order will be 0, defaults to **false**."},"Side":{"type":"integer","enum":[0,1],"description":"A number representing the side of a trade. One of: **0** Buy, **1** Sell."},"Quantity":{"type":"number","format":"decimal","description":"The quantity of the instrument being ordered. Not required if **OrderType** is Market (1) and as long as **Value** is defined."},"OrderType":{"type":"integer","enum":[0,1,2,3,4,5,6,7],"description":"The type of the order. One of: **0** Unknown, **1** Market, **2** Limit, **3** StopMarket, **4** StopLimit, **5** TrailingStopMarket, **6** TrailingStopLimit, **7** BlockTrade."},"PegPriceType":{"oneOf":[{"type":"integer"},{"type":"string"}],"enum":[1,2,3,4],"default":1,"description":"Only applicable to TrailingStop and Stop orders. The type of price that pegs the stop. One of: 1 Last, 2 Bid, 3 Ask, 4 Midpoint (Currently unsupported; for future provision). Default is 1 Last."},"LimitPrice":{"type":"number","format":"decimal","description":"The price at which the order will be placed. Required if OrderType is **2 Limit** or **4 StopLimit** or **7 TrailingStopLimit**."},"StopPrice":{"type":"number","format":"decimal","default":0,"description":"Applicable to TrailingStop (Limit and Market) and Stop (Limit and Market) orders only; the price at which the order will get activated. Is not required to be defined for TrailingStop order as this price will be determined automatically based on the **TrailingAmount**, **PegPriceType** and most importantly the movement of the price where the order is pegged (**PegPriceType**). Default is 0."},"TrailingAmount":{"type":"number","format":"decimal","description":"Applicable to TrailingStopLimit and TrailingStopMarket orders only; a number that will be either added to (buy side) or subtracted from (sell side) the price where the order is pegged(depends on the **PegPriceType**); the sum or the difference will be the **StopPrice** of the **TrailingStop** order. On the buy side, if the price where the order is pegged increases and never goes down below the value when the order was placed, the resulting StopPrice will be the sum of the price where the order is pegged during submission and the TrailingAmount; however, if the price where the order is pegged decreases, the StopPrice will change, it will be the sum of the whatever is the lowest value the pegged price will have and the TrailingAmount: the logic on the sell side is the opposite."},"LimitOffset":{"type":"number","format":"decimal","description":"Applicable to TrailingStopLimit only; a number that will be either added (buy side) or subtracted (sell side) to the **StopPrice**, the sum or the difference will be the LimitPrice of the order when it gets activated."},"DisplayQuantity":{"type":"integer","description":"If _UseDisplayQuantity_ is set to _true_, you must set a value of this field greater than 0, else, order will not appear in the orderbook."},"Value":{"type":"number","format":"decimal","description":"The total value of the trade. Only applicable in a market order type: a user can opt to input a value instead of defining the quantity which will then be automatically calculated: value/marketprice."},"PostOlny":{"type":"boolean","description":"If the order is post only."}},"required":["InstrumentId","OMSId","AccountId","TimeInForce","Side","Quantity","OrderType","LimitPrice","StopPrice","TrailingAmount","LimitOffset"],"title":"SendOrderRequest"}}}}
```

## The SendOrderResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"SendOrderResponse":{"type":"object","properties":{"status":{"type":"string","description":"If the order is accepted by the system, it returns \"Accepted,\" if not it returns \"Rejected.\". Accepted. Rejected."},"errormsg":{"type":"string","description":"Any error message the server returns."},"OrderId":{"type":"integer","format":"int64","description":"The ID assigned to the order by the server. This allows you to track the order."}},"required":["status","errormsg","OrderId"],"title":"SendOrderResponse"}}}}
```

## The CancelReplaceOrderRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"CancelReplaceOrderRequest":{"type":"object","properties":{"OMSId":{"type":"integer","description":"The ID of the OMS on which the order is being canceled and replaced by another order."},"OrderIdToReplace":{"type":"integer","format":"int64","description":"The ID of the order to replace with this order."},"ClientOrderId":{"type":"integer","format":"int64","default":0,"description":"A user-assigned ID for the new, replacement order (like a purchase-order number assigned by a company). This ID is useful for recognizing future states related to this order. Default is 0."},"OrderType":{"oneOf":[{"type":"integer"},{"type":"string"}],"enum":[0,1,2,3,4,5,6,7],"description":"The type of the replacement order. One of: 0 Unknown, 1 Market, 2 Limit, 3 StopMarket, 4 StopLimit, 5 TrailingStopMarket, 6 TrailingStopLimit, 7 BlockTrade."},"Side":{"oneOf":[{"type":"integer"},{"type":"string"}],"enum":[0,1,2,3],"description":"The side of the replacement order. One of: 0 Buy, 1 Sell, 2 Short(reserved for future use), 3 Unknown (an error condition)."},"AccountId":{"type":"integer","description":"The ID of the account under which the original order was placed and the new order will be placed. If AccountId will not match the one on the order to be replaced, request will fail."},"InstrumentId":{"type":"integer","description":"The ID of the instrument being traded. Must be identical with the instrument ID of the order to be replaced, else, request will fail."},"UseDisplayQuantity":{"type":"boolean","description":"The display quantity is the quantity of a product shown to the market to buy or sell. A larger quantity may be wanted or available, but it may disadvantageous to display it when buying or selling. The display quantity is set when placing an order (using [**SendOrder**](#operation/SendOrder) or [**CancelReplaceOrder**](#operation/CancelReplaceOrder) for instance). If you enter a Limit order with reserve, you must set _useDisplayQuantity_ to _true_."},"DisplayQuantity":{"type":"number","format":"decimal","description":"The quantity of a product that is available to buy or sell that is publicly displayed to the market. Needs to be defined with a value greater than 0 if **UseDisplayQuantity** is set to true, otherwise new order will not be visible in the orderbook."},"LimitPrice":{"type":"number","format":"decimal","description":"The price at which to execute the new order, if the new order is a limit order."},"StopPrice":{"type":"number","format":"decimal","description":"The price at which to execute the new order, if the order is a stop order."},"ReferencePrice":{"type":"number","format":"decimal","description":"The reference price of the instrument in the order."},"PegPriceType":{"oneOf":[{"type":"integer"},{"type":"string"}],"enum":[1,2,3,4],"description":"When entering a stop/trailing order, set PegPriceType to the type of price that pegs the stop. One of: 1 Last, 2 Bid, 3 Ask, 4 Midpoint."},"TimeInForce":{"oneOf":[{"type":"integer"},{"type":"string"}],"enum":[0,1,2,3,4,5,6],"description":"The period during which the new order is executable. One of: 0 Unknown (an error condition), 1 GTC (good 'til canceled, the default), 2 OPG (execute as close to opening price as possible: not yet used, for future provision), 3 IOC (immediate or canceled), 4 FOK (fill or kill — fill the order immediately, or cancel it immediately), 5 GTX (good 'til executed: not yet used, for future provision), 6 GTD (good 'til date: not yet used, for future provision).  The string value or the equivalent integer value can be used."},"OrderIdOCO":{"type":"integer","format":"int64","description":"One Cancels the Other — If the order being canceled in this call is order A, and the order replacing order A in this call is order B, then _OrderIdOCO_ refers to an order C that is currently open. If order C executes, then order B is canceled. You can also set up order C to watch order B in this way, but that will require an update to order C."},"Quantity":{"type":"number","format":"decimal","default":0,"description":"The amount of the order (either buy or sell). Not explicitly required but defaults to 0 when not defined, so it makes sense to be set greater than 0."}},"required":["OMSId","OrderIdToReplace","OrderType","Side","AccountId","InstrumentId","UseDisplayQuantity","DisplayQuantity","LimitPrice","StopPrice","PegPriceType","TimeInForce","Quantity"],"title":"CancelReplaceOrderRequest"}}}}
```

## The CancelReplaceOrderResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"CancelReplaceOrderResponse":{"type":"object","properties":{"replacementOrderId":{"type":"integer","description":"The order ID assigned to the replacement order by the server."},"replacementClOrdId":{"type":"integer","format":"int64","description":"Echoes the contents of the _clientOrderId_ value from the request."},"origOrderId":{"type":"integer","description":"Echoes _orderIdToReplace_, which is the original order you are replacing."},"origClOrdId":{"type":"integer","format":"int64","description":"Provides the client order ID of the original order (not specified in the requesting call)."}},"required":["replacementOrderId","replacementClOrdId","origOrderId","origClOrdId"],"title":"CancelReplaceOrderResponse"}}}}
```

## The CancelOrderRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"CancelOrderRequest":{"type":"object","properties":{"OMSId":{"type":"integer","description":"The ID of the OMS on which the order exists."},"AccountId":{"type":"integer","description":"The ID of the account under which the order was placed."},"OrderId":{"type":"integer","format":"int64","description":"The order to be canceled."}},"required":["OMSId","AccountId","OrderId"],"title":"CancelOrderRequest"}}}}
```

## The CancelOrderResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"CancelOrderResponse":{"type":"object","properties":{"result":{"type":"boolean","description":"Returns _true_ if the call to cancel the order has been successfully received, otherwise returns _false_."},"errormsg":{"type":"string","description":"A successful receipt of a call to cancel an order returns _null_; the _errormsg_ parameter for an unsuccessful call to cancel an order returns one of the following messages:. Not Authorized (errorcode 20). Invalid Request (errorcode 100). Operation Failed (errorcode 101). Server Error (errorcode 102). Resource Not Found (errorcode 104). Operation Not Supported (errorcode 106)."},"errorcode":{"type":"integer","description":"A successfully received call to cancel an order returns 0. An unsuccessfully received call to cancel an order returns one of the _errorcodes_ shown in the _errormsg_ list."},"detail":{"type":"string","description":"Message text that the system may send. The contents of this parameter are usually null."}},"required":["result","errormsg","errorcode","detail"],"title":"CancelOrderResponse"}}}}
```

## The GetOpenOrdersRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetOpenOrdersRequest":{"type":"object","properties":{"OMSId":{"type":"integer","description":"The ID of the OMS on which the user resides."},"AccountId":{"type":"integer","description":"The ID of the account which you are getting open orders for."},"InstrumentId":{"type":"integer","description":"The ID of a specific instrument, can be used to filter results."}},"required":["OMSId","AccountId"],"title":"GetOpenOrdersRequest"}}}}
```

## The GetOpenOrdersResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetOpenOrdersResponse":{"type":"array","items":{"type":"object","properties":{"Side":{"type":"string","enum":["Buy","Sell"],"description":"The side of a trade. One of: 0 Buy, 1 Sell."},"OrderId":{"type":"integer","format":"int64","description":"The ID of the open order. The _OrderID_ is unique in each OMS."},"Price":{"type":"number","format":"decimal","description":"The price at which the buy or sell has been ordered."},"Quantity":{"type":"number","format":"decimal","description":"The quantity of the product to be bought or sold."},"DisplayQuantity":{"type":"number","format":"decimal","description":"The quantity available to buy or sell that is publicly displayed to the market. To display a _displayQuantity_ value, an order must be a Limit order with a reserve."},"Instrument":{"type":"integer","description":"The ID of the instrument being traded. The API method [**GetInstruments**](#operation/GetInstruments) can supply the instrument IDs that are available."},"Account":{"type":"integer","description":"The ID of the of the account which the order belongs to."},"AccountName":{"type":"string","description":"Name of the of the account which which the order belongs to."},"OrderType":{"type":"string","enum":["Unknown an error condition","Market order","Limit","StopMarket","StopLimit","TrailingStopMarket","TrailingStopLimit","BlockTrade"],"description":"Describes the type of order this is. One of: 0 Unknown (an error condition), 1 Market order, 2 Limit, 3 StopMarket, 4 StopLimit, 5 TrailingStopMarket, 6 TrailingStopLimit, 7 BlockTrade."},"ClientOrderId":{"type":"integer","format":"int64","default":0,"description":"An ID supplied by the client to identify the order (like a purchase order number). Default is 0."},"OrderState":{"type":"string","description":"The current state of the order. Will always be Working as this API method is getting **open orders**."},"ReceiveTime":{"type":"integer","format":"int64","description":"Time stamp of the order in POSIX format x 1000 (milliseconds since 1/1/1970 in UTC time zone)."},"ReceiveTimeTicks":{"type":"integer","format":"int64","description":"Time stamp of the order Microsoft Ticks format and UTC time zone. **Note:** Microsoft Ticks format is usually provided as a string. Here it is provided as a long integer."},"LastUpdatedTime":{"type":"integer","format":"int64","description":"Time stamp when the order was last updated, in POSIX format x 1000 (milliseconds since 1/1/1970 in UTC time zone)."},"LastUpdatedTimeTicks":{"type":"integer","format":"int64","description":"Time stamp when the order was last updated, in Microsoft Ticks format and UTC time zone. **Note:** Microsoft Ticks format is usually provided as a string. Here it is provided as a long integer."},"OrigQuantity":{"type":"number","format":"decimal","description":"If the open order has been changed or partially filled, this value shows the original quantity of the order."},"QuantityExecuted":{"type":"number","format":"decimal","description":"If the open order has been at least partially executed, this value shows the amount that has been executed."},"GrossValueExecuted":{"type":"number","format":"decimal","description":"If the open order has been at least partially executed, this value shows the gross amount that has been executed."},"ExecutableValue":{"type":"number","format":"decimal","description":"Defaults to 0. For future provision."},"AvgPrice":{"type":"number","format":"decimal","description":"The average executed price of the order."},"CounterPartyId":{"type":"integer","description":"The ID of the account who is the counterparty for the trade if order is already executed, either partial or fully executed."},"ChangeReason":{"type":"string","enum":["Unknown","NewInputAccepted","NewInputRejected","OtherRejected","Expired","Trade","SystemCanceled_NoMoreMarket","SystemCanceled_BelowMinimum","SystemCanceled_PriceCollar","SystemCanceled_MarginFailed","UserModified"],"description":"If the order has been changed, this string value holds the reason. One of: 0 Unknown, **1** NewInputAccepted, 2 NewInputRejected, 3 OtherRejected, 4 Expired, 5 Trade, 6 SystemCanceled_NoMoreMarket, 7 SystemCanceled_BelowMinimum, 8 SystemCanceled_PriceCollar, 9 SystemCanceled_MarginFailed, 100 UserModified. An order that is newly added to book will have **NewInputAccepted** value by default."},"OrigOrderId":{"type":"integer","format":"int64","description":"If the order is a replacement order, this is the ID of the original order."},"OrigClOrdId":{"type":"integer","format":"int64","description":"If the order is a replacement order, this is the client order ID or the original order."},"EnteredBy":{"type":"integer","description":"The ID of the user who submitted the order."},"Username":{"type":"string","description":"The username of the user who submitted the order."},"IsQuote":{"type":"boolean","description":"If this order is a quote, the value for _IsQuote_ is _true_, otherwise it is _false._."},"InsideAsk":{"type":"number","format":"decimal","description":"If this order is a quote, this value is the Inside Ask price."},"InsideAskSize":{"type":"number","format":"decimal","description":"If this order is a quote, this value is the quantity of the Inside Ask quote."},"InsideBid":{"type":"number","format":"decimal","description":"If this order is a quote, this value is the Inside Bid price."},"InsideBidSize":{"type":"number","format":"decimal","description":"If this order is a quote, this value is the quantity of the Inside Bid quote."},"LastTradePrice":{"type":"number","format":"decimal","description":"The last price that this instrument traded at."},"RejectReason":{"type":"string","description":"If this open order has been rejected, this string holds the reason for the rejection."},"IsLockedIn":{"type":"boolean","description":"For a block trade, if both parties to the block trade agree that one of the parties will report the trade for both sides, this value is _true._ Othersise, _false._."},"CancelReason":{"type":"string","description":"If this order has been canceled, this string holds the cancellation reason."},"OrderFlag":{"oneOf":[{"type":"integer"},{"type":"string"}],"description":"One or more of:. 1 NoAccountRiskCheck. 2 AddedToBook. 4 RemovedFromBook. 8 PostOnly. 16 Liquidation. 32 ReverseMarginPosition."},"UseMargin":{"type":"boolean","default":false,"description":"Margin is not yet supported so this always defaults to false."},"StopPrice":{"type":"number","format":"decimal","description":"The price at which the order executes, if the order is a stop order. Defaults to 0 if order is another type."},"PegPriceType":{"type":"string","description":"The type of price to peg the Stop to for Stop/Trailing orders."},"PegOffset":{"type":"number","format":"decimal","description":"Only applicable to trailing/stop orders. Defaults to 0 if order is another type."},"PegLimitOffset":{"type":"number","format":"decimal","description":"Only applicable to trailing/stop orders. Defaults to 0 if order is another type."},"IpAddress":{"type":"string","description":"The IP address from where the order was submitted."},"IPv6a":{"type":"string","description":"**UInt64**. The IPv6 where the order was submitted from. Currently not being used, for future provision. Defaults to 0."},"OMSId":{"type":"integer","description":"The ID of the OMS."}},"required":["Side","OrderId","Price","Quantity","DisplayQuantity","Instrument","Account","AccountName","OrderType","ClientOrderId","OrderState","ReceiveTime","ReceiveTimeTicks","LastUpdatedTime","LastUpdatedTimeTicks","OrigQuantity","QuantityExecuted","GrossValueExecuted","ExecutableValue","AvgPrice","CounterPartyId","ChangeReason","OrigOrderId","OrigClOrdId","EnteredBy","Username","IsQuote","InsideAsk","InsideAskSize","InsideBid","InsideBidSize","LastTradePrice","RejectReason","IsLockedIn","CancelReason","OrderFlag","UseMargin","StopPrice","PegPriceType","PegOffset","PegLimitOffset","IpAddress","IPv6a","IPv6a","OMSId"]},"title":"GetOpenOrdersResponse"}}}}
```

## The GetAccountTradesRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetAccountTradesRequest":{"type":"object","properties":{"OMSId":{"type":"integer","description":"The ID of the OMS on which the user resides."},"AccountId":{"type":"integer","description":"The ID of the account. If not specified, if authenticated user has the default permissions, its default account's trades will be returned, else if the authenticated user has elevated permissions, trades of any account will be returned."},"StartIndex":{"type":"integer","description":"The starting index into the history of trades, beginning from 0 (the most recent trade)."},"Count or Depth":{"type":"integer","description":"The number of trades to return. The system can return up to 200 trades."},"InstrumentId":{"type":"integer","description":"The ID of the instrument for which account trades will be returned, filter parameter."},"TradeId":{"type":"integer","description":"The ID of a specific trade, filter parameter."},"OrderId":{"type":"integer","description":"The ID of a specific order, filter parameter."},"StartTimeStamp":{"type":"integer","format":"int64","description":"Filter parameter."},"EndTimeStamp":{"type":"integer","format":"int64","description":"Filter parameter."},"ExecutionId":{"type":"integer","description":"Filter parameter."}},"required":["OMSId"],"title":"GetAccountTradesRequest"}}}}
```

## The GetAccountTradesResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetAccountTradesResponse":{"type":"array","items":{"type":"object","properties":{"OMSId":{"type":"integer","description":"The ID of the OMS on which the account resdies."},"ExecutionId":{"type":"integer","description":"The ID of this account's side of the trade. Every trade has two sides."},"TradeId":{"type":"integer","description":"The ID of the overall trade."},"OrderId":{"type":"integer","format":"int64","description":"The ID of the order causing the trade (buy or sell)."},"AccountId":{"type":"integer","description":"The ID of the account that made the trade (buy or sell)."},"AccountName":{"type":"string","description":"The Name of the account that made the trade (buy or sell)."},"SubAccountId":{"type":"integer","description":"Not currently used; reserved for future use. Defaults to 0."},"ClientOrderId":{"type":"integer","format":"int64","default":0,"description":"An ID supplied by the client to identify the order (like a purchase order number). Default is 0."},"InstrumentId":{"type":"integer","description":"The ID of the instrument being traded. An instrument comprises two products, for example Dollars and Bitcoin."},"Side":{"type":"string","enum":["Buy","Sell"],"description":"One of: 0 Buy, 1 Sell."},"OrderType":{"type":"string","enum":["Market","Limit","BlockTrade","StopMarket","StopLimit","TrailingStopLimit","StopMarket","TrailingStopMarket"],"description":"One of: Market, Limit, BlockTrade, StopMarket, StopLimit, TrailingStopLimit, StopMarket, TrailingStopMarket."},"Quantity":{"type":"number","format":"decimal","description":"The unit quantity of this side of the trade."},"RemainingQuantity":{"type":"number","format":"decimal","description":"The number of units remaining to be traded by the order after this execution. This number is not revealed to the other party in the trade. This value is also known as \"leave size\" or \"leave quantity\"."},"Price":{"type":"number","format":"decimal","description":"The unit price at which the instrument traded."},"Value":{"type":"number","format":"decimal","description":"The total value of the deal. The system calculates this as:. unit price X quantity executed."},"CounterParty":{"type":"string","description":"The ID of the other party in a block trade. Usually, IDs are stated as integers; this value is an integer written as a string."},"OrderTradeRevision":{"type":"integer","description":"The revision number of this trade; usually 1."},"Direction":{"type":"string","enum":["No change","Uptick","DownTick"],"description":"The effect of the trade on the instrument's market price. One of: **0** No change, **1** Uptick, **2** DownTick."},"IsBlockTrade":{"type":"boolean","description":"A value of _true_ means that this trade was a block trade; a value of _false_ that it was not a block trade."},"Fee":{"type":"number","format":"decimal","description":"Any fee levied against the trade by the Exchange."},"FeeProductId":{"type":"integer","description":"The ID of the product in which the fee was levied."},"OrderOriginator":{"type":"integer","description":"The ID of the user who initiated the trade."},"UserName":{"type":"integer","description":"The UserName of the user who initiated the trade."},"TradeTimeMS":{"type":"integer","format":"int64","description":"The date and time that the trade took place, in milliseconds and POSIX format. All dates and times are UTC."},"MakerTaker":{"type":"string","enum":["Maker","Taker"],"description":"One of: Maker, Taker."},"AdapterTradeId":{"type":"integer","description":"The ID of the adapter of the overall trade."},"InsideBid":{"type":"number","format":"decimal","description":"The best (highest) price level of the buy side of the book at the time of the trade."},"InsideBidSize":{"type":"number","format":"decimal","description":"The quantity of the best (highest) price level of the buy side of the book at the time of the trade."},"InsideAsk":{"type":"number","format":"decimal","description":"The best (lowest) price level of the sell side of the book at the time of the trade."},"InsideAskSize":{"type":"number","format":"decimal","description":"The quantity of the best (lowest) price level of the sell side of the book at the time of the trade."},"CounterPartyClientUserId":{"type":"integer","description":"Indicates counterparty source of trade (OMS, Remarketer, FIX)."},"NotionalProductId":{"type":"integer","description":"Notional product the notional value was captured in."},"NotionalRate":{"type":"number","format":"decimal","description":"Notional rate from base currency at time of trade."},"NotionalValue":{"type":"number","format":"decimal","description":"Notional value in base currency of venue at time of trade."},"TradeTime":{"type":"integer","format":"int64","description":"The date and time that the trade took place, in C# Ticks. All dates and times are UTC."}},"required":["OMSId","ExecutionId","TradeId","OrderId","AccountId","AccountName","SubAccountId","ClientOrderId","InstrumentId","Side","OrderType","Quantity","RemainingQuantity","Price","Value","CounterParty","OrderTradeRevision","Direction","IsBlockTrade","Fee","FeeProductId","OrderOriginator","UserName","TradeTimeMS","MakerTaker","AdapterTradeId","InsideBid","InsideBidSize","InsideAsk","InsideAskSize","CounterPartyClientUserId","NotionalProductId","NotionalRate","NotionalValue","TradeTime"]},"title":"GetAccountTradesResponse"}}}}
```

## The SummaryResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"SummaryResponse":{"type":"array","items":{"type":"object","properties":{"trading_pairs":{"type":"string","description":"The instrument pair."},"last_price":{"type":"number","format":"decimal","description":"The last traded price of the instrument."},"lowest_ask":{"type":"number","format":"decimal","description":"The current lowest ask for the instrument."},"highest_bid":{"type":"number","format":"decimal","description":"The current highest bid for the instrument."},"base_volume":{"type":"number","format":"decimal","description":"The current base volume of the instrument."},"quote_volume":{"type":"number","format":"decimal","description":"The current quote volume of the instrument."},"price_change_percent_24h":{"type":"number","format":"decimal","description":"The price percentage change of the instrument in 24H, resets UTC midnight."},"highest_price_24h":{"type":"number","format":"decimal","description":"The highest traded price of the instrument in 24H, resets UTC midnight."},"lowest_price_24h":{"type":"number","format":"decimal","description":"The lowest traded price of the instrument in 24H, resets UTC midnight."}},"required":["trading_pairs","last_price","lowest_ask","highest_bid","base_volume","quote_volume","price_change_percent_24h","highest_price_24h","lowest_price_24h"]},"title":"SummaryResponse"}}}}
```

## The TickerRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"TickerRequest":{"type":"object","properties":{"base_id":{"type":"integer","description":"The unified cryptoasset id of the base product of the instrument."},"quote_id":{"type":"integer","description":"The quote id of the instrument."},"last_price":{"type":"number","format":"decimal","description":"The last traded price of the instrument."},"base_volume":{"type":"number","format":"decimal","description":"The current base volume of the instrument."},"quote_volume":{"type":"number","format":"decimal","description":"The current quote volume of the instrument."}},"required":["base_id","quote_id","last_price","base_volume","quote_volume"],"title":"TickerRequest"}}}}
```

## The TickerResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"TickerResponse":{"type":"object","description":"A map of ticker information where the key is the market pair in the format \"BASE_QUOTE\", e.g., \"BTC_USD\".","{market_pair}":{"type":"object","properties":{"base_id":{"type":"integer","description":"The unified cryptoasset id of the base product of the instrument."},"quote_id":{"type":"integer","description":"The quote id of the instrument."},"last_price":{"type":"number","format":"decimal","description":"The last traded price of the instrument."},"base_volume":{"type":"number","format":"decimal","description":"The current base volume of the instrument."},"quote_volume":{"type":"number","format":"decimal","description":"The current quote volume of the instrument."}},"required":["base_id","quote_id","last_price","base_volume","quote_volume"]},"title":"TickerResponse"}}}}
```

## The OrderBookRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"OrderBookRequest":{"type":"object","properties":{"Market_Pair":{"type":"string","description":"The instrument symbol, instrument id is not accepted."},"Depth":{"type":"integer","description":"Depth of the orderbook you want to see, this only applicable if **Level** parameter is set to 2. Depth will always be 1 if this is not set or if Level is set to 1."},"Level":{"type":"integer","enum":[1,2],"default":1,"description":"One of: 1, 2. 1 mean you only want to see the best bid and best ask, 2 means you want to see other levels of the book, number of bids and ask you will see depends on the **Depth** set, if **Depth** is not set and **Level** is set to 2, best bid and best ask will only be the ones to be returned. Default is 1."}},"required":["Market_Pair"],"title":"OrderBookRequest"}}}}
```

## The OrderBookResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"OrderBookResponse":{"type":"object","properties":{"timestamp":{"type":"integer","format":"int64","description":"Unix timestamp in milliseconds, equivalent to the current timestamp when the response was returned."},"bids":{"type":"array","items":{"type":"array","items":false,"prefixItems":[{"type":"number","format":"decimal","description":"The quantity per level which someone is willing to buy."},{"type":"number","format":"decimal","description":"The price per level which someone is willing to buy."}]}},"asks":{"type":"array","items":{"type":"array","items":false,"prefixItems":[{"type":"number","format":"decimal","description":"The quantity per level which someone is willing to sell."},{"type":"number","format":"decimal","description":"The price per level which someone is willing to sell."}]}}},"required":["timestamp","bids","asks"],"title":"OrderBookResponse"}}}}
```

## The TradesRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"TradesRequest":{"type":"object","properties":{"market_pair":{"type":"string","description":"The market pair or instrument symbol."}},"required":["market_pair"],"title":"TradesRequest"}}}}
```

## The TradesResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"TradesResponse":{"type":"object","properties":{"trade_id":{"type":"integer","description":"The ID of the trade execution."},"price":{"type":"number","format":"decimal","description":"The price at which the trade was executed."},"base_volume":{"type":"number","format":"decimal","description":"The traded quantity of the base product/currency."},"quote_volume":{"type":"number","format":"decimal","description":"The traded quantity of the quote product/currency."},"timestamp":{"type":"string","description":"The exact date and time when the trade was executed, in UTC."},"type":{"type":"string","enum":["buy","sell"],"description":"The side of the trade, One of: **buy**, **sell**."}},"required":["trade_id","price","base_volume","quote_volume","timestamp","type"],"title":"TradesResponse"}}}}
```

## The GetL2SnapshotRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetL2SnapshotRequest":{"type":"object","properties":{"OMSId":{"type":"integer","description":"The ID of the OMS."},"InstrumentId":{"type":"integer","description":"The ID of the instrument that is the subject of the snapshot."},"Depth":{"type":"integer","description":"Maximum number of bids and asks that can be included in the results. If set to 10, there can be maximum of 10 bids and 10 asks in the results."}},"required":["OMSId","InstrumentId","Depth"],"title":"GetL2SnapshotRequest"}}}}
```

## The GetL2SnapshotResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetL2SnapshotResponse":{"type":"array","items":false,"prefixItems":[{"type":"integer","description":"MDUpdateID. Market Data Update ID. This sequential ID identifies the order in which the update was created."},{"type":"integer","description":"Number of Unique Accounts. Number of accounts that placed orders."},{"type":"integer","format":"int64","description":"ActionDateTime. Identifies the time and date that the snapshot was taken or the event occurred, in POSIX format X 1000 (milliseconds since 1 January 1970)."},{"type":"string","description":"ActionType. L2 information provides price data. This value shows whether this data is:. **0** new. **1** update. **2** deletion."},{"type":"number","format":"decimal","description":"LastTradePrice. The price at which the instrument was last traded."},{"type":"integer","description":"Number of Orders. Number of orders in the GetL2Snapshot."},{"type":"number","format":"decimal","description":"Price. Bid or Ask price for the Quantity (see _Quantity_ below)."},{"type":"integer","description":"ProductPairCode. is the same value and used for the same purpose as _InstrumentID_. The two are completely equivalent. _InstrumentId_ 47 = _ProductPairCode_ 47."},{"type":"number","format":"decimal","description":"Quantity. Quantity available at a given Bid or Ask price (see _Price_ above)."},{"type":"integer","enum":[0,1,2,3],"description":"Side. One of: **0** Buy means it is on the bid side, **1** Sell means it is on the ask side, **2** Short (reserved for future use), **3** Unknown (an error condition)."}],"title":"GetL2SnapshotResponse"}}}}
```

## The GetLevel1Request object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetLevel1Request":{"type":"object","properties":{"OMSId":{"type":"integer","description":"The ID of the OMS."},"InstrumentId":{"type":"integer","description":"The ID of the instrument whose Level 1 market snapshot will be taken."}},"required":["OMSId","InstrumentId"],"title":"GetLevel1Request"}}}}
```

## The GetLevel1Response object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetLevel1Response":{"type":"object","properties":{"OMSId":{"type":"integer","description":"The ID of the OMS."},"InstrumentId":{"type":"integer","description":"The ID of the instrument being tracked."},"BestBid":{"type":"number","format":"decimal","description":"The current best bid for the instrument."},"BestOffer":{"type":"number","format":"decimal","description":"The current best offer for the instrument."},"LastTradedPx":{"type":"number","format":"decimal","description":"The last-traded price for the instrument."},"LastTradedQty":{"type":"number","format":"decimal","description":"The last-traded quantity for the instrument."},"LastTradeTime":{"type":"integer","format":"int64","description":"The time of the last trade, in POSIX format."},"SessionOpen":{"type":"number","format":"decimal","description":"Opening price. In markets with openings and closings, this is the opening price for the current session; in 24-hour markets, it is the price as of UTC Midnight."},"SessionHigh":{"type":"number","format":"decimal","description":"Highest price during the trading day, either during a session with opening and closing prices or UTC midnight to UTC midnight."},"SessionLow":{"type":"number","format":"decimal","description":"Lowest price during the trading day, either during a session with opening and closing prices or UTC midnight to UTC midnight."},"SessionClose":{"type":"number","format":"decimal","description":"The closing price. In markets with openings and closings, this is the closing price for the current session; in 24-hour markets, it is the price as of UTC Midnight."},"Volume":{"type":"number","format":"decimal","description":"The last-traded quantity for the instrument, same value as LastTradedQty."},"CurrentDayVolume":{"type":"number","format":"decimal","description":"The unit volume of the instrument traded either during a session with openings and closings or in 24-hour markets, the period from UTC Midnight to UTC Midnight."},"CurrentDayNumTrades":{"type":"integer","description":"The number of trades during the current day, either during a session with openings and closings or in 24-hour markets, the period from UTC Midnight to UTC Midnight."},"CurrentDayPxChange":{"type":"number","format":"decimal","description":"Current day price change, either during a trading session or UTC Midnight to UTC midnight."},"CurrentNotional":{"type":"number","format":"decimal","description":"Current day quote volume - resets at UTC Midnight."},"Rolling24HrNotional":{"type":"number","format":"decimal","description":"Rolling 24 hours quote volume."},"Rolling24HrVolume":{"type":"number","format":"decimal","description":"Unit volume(quantity traded, in the product 1 or in the base currency denomination) of the instrument during the past 24 hours, regardless of time zone. Recalculates continuously."},"Rolling24HrNumTrades":{"type":"integer","description":"Number of trades during the past 24 hours, regardless of time zone. Recalculates continuously."},"Rolling24HrPxChange":{"type":"number","format":"decimal","description":"Price change during the past 24 hours, regardless of time zone. Recalculates continuously."},"TimeStamp":{"type":"string","description":"The time this information was provided, in POSIX format."},"BidQty":{"type":"number","format":"decimal","description":"The quantity currently being bid."},"AskQty":{"type":"number","format":"decimal","description":"The quantity currently being asked."},"BidOrderCt":{"type":"integer","description":"The count of bid orders."},"AskOrderCt":{"type":"integer","description":"The count of ask orders."},"Rolling24HrPxChangePercent":{"type":"number","format":"decimal","description":"Percent change in price during the past 24hours regardles of the timezone. Recalculates continuously."}},"required":["OMSId","InstrumentId","BestBid","BestOffer","LastTradedPx","LastTradedQty","LastTradeTime","SessionOpen","SessionHigh","SessionLow","SessionClose","Volume","CurrentDayVolume","CurrentDayNumTrades","CurrentDayPxChange","CurrentNotional","Rolling24HrNotional","Rolling24HrVolume","Rolling24HrNumTrades","Rolling24HrPxChange","TimeStamp","BidQty","AskQty","BidOrderCt","AskOrderCt","Rolling24HrPxChangePercent"],"title":"GetLevel1Response"}}}}
```

## The GetEnumsRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetEnumsRequest":{"type":"object","properties":{"Class":{"type":"string","description":"The class name. Since GetEnums is solely for Orders currently, the class name will always be **Order**."},"Property":{"type":"string","description":"The property name, since GetEnums is solely for Orders currently, property name will always be **OrderState**."},"Enums":{"type":"string","description":"The actual enum values for Orders..  **Name** - . The name of the order state enum..  **Description** - . The description of the order state enum..   - . The number of the order state enum."}},"required":["Class","Property","Enums"],"title":"GetEnumsRequest"}}}}
```

## The GetEnumsResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetEnumsResponse":{"type":"array","items":{"type":"object","properties":{"Class":{"type":"string","description":"The class name. Since GetEnums is solely for Orders currently, the class name will always be **Order**."},"Property":{"type":"string","description":"The property name, since GetEnums is solely for Orders currently, property name will always be **OrderState**."},"Enums":{"type":"object","description":"The actual enum values for Orders.","properties":{"Name":{"type":"string","description":"The name of the order state enum."},"Description":{"type":"string","description":"The description of the order state enum."},"Value":{"type":"integer","description":"The number of the order state enum."}}}},"required":["Class","Property","Enums"]},"title":"GetEnumsResponse"}}}}
```

## The GetUserAccountsRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetUserAccountsRequest":{"type":"object","properties":{"OMSId":{"type":"integer","description":"The ID of the OMS on which the user has one ore more accounts."},"UserId":{"type":"integer","description":"The ID of the user whose accounts you want to return. If not specified, the accounts of the user currently authenticated will be returned. A user with elevated permissions can specify any UserID and will be able to get the account/s owned by any user."}},"required":[],"title":"GetUserAccountsRequest"}}}}
```

## The GetUserAccountsResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetUserAccountsResponse":{"type":"array","description":"A list of account IDs associated to the user.","items":{"type":"integer"},"title":"GetUserAccountsResponse"}}}}
```

## The GetUserDevicesRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetUserDevicesRequest":{"type":"object","properties":{"UserId":{"type":"integer","description":"The ID of the user for whose registered device/s will be returned. If not, the registered devices of the authenticated user will be returned."}},"required":[],"title":"GetUserDevicesRequest"}}}}
```

## The GetUserDevicesResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetUserDevicesResponse":{"type":"object","properties":{"HashCode":{"type":"integer","description":"A unique code that identifies the user registered device."},"Location":{"type":"string","description":"Defaults to empty string, for future provision."},"DeviceName":{"type":"string","description":"The name of the device."},"IpAddress":{"type":"string","description":"The IpAddress from where the user registered the device."},"UserId":{"type":"integer","description":"The ID of the user who owns the device."},"IsTrusted":{"type":"boolean","description":"If true the device is trusted, which means the user has confirmed it, otherwise it is false."},"ExpirationTime":{"type":"integer","format":"int64","description":"The date and time up to when the device will be trusted. In **ticks** format."}},"required":["HashCode","Location","DeviceName","IpAddress","UserId","IsTrusted","ExpirationTime"],"title":"GetUserDevicesResponse"}}}}
```

## The GetBanksRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetBanksRequest":{"type":"object","properties":{"country":{"type":"string","description":"Country code in ISO 3166-1 alpha-2 format."},"page":{"type":"string","default":1,"description":"Page number. Default is _1_."},"page_size":{"type":"string","default":10,"description":"Number of elements per page. Default is _10_."}},"required":["country"],"title":"GetBanksRequest"}}}}
```

## The GetBanksResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetBanksResponse":{"type":"object","properties":{"status":{"type":"string","enum":["success"]},"total":{"type":"integer","description":"Number of entries in the response."},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"UUID","description":"The identifier of the bank."},"name":{"type":"string","description":"The name of the bank."},"country":{"type":"string","description":"Country code in ISO 3166-1 alpha-2 format."}},"required":["country"]}}},"required":["status","total","data"],"title":"GetBanksResponse"}}}}
```

## The GetProvincesRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetProvincesRequest":{"type":"object","properties":{"country":{"type":"string","description":"Country code in ISO 3166-1 alpha-2 format."}},"required":["country"],"title":"GetProvincesRequest"}}}}
```

## The GetProvincesResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetProvincesResponse":{"type":"object","properties":{"status":{"type":"string","enum":["success"]},"data":{"type":"array","items":{"type":"array","items":false,"prefixItems":[{"type":"string","description":"Province code."},{"type":"string","description":"Province name."}]}}},"required":["status","data"],"title":"GetProvincesResponse"}}}}
```

## The GetBankDepositAccountsResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetBankDepositAccountsResponse":{"type":"object","properties":{"status":{"type":"string","enum":["success"]},"data":{"type":"array","anyOf":[{"$ref":"#/components/schemas/GeneralBankDeposit"},{"$ref":"#/components/schemas/PreviewGeneralBankDeposit"},{"$ref":"#/components/schemas/PreviewVirtualOrFboBankDeposit"}]}},"required":["status","data"],"title":null},"GeneralBankDeposit":{"type":"object","properties":{"id":{"type":"string","format":"UUID","description":"Unique identifier."},"currency":{"type":"string","description":"Bank account currency."},"bank":{"type":"string","description":"Bank name."},"identity_number":{"type":"string","description":"Identity number."},"identity_type":{"type":"string","description":"Identity type. Options: RUT, CUIT, CNPJ, and RUC."},"company_name":{"type":"string","description":"Company name."},"account_type":{"type":"string","description":"Account type. Options: checking account, virtual account, legal entity, and electronic money account."},"account_number":{"type":"string","description":"Account number."},"agency":{"type":"string","description":"Account branch/agency. May be null."},"email":{"type":"string","description":"Account email address."},"created_at":{"type":"string","description":"Creation date."},"updated_at":{"type":"string","description":"Last update date."}},"required":["id","currency","bank","identity_number","identity_type","company_name","account_type","account_number","email","created_at","updated_at"],"title":"GeneralBankDeposit"},"PreviewGeneralBankDeposit":{"type":"object","properties":{"id":{"type":"string","format":"UUID","description":"Unique identifier."},"type":{"type":"string","description":"Bank account type. Value: **general**."},"currency":{"type":"string","description":"Bank account currency."},"bank":{"type":"string","description":"Bank name."},"identity_number":{"type":"string","description":"Identity number."},"identity_type":{"type":"string","description":"Identity type. Options: RUT, CUIT, CNPJ, and RUC."},"company_name":{"type":"string","description":"Company name."},"account_type":{"type":"string","description":"Account type. Options: checking account, virtual account, legal entity, and electronic money account."},"account_number":{"type":"string","description":"Account number."},"account_alias":{"type":"string","description":"Account alias. **nullable**."},"agency":{"type":"string","description":"Account branch/agency. May be null."},"email":{"type":"string","description":"Account email address."},"created_at":{"type":"string","description":"Creation date."},"updated_at":{"type":"string","description":"Last update date."}},"required":["id","type","currency","bank","identity_number","identity_type","company_name","account_type","account_number","email","created_at","updated_at"],"title":"PreviewGeneralBankDeposit"},"PreviewVirtualOrFboBankDeposit":{"type":"object","properties":{"id":{"type":"string","format":"UUID","description":"Unique identifier."},"type":{"type":"string","description":"Bank account type. Values: **virtual** or **fbo**."},"currency":{"type":"string","description":"Bank account currency."},"account_type":{"type":"string","description":"Account type. Options: **cvu**, **ach**, **swift** or **fedwire**."},"account_number":{"type":"string","description":"Account number."},"account_alias":{"type":"string","description":"Account alias. **nullable**."},"beneficiary":{"type":"object","description":"Bank account beneficiary. **nullable**.","properties":{"name":{"type":"string","description":"Name of beneficiary. Only if **account_type** is **ach**, **swift** or **fedwire**."},"address":{"type":"string","description":"Address of beneficiary. Only if **account_type** is **ach**, **swift** or **fedwire**."},"account_number":{"type":"string","description":"Account number of beneficiary. Only if **account_type** is **ach**, **swift** or **fedwire**."},"bank":{"type":"object","properties":{"name":{"type":"string","description":"Name of the beneficiary's bank. Only if **account_type** is **ach**, **swift** or **fedwire**."},"swift":{"type":"string","description":"Beneficiary bank's SWIFT code. Only if **account_type** is **ach**, **swift** or **fedwire**."},"routing_number":{"type":"string","description":"Beneficiary bank's routing number. Only if **account_type** is **ach**, **swift** or **fedwire**."}},"required":["name","swift","routing_number"]}},"required":["name","address","account_number","bank"]},"intermediary_bank":{"type":"object","description":"Beneficiary's intermediary bank. **nullable**.","properties":{"name":{"type":"string","description":"Name of the beneficiary's intermediary bank. Only if **account_type** is **ach**, **swift** or **fedwire**."},"routing_number":{"type":"string","description":"Routing number of the beneficiary's intermediary bank. Only if **account_type** is **ach**, **swift** or **fedwire**."},"bic_code":{"type":"string","description":"BIC code of the beneficiary's intermediary bank. Only if **account_type** is **ach**, **swift** or **fedwire**."}},"required":["name","routing_number","bic_code"]},"created_at":{"type":"string","description":"Creation date."},"updated_at":{"type":"string","description":"Last update date."}},"required":["id","type","currency","account_type","account_number","created_at","updated_at"],"title":"PreviewVirtualOrFboBankDeposit"}}}}
```

## The GeneralBankDeposit object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GeneralBankDeposit":{"type":"object","properties":{"id":{"type":"string","format":"UUID","description":"Unique identifier."},"currency":{"type":"string","description":"Bank account currency."},"bank":{"type":"string","description":"Bank name."},"identity_number":{"type":"string","description":"Identity number."},"identity_type":{"type":"string","description":"Identity type. Options: RUT, CUIT, CNPJ, and RUC."},"company_name":{"type":"string","description":"Company name."},"account_type":{"type":"string","description":"Account type. Options: checking account, virtual account, legal entity, and electronic money account."},"account_number":{"type":"string","description":"Account number."},"agency":{"type":"string","description":"Account branch/agency. May be null."},"email":{"type":"string","description":"Account email address."},"created_at":{"type":"string","description":"Creation date."},"updated_at":{"type":"string","description":"Last update date."}},"required":["id","currency","bank","identity_number","identity_type","company_name","account_type","account_number","email","created_at","updated_at"],"title":"GeneralBankDeposit"}}}}
```

## The PreviewGeneralBankDeposit object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"PreviewGeneralBankDeposit":{"type":"object","properties":{"id":{"type":"string","format":"UUID","description":"Unique identifier."},"type":{"type":"string","description":"Bank account type. Value: **general**."},"currency":{"type":"string","description":"Bank account currency."},"bank":{"type":"string","description":"Bank name."},"identity_number":{"type":"string","description":"Identity number."},"identity_type":{"type":"string","description":"Identity type. Options: RUT, CUIT, CNPJ, and RUC."},"company_name":{"type":"string","description":"Company name."},"account_type":{"type":"string","description":"Account type. Options: checking account, virtual account, legal entity, and electronic money account."},"account_number":{"type":"string","description":"Account number."},"account_alias":{"type":"string","description":"Account alias. **nullable**."},"agency":{"type":"string","description":"Account branch/agency. May be null."},"email":{"type":"string","description":"Account email address."},"created_at":{"type":"string","description":"Creation date."},"updated_at":{"type":"string","description":"Last update date."}},"required":["id","type","currency","bank","identity_number","identity_type","company_name","account_type","account_number","email","created_at","updated_at"],"title":"PreviewGeneralBankDeposit"}}}}
```

## The PreviewVirtualOrFboBankDeposit object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"PreviewVirtualOrFboBankDeposit":{"type":"object","properties":{"id":{"type":"string","format":"UUID","description":"Unique identifier."},"type":{"type":"string","description":"Bank account type. Values: **virtual** or **fbo**."},"currency":{"type":"string","description":"Bank account currency."},"account_type":{"type":"string","description":"Account type. Options: **cvu**, **ach**, **swift** or **fedwire**."},"account_number":{"type":"string","description":"Account number."},"account_alias":{"type":"string","description":"Account alias. **nullable**."},"beneficiary":{"type":"object","description":"Bank account beneficiary. **nullable**.","properties":{"name":{"type":"string","description":"Name of beneficiary. Only if **account_type** is **ach**, **swift** or **fedwire**."},"address":{"type":"string","description":"Address of beneficiary. Only if **account_type** is **ach**, **swift** or **fedwire**."},"account_number":{"type":"string","description":"Account number of beneficiary. Only if **account_type** is **ach**, **swift** or **fedwire**."},"bank":{"type":"object","properties":{"name":{"type":"string","description":"Name of the beneficiary's bank. Only if **account_type** is **ach**, **swift** or **fedwire**."},"swift":{"type":"string","description":"Beneficiary bank's SWIFT code. Only if **account_type** is **ach**, **swift** or **fedwire**."},"routing_number":{"type":"string","description":"Beneficiary bank's routing number. Only if **account_type** is **ach**, **swift** or **fedwire**."}},"required":["name","swift","routing_number"]}},"required":["name","address","account_number","bank"]},"intermediary_bank":{"type":"object","description":"Beneficiary's intermediary bank. **nullable**.","properties":{"name":{"type":"string","description":"Name of the beneficiary's intermediary bank. Only if **account_type** is **ach**, **swift** or **fedwire**."},"routing_number":{"type":"string","description":"Routing number of the beneficiary's intermediary bank. Only if **account_type** is **ach**, **swift** or **fedwire**."},"bic_code":{"type":"string","description":"BIC code of the beneficiary's intermediary bank. Only if **account_type** is **ach**, **swift** or **fedwire**."}},"required":["name","routing_number","bic_code"]},"created_at":{"type":"string","description":"Creation date."},"updated_at":{"type":"string","description":"Last update date."}},"required":["id","type","currency","account_type","account_number","created_at","updated_at"],"title":"PreviewVirtualOrFboBankDeposit"}}}}
```

## The CreateBankDepositAccountRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"CreateBankDepositAccountRequest":{"type":"object","properties":{"currency":{"type":"string","description":"Currency identifier. Standard ISO 4217."},"type":{"type":"string","enum":["virtual","fbo"],"description":"Account type."},"account_number":{"type":"string","description":"Account number. Required for accounts of type **virtual** and currency **COP**."},"w8ben":{"type":"binary","description":"W8BEN form. Download at [link](https://www.irs.gov/pub/irs-pdf/fw8ben.pdf). Required for accounts of type **fob** and currency **USD**."},"source_funds":{"type":"array","items":{"type":"string","enum":["income","investments","sale_of_assets","retirement_funds","inheritance_gift","savings","loan_proceeds","legal_settlement","other"]},"description":"Source of funds"}},"required":["currency","type"],"title":"CreateBankDepositAccount"}}}}
```

## The CreateBankDepositAccountResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"CreateBankDepositAccountResponse":{"type":"object","properties":{"status":{"type":"string","enum":["success","error"]},"message":{"type":"string"}},"required":["status","message"],"title":"CreateBankDepositAccount"}}}}
```

## The AddClientBankAccountRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"AddClientBankAccountRequest":{"type":"object","properties":{"country":{"type":"string","enum":["AR","BR","CL","PE","CO"],"description":"Country code in ISO 3166-1 alpha-2 format. One of: AR, BR, CL, PE, CO."},"bank":{"type":"string","description":"Bank identifier."},"number":{"type":"string","description":"Bank account number."},"kind":{"type":"string","description":"Bank account type.. 1. If _country_ is **AR**, the options are: <br> - corriente<br> - vista<br> - ahorro<br> - electronic_checkbook<br> - ar_cbu<br> - ar_cvu<br> - ar_alia <br>2. If _country_ is **BR**, the options are: <br> - br_corriente_fisica<br> - br_simple_fisica<br> - br_corriente_juridica<br> - br_poupanca_fisica<br> - br_poupanca_juridica<br> - br_caixa_facil<br> - br_pix<br>3. If _country_ is **CL**, the options are: <br> - corriente<br> - vista<br> - ahorro<br> - electronic_checkbook<br>4. If _country_ is **PE**, the options are: <br> - corriente<br> - ahorro<br>5. If _country_ is **CO**, the options are: <br> - corriente<br> - ahorro<br>."},"pix_type":{"type":"string","description":"PIX account type. Only required if _country_ is **BR** and _kind_ is **br_pix**. Options are: <br> - CPF<br> - CNPJ<br> - Email<br> - Phone<br> - Otro<br>."},"agency":{"type":"string","description":"Bank account agency. Only required if _country_ is **BR**."},"dv":{"type":"string","description":"Bank account verification digit. Only required if  _country_ is **BR**."},"province":{"type":"string","description":"Province of the bank account. Only required if _country_ is **PE**."},"user_id":{"type":"string","description":"If the process is being made for a managed user, then this is the user id of the managed user."}},"required":["country","bank","number","kind","pix_type","agency","dv","province"],"title":"AddClientBankAccountRequest"}}}}
```

## The AddClientBankAccountResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"AddClientBankAccountResponse":{"type":"object","properties":{"status":{"type":"string","enum":["success"]},"data":{"type":"object","properties":{"id":{"type":"string","format":"UUID","description":"Bank account identifier."},"country":{"type":"string","enum":["AR","BR","CL","PE","CO"],"description":"Country code in ISO 3166-1 alpha-2 format. One of: AR, BR, CL, PE, CO."},"bank":{"type":"object","properties":{"id":{"type":"string","format":"UUID","description":"The identifier of the bank."},"name":{"type":"string","description":"The name of the bank."},"country":{"type":"string","description":"Country code in ISO 3166-1 alpha-2 format."}},"required":["id","name","country"]},"number":{"type":"string","description":"Bank account number."},"kind":{"type":"string","description":"Bank account type. If _country_ is **AR**, the options are: corriente, vista, ahorro, electronic_checkbook, ar_cbu, ar_cvu, ar_alia. If _country_ is **BR**, the options are: br_corriente_fisica, br_simple_fisica, br_corriente_juridica, br_poupanca_fisica, br_poupanca_juridica, br_caixa_facil, br_pix. If _country_ is **CL**, the options are: corriente, vista, ahorro, electronic_checkbook. If _country_ is **PE**, the options are: corriente, ahorro. If _country_ is **CO**, the options are: corriente, ahorro."},"currency":{"type":"string","description":"The currency of the bank account."},"agency":{"type":"string","description":"Bank account agency. May be null."},"dv":{"type":"string","description":"Bank account verification digit. May be null."},"province":{"type":"string","description":"Province of the bank account. May be null."},"pix_type":{"type":"string","description":"PIX account type. One of: CPF, CNPJ, Email, Phone, Otro. May be null."}},"required":["id","country","bank","number","kind","currency","agency","dv","province","pix_type"]}},"required":["status","data"],"title":"AddClientBankAccountResponse"}}}}
```

## The GetClientBankAccountRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetClientBankAccountRequest":{"type":"object","properties":{"bank-account-id":{"type":"string","description":"Bank account identifier."},"user_id":{"type":"string","description":"If the process is being made for a managed user, then this is the user id of the managed user."}},"required":["bank-account-id"],"title":"GetClientBankAccountRequest"}}}}
```

## The GetClientBankAccountResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetClientBankAccountResponse":{"type":"object","properties":{"status":{"type":"string","enum":["success"]},"data":{"type":"object","properties":{"id":{"type":"string","format":"UUID","description":"Bank account identifier."},"country":{"type":"string","enum":["AR","BR","CL","PE","CO"],"description":"Country code in ISO 3166-1 alpha-2 format. One of: AR, BR, CL, PE, CO."},"bank":{"type":"object","properties":{"id":{"type":"string","format":"UUID","description":"The identifier of the bank."},"name":{"type":"string","description":"The name of the bank."},"country":{"type":"string","description":"Country code in ISO 3166-1 alpha-2 format."}},"required":["id","name","country"]},"number":{"type":"string","description":"Bank account number."},"kind":{"type":"string","description":"Bank account type. If _country_ is **AR**, the options are: corriente, vista, ahorro, electronic_checkbook, ar_cbu, ar_cvu, ar_alia. If _country_ is **BR**, the options are: br_corriente_fisica, br_simple_fisica, br_corriente_juridica, br_poupanca_fisica, br_poupanca_juridica, br_caixa_facil, br_pix. If _country_ is **CL**, the options are: corriente, vista, ahorro, electronic_checkbook. If _country_ is **PE**, the options are: corriente, ahorro. If _country_ is **CO**, the options are: corriente, ahorro."},"currency":{"type":"string","description":"The currency of the bank account."},"agency":{"type":"string","description":"Bank account agency. May be null."},"dv":{"type":"string","description":"Bank account verification digit. May be null."},"province":{"type":"string","description":"Province of the bank account. May be null."},"pix_type":{"type":"string","description":"PIX account type. One of: CPF, CNPJ, Email, Phone, Otro. May be null."}},"required":["id","country","bank","number","kind","currency","agency","dv","province","pix_type"]}},"required":["status","data"],"title":"GetClientBankAccountResponse"}}}}
```

## The GetClientBankAccountsRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetClientBankAccountsRequest":{"type":"object","properties":{"page":{"type":"string","default":1,"description":"Page number. Default is _1_."},"page_size":{"type":"string","default":10,"description":"Number of elements per page. Default is _10_."},"user_id":{"type":"string","description":"If the process is being made for a managed user, then this is the user id of the managed user."}},"required":[],"title":"GetClientBankAccountsRequest"}}}}
```

## The GetClientBankAccountsResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetClientBankAccountsResponse":{"type":"object","properties":{"status":{"type":"string","enum":["success"]},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"UUID","description":"Bank account identifier."},"country":{"type":"string","enum":["AR","BR","CL","PE","CO"],"description":"Country code in ISO 3166-1 alpha-2 format. One of: AR, BR, CL, PE, CO."},"bank":{"type":"object","properties":{"id":{"type":"string","format":"UUID","description":"The identifier of the bank."},"name":{"type":"string","description":"The name of the bank."},"country":{"type":"string","description":"Country code in ISO 3166-1 alpha-2 format."}},"required":["id","name","country"]},"number":{"type":"string","description":"Bank account number."},"kind":{"type":"string","description":"Bank account type. If _country_ is **AR**, the options are: corriente, vista, ahorro, electronic_checkbook, ar_cbu, ar_cvu, ar_alia. If _country_ is **BR**, the options are: br_corriente_fisica, br_simple_fisica, br_corriente_juridica, br_poupanca_fisica, br_poupanca_juridica, br_caixa_facil, br_pix. If _country_ is **CL**, the options are: corriente, vista, ahorro, electronic_checkbook. If _country_ is **PE**, the options are: corriente, ahorro. If _country_ is **CO**, the options are: corriente, ahorro."},"currency":{"type":"string","description":"The currency of the bank account."},"agency":{"type":"string","description":"Bank account agency. May be null."},"dv":{"type":"string","description":"Bank account verification digit. May be null."},"province":{"type":"string","description":"Province of the bank account. May be null."},"pix_type":{"type":"string","description":"PIX account type. One of: CPF, CNPJ, Email, Phone, Otro. May be null."}},"required":["id","country","bank","number","kind","currency","agency","dv","province","pix_type"]}}},"required":["status","data"],"title":"GetClientBankAccountsResponse"}}}}
```

## The DeleteClientBankAccountRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"DeleteClientBankAccountRequest":{"type":"object","properties":{"bank-account-id":{"type":"string","description":"Bank account identifier."},"user_id":{"type":"string","description":"If the process is being made for a managed user, then this is the user id of the managed user."}},"required":["bank-account-id"],"title":"DeleteClientBankAccountRequest"}}}}
```

## The DeleteClientBankAccountResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"DeleteClientBankAccountResponse":{"type":"object","properties":{"status":{"type":"string","enum":["success"]}},"required":["status"],"title":"DeleteClientBankAccountResponse"}}}}
```

## The GetNetworksTemplatesRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetNetworksTemplatesRequest":{"type":"object","properties":{"currency":{"type":"string","description":"Currency (Product) identifier."},"network":{"type":"string","description":"Currency (Product) network identifier."}},"required":["currency"],"title":"GetNetworksTemplatesRequest"}}}}
```

## The GetNetworksTemplatesResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetNetworksTemplatesResponse":{"type":"object","properties":{"status":{"type":"string","enum":["success"]},"data":{"type":"array","items":{"type":"object","properties":{"currency":{"type":"string","description":"Currency (Product) identifier."},"network":{"type":"string","description":"Currency (Product) network identifier."},"network_name":{"type":"string","description":"Name of the currency (Product) network."},"network_protocol":{"type":"string","description":"Protocol of the currency (Product) network."},"template":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the template field."},"type":{"type":"string","description":"Type of the template field."},"required":{"type":"boolean","description":"Whether the template field is required."},"maxLength":{"type":"integer","description":"Maximum length of the template field."},"minLength":{"type":"integer","description":"Minimum length of the template field."},"decimalPlaces":{"type":"integer","description":"Number of decimal places for the template field."}},"required":["name","type","required"]}}},"required":["currency","network","network_name","network_protocol","template"]}}},"required":["status","data"],"title":"GetNetworksTemplatesResponse"}}}}
```

## The GetDepositAddressesRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetDepositAddressesRequest":{"type":"object","properties":{"account_id":{"type":"integer","description":"The account identifier."},"currency":{"type":"string","description":"Currency (Product) identifier."},"network":{"type":"string","description":"Currency (Product) network identifier."},"user_id":{"type":"string","description":"If the process is being made for a managed user, then this is the user id of the managed user."}},"required":["account_id","currency","network"],"title":"GetDepositAddressesRequest"}}}}
```

## The GetDepositAddressesResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetDepositAddressesResponse":{"type":"object","properties":{"status":{"type":"string","enum":["success"]},"data":{"type":"array","items":{"type":"string","description":"Deposit address."}}},"required":["status","data"],"title":"GetDepositAddressesResponse"}}}}
```

## The CreateDepositAddressRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"CreateDepositAddressRequest":{"type":"object","properties":{"account_id":{"type":"integer","description":"The account identifier."},"currency":{"type":"string","description":"Currency identifier."},"network":{"type":"string","description":"Currency network identifier."},"user_id":{"type":"string","description":"If the process is being made for a managed user, then this is the user id of the managed user."}},"required":["account_id","currency","network"],"title":"CreateDepositAddressRequest"}}}}
```

## The CreateDepositAddressResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"CreateDepositAddressResponse":{"type":"object","properties":{"status":{"type":"string","enum":["success"]},"data":{"type":"string","description":"The new deposit address."}},"required":["status","data"],"title":"CreateDepositAddressResponse"}}}}
```

## The GetWhitelistedAddressesRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetWhitelistedAddressesRequest":{"type":"object","properties":{"account_id":{"type":"integer","description":"The ID of the account for which whitelisted addresses were created."},"search":{"type":"string","description":"Filters the addresses by label, currency, or whitelisted address identifier."},"user_id":{"type":"string","description":"If the process is being made for a managed user, then this is the user id of the managed user."}},"required":["account_id"],"title":"GetWhitelistedAddressesRequest"}}}}
```

## The GetWhitelistedAddressesResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetWhitelistedAddressesResponse":{"type":"object","properties":{"status":{"type":"string","enum":["success"]},"data":{"type":"object","properties":{"id":{"type":"string","format":"UUID","description":"Whitelisted address identifier."},"currency":{"type":"string","description":"currency (Product) of the address."},"label":{"type":"string","description":"Name or description of the address."},"network":{"type":"string","description":"Address network."},"address":{"type":"string","description":"Address identifier."},"memo":{"type":"string","description":"Address memo or tag. May be null."},"verified":{"type":"boolean","description":"Whether the address has been verified."},"provider_id":{"type":"integer","description":"Identifier of the provider associated with the address."}},"required":["id","currency","label","network","address","verified","provider_id"]}},"required":["status","data"],"title":"GetWhitelistedAddressesResponse"}}}}
```

## The AddWhitelistedAddressRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"AddWhitelistedAddressRequest":{"type":"object","properties":{"account_id":{"type":"integer","description":"The ID of the account for which whitelisted addresses will be created."},"currency":{"type":"string","description":"Address currency identifier."},"network":{"type":"string","description":"Address network."},"address":{"type":"string","description":"Address identifier."},"label":{"type":"string","description":"Name or description of the address."},"memo_or_tag":{"type":"string","description":"Address memo or tag."},"otp":{"type":"string","description":"Two-step authentication code."},"user_id":{"type":"string","description":"If the process is being made for a managed user, then this is the user id of the managed user."}},"required":["account_id","currency","network","address","label","otp"],"title":"AddWhitelistedAddressRequest"}}}}
```

## The AddWhitelistedAddressResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"AddWhitelistedAddressResponse":{"type":"object","properties":{"status":{"type":"string","enum":["success"]},"data":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the address added to the whitelist."}},"required":["id"]}},"required":["status","data"],"title":"AddWhitelistedAddressResponse"}}}}
```

## The ConfirmWhitelistedAddressRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"ConfirmWhitelistedAddressRequest":{"type":"object","properties":{"whitelisted-address-id":{"type":"string","description":"Whitelisted address identifier."}},"required":["whitelisted-address-id"],"title":"ConfirmWhitelistedAddressRequest"}}}}
```

## The ConfirmWhitelistedAddressResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"ConfirmWhitelistedAddressResponse":{"type":"object","properties":{"status":{"type":"string","enum":["success"]}},"required":["status"],"title":"ConfirmWhitelistedAddressResponse"}}}}
```

## The ResendVerificationCodeWhitelistedAddressRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"ResendVerificationCodeWhitelistedAddressRequest":{"type":"object","properties":{"whitelisted-address-id":{"type":"string","description":"Whitelisted address identifier."}},"required":["whitelisted-address-id"],"title":"ResendVerificationCodeWhitelistedAddressRequest"}}}}
```

## The ResendVerificationCodeWhitelistedAddressResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"ResendVerificationCodeWhitelistedAddressResponse":{"type":"object","properties":{"status":{"type":"string","enum":["success"]}},"required":["status"],"title":"ResendVerificationCodeWhitelistedAddressResponse"}}}}
```

## The DeleteWhitelistedAddressRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"DeleteWhitelistedAddressRequest":{"type":"object","properties":{"whitelisted-address-id":{"type":"string","description":"Whitelisted address identifier."}},"required":["whitelisted-address-id"],"title":"DeleteWhitelistedAddressRequest"}}}}
```

## The DeleteWhitelistedAddressResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"DeleteWhitelistedAddressResponse":{"type":"object","properties":{"status":{"type":"string","enum":["success"]}},"required":["status"],"title":"DeleteWhitelistedAddressResponse"}}}}
```

## The UpdateOneStepWithdrawRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"UpdateOneStepWithdrawRequest":{"type":"object","properties":{"account_id":{"type":"integer","description":"The account identifier."},"action":{"type":"string","enum":["enable","disable"],"description":"Action to configure. One of: **enable**, **disable**."},"otp":{"type":"string","description":"Two-step authentication code."},"user_id":{"type":"string","description":"If the process is being made for a managed user, then this is the user id of the managed user."}},"required":["account_id","action","otp"],"title":"UpdateOneStepWithdrawRequest"}}}}
```

## The UpdateOneStepWithdrawResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"UpdateOneStepWithdrawResponse":{"type":"object","properties":{"status":{"type":"string","enum":["success"]}},"required":["status"],"title":"UpdateOneStepWithdrawResponse"}}}}
```

## The CreateCryptoWithdrawRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"CreateCryptoWithdrawRequest":{"type":"object","properties":{"account_id":{"type":"integer","description":"The ID of the account."},"currency":{"type":"string","description":"Currency identifier."},"network":{"type":"string","description":"Network identifier."},"address":{"type":"string","description":"Destination address."},"amount":{"oneOf":[{"type":"number"},{"type":"string"}],"description":"**string or number**. Withdrawal amount."},"memo_or_tag":{"type":"string","description":"Memo or tag of the destination address."},"otp":{"type":"string","description":"Two-step authentication code."},"user_id":{"type":"string","description":"If the process is being made for a managed user, then this is the user id of the managed user."}},"required":["account_id","currency","network","address","amount","memo_or_tag","otp"],"title":"CreateCryptoWithdrawRequest"}}}}
```

## The CreateCryptoWithdrawResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"CreateCryptoWithdrawResponse":{"type":"object","properties":{"status":{"type":"string","enum":["success"]},"data":{"type":"string","description":"The identifier of the created withdrawal."}},"required":["status","data"],"title":"CreateCryptoWithdrawResponse"}}}}
```

## The CreateFiatDepositRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"CreateFiatDepositRequest":{"type":"object","properties":{"account_id":{"type":"integer","description":"Account identifier."},"payment_method":{"type":"integer","enum":[1,2],"description":"Deposit payment method. One of: **1** (Bank transfer), **2** (Webpay, only for **CLP**)."},"currency":{"type":"string","enum":["ARS","BRL","CLP","COP","PEN"],"description":"Currency of the deposit. One of: **ARS**, **BRL**, **CLP**, **COP**, **PEN**."},"amount":{"oneOf":[{"type":"number"},{"type":"string"}],"description":"**string or number**. Deposit amount."},"bank_account_id":{"type":"string","description":"Bank account identifier. Only required if _payment_method_ is **1**."},"voucher":{"type":"string","format":"binary","description":"Proof of deposit. Only required if _payment_method_ is **1** and _currency_ is **PEN**."},"user_id":{"type":"string","description":"If the process is being made for a managed user, then this is the user id of the managed user."}},"required":["account_id","payment_method","currency","amount","bank_account_id","voucher"],"title":"CreateFiatDepositRequest"}}}}
```

## The CreateFiatDepositResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"CreateFiatDepositResponse":{"type":"object","properties":{"status":{"type":"string","enum":["success"]},"message":{"type":"string","description":"result of the deposit."},"data":{"type":"object","properties":{"url":{"type":"string","description":"URL to make the deposit."}},"required":["url"]}},"required":["status"],"title":"CreateFiatDepositResponse"}}}}
```

## The GetOwnersFiatWithdrawRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetOwnersFiatWithdrawRequest":{"type":"object","properties":{"cbu":{"type":"string","description":"CBU account number to obtain the account owners."}},"required":["cbu"],"title":"GetOwnersFiatWithdrawRequest"}}}}
```

## The GetOwnersFiatWithdrawResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetOwnersFiatWithdrawResponse":{"type":"object","properties":{"status":{"type":"string","enum":["success"]},"data":{"type":"array","items":{"type":"object","properties":{"person_type":{"type":"string","enum":["F","J"],"description":"Person type. One of: F (natural person), J (juridical person)."},"cuit":{"type":"string","description":"CUIT number of the person."},"name":{"type":"string","description":"Name of the person."}},"required":["person_type","cuit","name"]}}},"required":["status","data"],"title":"GetOwnersFiatWithdrawResponse"}}}}
```

## The CreateFiatWithdrawRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"CreateFiatWithdrawRequest":{"type":"object","properties":{"account_id":{"type":"integer","description":"Account identifier."},"payment_method":{"type":"integer","enum":[1],"description":"Deposit payment method. One of: **1** (Bank transfer)."},"currency":{"type":"string","enum":["ARS","BRL","CLP","COP","PEN"],"description":"Currency of the deposit. One of: **ARS**, **BRL**, **CLP**, **COP**, **PEN**."},"amount":{"oneOf":[{"type":"number"},{"type":"string"}],"description":"**string or number**. Deposit amount."},"bank_account_id":{"type":"string","description":"Bank account identifier. Only required if _payment_method_ is **1**."},"cbu":{"type":"string","description":"Destination account CBU. Only required if _currency_ is **ARS**."},"person_type":{"type":"string","description":"Type of person who owns the destination account. Only required if _currency_ is **ARS**."},"cuit":{"type":"string","description":"CUIT of the person who owns the destination account. Only required if the _currency_ is **ARS**."},"name":{"type":"string","description":"Name of the person who owns the destination account. Only required if the _currency_ is **ARS**."},"user_id":{"type":"string","description":"If the process is being made for a managed user, then this is the user id of the managed user."}},"required":["account_id","payment_method","currency","amount","bank_account_id","cbu","person_type","cuit","name"],"title":"CreateFiatWithdrawRequest"}}}}
```

## The CreateFiatWithdrawResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"CreateFiatWithdrawResponse":{"type":"object","properties":{"status":{"type":"string","enum":["success"]},"message":{"type":"string","description":"Result of the withdrawal request."},"data":{"type":"object","properties":{"withdrawal_id":{"type":"string","description":"Withdrawal request identifier."}},"required":["withdrawal_id"]}},"required":["status"],"title":"CreateFiatWithdrawResponse"}}}}
```

## The ConfirmFiatWithdrawRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"ConfirmFiatWithdrawRequest":{"type":"object","properties":{"withdrawal_id":{"type":"string","description":"Withdrawal request identifier."}},"required":["withdrawal_id"],"title":"ConfirmFiatWithdrawRequest"}}}}
```

## The ConfirmFiatWithdrawResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"ConfirmFiatWithdrawResponse":{"type":"object","properties":{"status":{"type":"string","enum":["success"]},"message":{"type":"string","description":"Result of the withdrawal confirmation."}},"required":["status","message"],"title":"ConfirmFiatWithdrawResponse"}}}}
```

## The TransferFundsRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"TransferFundsRequest":{"type":"object","properties":{"sender_account_id":{"type":"integer","description":"The source account identifier."},"receiver_account_id":{"type":"integer","description":"The destination account identifier."},"currency_name":{"type":"string","description":"Name of the currency."},"amount":{"oneOf":[{"type":"number"},{"type":"string"}],"description":"**string or number**. Amount to transfer."},"notes":{"type":"string","description":"Description of the transfer."},"otp":{"type":"string","description":"Two-step authentication code."},"user_id":{"type":"string","description":"If the process is being made for a managed user, then this is the user id of the managed user."}},"required":["sender_account_id","receiver_account_id","currency_name","amount","otp"],"title":"TransferFundsRequest"}}}}
```

## The TransferFundsResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"TransferFundsResponse":{"type":"object","properties":{"status":{"type":"string","enum":["success"]},"data":{"type":"string","description":"The identifier of the created transfer."}},"required":["status","data"],"title":"TransferFundsResponse"}}}}
```

## The GetTransactionsRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetTransactionsRequest":{"type":"object","properties":{"from_date":{"type":"string","description":"The oldest date from which the transaction history will begin. The supported format is DD/MM/YYYY."},"to_date":{"type":"string","description":"The most recent date on which the transaction history will end. The supported format is DD/MM/YYYY."},"sort":{"type":"string","enum":["ASC","DESC"],"default":"DESC","description":"History sorting. One of: **ASC**, **DESC**. Default is **DESC**."},"currency":{"type":"string","description":"Transaction history currency."},"page":{"type":"integer","default":1,"description":"Page numbre of the transaction history. Default is _1_."},"page_size":{"type":"integer","default":10,"description":"Number of transactions per page. Default is _10_."},"user_id":{"type":"string","description":"If the process is being made for a managed user, then this is the user id of the managed user."},"account_id":{"type":"string","description":"Can be used to filter results. If set, only transactions for the specific account id will be returned, else, all transactions regardless of the account (of the user) will be returned."},"type":{"type":"integer","enum":[0,1,2,3,4,5,6,7,8,9,10,11,12],"description":"Can be used to filter results. If set, only transactions with the specific type specified will be returned, else, all transactions regardless of the type will be returned. One of: **0** OTHER, **1** DEPOSIT, **2** WITHDRAW, **3** TRANSFER, **4** TRADE, **5** PAYMENT, **6** RECTIFICATION, **7** FEE, **8** REVERSE, **9** HOLD, **10** MARGIN, **11** AIRDROP, **12** DISTRIBUTION."},"sub_type":{"type":"integer","enum":[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16],"description":"Can be used to filter results. If set, only transactions with the specific sub type specified will be returned, else, all transactions regardless of the sub type will be returned. One of: **0** OTHER, **1** PAYOUT, **2** PAYIN, **3** DEPOSIT, **4** WITHDRAW, **5** BANK_TO_EXCHANGE, **6** EXCHANGE_TO_BANK, **7** TRADE, **8** PAYMENT, **9** SIMPLE, **10** RECTIFICATION, **11** TRANSFER, **12** HOLD, **13** MARGIN, **14** AIRDROP, **15** ORDER, **16** DISTRIBUTION_ENTRY."}},"required":[],"title":"GetTransactionsRequest"}}}}
```

## The GetTransactionsResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetTransactionsResponse":{"type":"object","properties":{"status":{"type":"string","enum":["success"]},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"Transaction identifier."},"legacy_id":{"type":"string","description":"Legacy transaction identifier."},"currency":{"type":"string","description":"Transaction currency."},"direction":{"type":"integer","enum":[1,2,0],"description":"Transaction direction. One of: **1** Income, **2** Outgoing, **0** Other."},"amount":{"type":"string","description":"Transaction amount."},"fee":{"type":"string","description":"Transaction fee."},"balance":{"type":"string","description":"Balance recorded after the transaction."},"address":{"type":"string","description":"Wallet address associated with the transaction."},"hash":{"type":"string","description":"Hash associated with the transaction."},"type":{"type":"integer","enum":[0,1,2,3,4,5,6],"description":"Transaction type. One of: **0** Other, **1** Deposit, **2** Withdrawal, **3** Transfer, **4** Trade, **5** Payment, **6** Correction."},"sub_type":{"type":"integer","enum":[0,1,2,3,4,5,6,7,8,9,10],"description":"Transaction type. One of: **0** Other, **1** Payout, **2** Payin, **3** Deposit, **4** Withdrawal, **5** Wallet to Exchange, **6** Exchange to Wallet, **7** Trade, **8** Payment, **9** Simple, **10** Correction."},"status":{"type":"integer","enum":[0,1,2,3,4,5],"description":"Transaction status. One of: **0** Other, **1** Created, **2** Pending, **3** Success, **4** Failed, **5** Reversed."},"created_at":{"type":"string","description":"Transaction creation date. ISO-8601 format."},"updated_at":{"type":"string","description":"Date of the last transaction update. ISO-8601 format."}},"required":["id","legacy_id","currency","direction","amount","fee","balance","address","hash","type","sub_type","status","created_at","updated_at"]}}},"required":["status","data"],"title":"GetTransactionsResponse"}}}}
```

## The GetQuotesRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetQuotesRequest":{"type":"object","properties":{"mode":{"type":"string","enum":["direct","inverse"],"description":"Simple operation mode. One of: **direct**, **inverse**."},"user_id":{"type":"string","description":"If the process is being made for a managed user, then this is the user id of the managed user."}},"required":[],"title":"GetQuotesRequest"}}}}
```

## The GetQuotesResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetQuotesResponse":{"type":"object","properties":{"status":{"type":"string","enum":["success"]},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Operation identifier."},"is_inverse":{"type":"boolean","description":"Indicates whether it is a inverse operation."},"type":{"type":"integer","enum":[1,2,3],"description":"Transaction type. One of: **1** Buy, **2** Sell, **3** Conversion."},"state":{"type":"integer","enum":[0,1,3,4,5,6],"description":"Transaction status. One of: **0** Pending, **1** Executed, **3** Insufficient Balance, **4** Not Executed, **5** Other, **6** Expired."},"currency_in":{"type":"string","description":"Input currency of the operation."},"currency_out":{"type":"string","description":"Output currency of the operation."},"amount_in":{"type":"string","description":"Input amount of the operation."},"amount_out":{"type":"string","description":"Output amount of the operation."},"amount_usdt_out":{"type":"string","description":"Output amount in USDT of the operation."},"fee_amount":{"type":"string","description":"Operation fee."},"fee_detail":{"type":"string","description":"Detail of the transaction fee."},"user_id":{"type":"string","description":"If the process is being made for a managed user, then this is the user id of the managed user."}},"required":["id","is_inverse","type","state","currency_in","currency_out","amount_in","amount_out","amount_usdt_out","fee_amount","fee_detail"]}}},"required":["status","data"],"title":"GetQuotesResponse"}}}}
```

## The CreateDirectQuoteRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"CreateDirectQuoteRequest":{"type":"object","properties":{"account_id":{"type":"integer","description":"The ID of the account."},"from_currency":{"type":"string","description":"Input currency."},"from_amount":{"oneOf":[{"type":"number"},{"type":"string"}],"description":"**string or number**. Amount of the transaction."},"to_currency":{"type":"string","description":"Output currency."},"operation":{"type":"string","enum":["Buy","Sell","Conversion"],"description":"Transaction type. One of: 1 Buy, 2 Sell, 3 Conversion."},"user_id":{"type":"string","description":"If the process is being made for a managed user, then this is the user id of the managed user."}},"required":["account_id","from_currency","from_amount","to_currency","operation"],"title":"CreateDirectQuoteRequest"}}}}
```

## The CreateDirectQuoteResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"CreateDirectQuoteResponse":{"type":"object","properties":{"status":{"type":"string","enum":["success"]},"data":{"type":"object","properties":{"id":{"type":"string","description":"The identifier of the created quote."}},"required":["id"]}},"required":["status","data"],"title":"CreateDirectQuoteResponse"}}}}
```

## The CreateInverseQuoteRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"CreateInverseQuoteRequest":{"type":"object","properties":{"account_id":{"type":"integer","description":"The ID of the account."},"from_currency":{"type":"string","description":"Input currency."},"to_currency":{"type":"string","description":"Output currency."},"to_amount":{"oneOf":[{"type":"number"},{"type":"string"}],"description":"**string or number**. Amount of the transaction."},"user_id":{"type":"string","description":"If the process is being made for a managed user, then this is the user id of the managed user."}},"required":["account_id","from_currency","to_currency","to_amount"],"title":"CreateInverseQuoteRequest"}}}}
```

## The CreateInverseQuoteResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"CreateInverseQuoteResponse":{"type":"object","properties":{"status":{"type":"string","enum":["success"]},"data":{"type":"object","properties":{"id":{"type":"string","description":"The identifier of the created quote."}},"required":["id"]}},"required":["status","data"],"title":"CreateInverseQuoteResponse"}}}}
```

## The GetQuoteRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetQuoteRequest":{"type":"object","properties":{"quote_id":{"type":"string","description":"The Simple operation identifier."},"user_id":{"type":"string","description":"If the process is being made for a managed user, then this is the user id of the managed user."}},"required":["quote_id"],"title":"GetQuoteRequest"}}}}
```

## The GetQuoteResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetQuoteResponse":{"type":"object","properties":{"status":{"type":"string","enum":["success"]},"data":{"type":"object","properties":{"id":{"type":"string","description":"Operation identifier."},"is_inverse":{"type":"boolean","description":"Indicates whether it is a inverse operation."},"type":{"type":"integer","enum":[1,2,3],"description":"Transaction type. One of: **1** Buy, **2** Sell, **3** Conversion."},"state":{"type":"integer","enum":[0,1,3,4,5,6],"description":"Transaction status. One of: **0** Pending, **1** Executed, **3** Insufficient Balance, **4** Not Executed, **5** Other, **6** Expired."},"currency_in":{"type":"string","description":"Input currency of the operation."},"currency_out":{"type":"string","description":"Output currency of the operation."},"amount_in":{"type":"string","description":"Input amount of the operation."},"amount_out":{"type":"string","description":"Output amount of the operation."},"amount_usdt_out":{"type":"string","description":"Output amount in USDT of the operation."},"fee_amount":{"type":"string","description":"Operation fee."},"fee_detail":{"type":"string","description":"Detail of the transaction fee."}},"required":["id","is_inverse","type","state","currency_in","currency_out","amount_in","amount_out","amount_usdt_out","fee_amount","fee_detail"]}},"required":["status","data"],"title":"GetQuoteResponse"}}}}
```

## The ExecuteQuoteResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"ExecuteQuoteResponse":{"type":"object","properties":{"status":{"type":"string","enum":["success"]},"data":{"type":"object","properties":{"id":{"type":"string","description":"Operation identifier."},"is_inverse":{"type":"boolean","description":"Indicates whether it is a inverse operation."},"type":{"type":"integer","enum":[1,2,3],"description":"Transaction type. One of: **1** Buy, **2** Sell, **3** Conversion."},"state":{"type":"integer","enum":[0,1,3,4,5,6],"description":"Transaction status. One of: **0** Pending, **1** Executed, **3** Insufficient Balance, **4** Not Executed, **5** Other, **6** Expired."},"currency_in":{"type":"string","description":"Input currency of the operation."},"currency_out":{"type":"string","description":"Output currency of the operation."},"amount_in":{"type":"string","description":"Input amount of the operation."},"amount_out":{"type":"string","description":"Output amount of the operation."},"amount_usdt_out":{"type":"string","description":"Output amount in USDT of the operation."},"fee_amount":{"type":"string","description":"Operation fee."},"fee_detail":{"type":"string","description":"Detail of the transaction fee."},"user_id":{"type":"string","description":"If the process is being made for a managed user, then this is the user id of the managed user."}},"required":["id","is_inverse","type","state","currency_in","currency_out","amount_in","amount_out","amount_usdt_out","fee_amount","fee_detail"]}},"required":["status","data"],"title":"ExecuteQuoteResponse"}}}}
```

## The VerifyBasicRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"VerifyBasicRequest":{"type":"object","properties":{"user_id":{"type":"string","description":"The ID of the user to verify."},"is_business":{"type":"boolean","description":"If is going to be an institutional/company user."},"profession":{"type":"string","enum":["trader","investor","student","housewife","accountant","actor_actress","air_hostess","archaeologist","architect","astronaut","baker","biologist","bricklayer","driver","businessman","butcher","caretaker_janitor_porter","carpenter","cashier","cleaner","clown","cobbler","cook_chef","chemist","dancer","decorator","dentist","designer","physician","dressmaker","dustman","economist","electrician","engineer","farmer","fireman","fisherman","florist","fruiterer","gardener","geologist","hairdresser","jeweller","journalist","judge","lawyer","librarian","life_guard","mailman_postman","mechanic","meteorologist","cryptocurrency_miner","mineral_miner","model","nanny_nursemaid","nun","nurse","painter","pastry_cook","pharmacist","photographer","physicist","plumber","policeman_policewoman","politician","priest","professor_teacher","programmer","psychiatrist","psychologist","receptionist","researcher_scientist","sailor","salesman","secretary","shop_assistant","singer","social_worker","sportsman","surgeon","taxi_driver","telephone_operator","travel_agent","veterinarian","waiter_waitress","writer","deliveryman","uber_driver","pilot","administrative","public_servant","other","customer_care","military","manager_officier"],"description":"User profession. One of: trader, investor, student, housewife, accountant, actor_actress, air_hostess, archaeologist, architect, astronaut, baker, biologist, bricklayer, driver, businessman, butcher, caretaker_janitor_porter, carpenter, cashier, cleaner, clown, cobbler, cook_chef, chemist, dancer, decorator, dentist, designer, physician, dressmaker, dustman, economist, electrician, engineer, farmer, fireman, fisherman, florist, fruiterer, gardener, geologist, hairdresser, jeweller, journalist, judge, lawyer, librarian, life_guard, mailman_postman, mechanic, meteorologist, cryptocurrency_miner, mineral_miner, model, nanny_nursemaid, nun, nurse, painter, pastry_cook, pharmacist, photographer, physicist, plumber, policeman_policewoman, politician, priest, professor_teacher, programmer, psychiatrist, psychologist, receptionist, researcher_scientist, sailor, salesman, secretary, shop_assistant, singer, social_worker, sportsman, surgeon, taxi_driver, telephone_operator, travel_agent, veterinarian, waiter_waitress, writer, deliveryman, uber_driver, pilot, administrative, public_servant, other, customer_care, military, manager_officier."},"gender":{"type":"integer","enum":[0,1],"description":"User gender. One of: **0** woman, **1** man."},"city":{"type":"string","description":"City of residence."},"street":{"type":"string","description":"Street of residence."},"country":{"type":"string","description":"Country of residence, given by the ISO 3166-1 alpha-2 standard."},"subject_comply":{"type":"string","description":"**bool**. If user or company is financilly or legally regulated. Required if `country` is `AR`."},"province":{"type":"integer","enum":[1,10,14,20,43,3,15,5,13,11,18,9,4,16,19,21,12,7,8,22,2,6,23,17],"description":"Province of residence. Required if `country` is `AR`. One of: **1** Buenos Aires, **10** Catamarca, **14** Chaco, **20** Chubut, **43** Ciudad Autónoma de Buenos Aires, **3** Córdoba, **15** Corrientes, **5** Entre Ríos, **13** Formosa, **11** Jujuy, **18** La Pampa, **9** La Rioja, **4** Mendoza, **16** Misiones, **19** Neuquén, **21** Río Negro, **12** Salta, **7** San Juan, **8** San Luis, **22** Santa Cruz, **2** Santa Fe, **6** Santiago del Estero, **23** Tierra del Fuego, Antártida e Islas del Atlántico Sur, **17** Tucumán."},"district":{"type":"string","description":"District of residence. Required if `country` is `BR`."},"number":{"type":"string","description":"Number of residence. Required if `country` is `BR`."},"state":{"type":"string","enum":["RO","AC","AM","RR","PA","AP","TO","MA","PI","CE","RN","PB","PE","AL","SE","BA","MG","ES","RJ","SP","PR","SC","RS","MS","MT","GO","DF"],"description":"State of residence. Required if `country` is `BR`. One of: **RO** Rondônia, **AC** Acre, **AM** Amazonas, **RR** Roraima, **PA** Pará, **AP** Amapá, **TO** Tocantins, **MA** Maranhão, **PI** Piauí, **CE** Ceará, **RN** Rio Grande do Norte, **PB** Paraíba, **PE** Pernambuco, **AL** Alagoas, **SE** Sergipe, **BA** Bahia, **MG** Minas Gerais, **ES** Espírito Santo, **RJ** Rio de Janeiro, **SP** São Paulo, **PR** Paraná, **SC** Santa Catarina, **RS** Rio Grande do Sul, **MS** Mato Grosso do Sul, **MT** Mato Grosso, **GO** Goiás, **DF** Distrito Federal."},"comune":{"type":"string","enum":["Arica","Camarones","General Lagos","Putre","Alto Hospicio","Camiña","Colchane","Huara","Iquique","Pica","Pozo Almonte","Antofagasta","Calama","María Elena","Mejillones","Ollagüe","San Pedro de Atacama","Sierra Gorda","Taltal","Tocopilla","Alto del Carmen","Caldera","Chañaral","Copiapó","Diego de Almagro","Freirina","Huasco","Tierra Amarilla","Vallenar","Andacollo","Canela","Combarbalá","Coquimbo","Illapel","La Higuera","La Serena","Los Vilos","Monte Patria","Ovalle","Paiguano","Punitaqui","Río Hurtado","Salamanca","Vicuña","Algarrobo","Cabildo","Calera","Calle Larga","Cartagena","Casablanca","Catemu","Concón","El Quisco","El Tabo","Hijuelas","Isla de Pascua","Juan Fernández","La Cruz","La Ligua","Limache","Llaillay","Los Andes","Nogales","Olmué","Panquehue","Papudo","Petorca","Puchuncaví","Putaendo","Quillota","Quilpué","Quintero","Rinconada","San Antonio","San Esteban","San Felipe","Santa María","Santo Domingo","Valparaíso","Villa Alemana","Viña del Mar","Zapallar","Alhué","Buin","Calera de Tango","Cerrillos","Cerro Navia","Colina","Conchalí","Curacaví","El Bosque","El Monte","Estación Central","Huechuraba","Independencia","Isla de Maipo","La Cisterna","La Florida","La Granja","La Pintana","La Reina","Lampa","Las Condes","Lo Barnechea","Lo Espejo","Lo Prado","Macul","Maipú","María Pinto","Melipilla","Ñuñoa","Padre Hurtado","Paine","Pedro Aguirre Cerda","Peñaflor","Peñalolén","Pirque","Providencia","Pudahuel","Puente Alto","Quilicura","Quinta Normal","Recoleta","Renca","San Bernardo","San Joaquín","San José de Maipo","San Miguel","San Pedro","San Ramón","Santiago","Talagante","Tiltil","Vitacura","Chimbarongo","Chépica","Codegua","Coinco","Coltauco","Doñihue","Graneros","La Estrella","Las Cabras","Litueche","Lolol","Machalí","Malloa","Marchihue","Nancagua","Navidad","Olivar","Palmilla","Paredones","Peralillo","Peumo","Pichidegua","Pichilemu","Placilla","Pumanque","Quinta de Tilcoco","Rancagua","Rengo","Requínoa","San Fernando","San Francisco de Mostazal","San Vicente de Tagua Tagua","Santa Cruz","Cauquenes","Chanco","Colbún","Constitución","Curepto","Curicó","Empedrado","Hualañé","Licantén","Linares","Longaví","Maule","Molina","Parral","Pelarco","Pelluhue","Pencahue","Rauco","Retiro","Romeral","Río Claro","Sagrada Familia","San Clemente","San Javier de Loncomilla","San Rafael","Talca","Teno","Vichuquén","Villa Alegre","Yerbas Buenas","Bulnes","Chillán Viejo","Chillán","Cobquecura","Coelemu","Coihueco","El Carmen","Ninhue","Ñiquén","Pemuco","Pinto","Portezuelo","Quillón","Quirihue","Ránquil","San Carlos","San Fabián","San Ignacio","San Nicolás","Treguaco","Yungay","Alto Biobío","Antuco","Arauco","Cabrero","Cañete","Chiguayante","Concepción","Contulmo","Coronel","Curanilahue","Florida","Hualpén","Hualqui","Laja","Lebu","Los Álamos","Los Ángeles","Lota","Mulchén","Nacimiento","Negrete","Penco","Quilaco","Quilleco","San Pedro de la Paz","San Rosendo","Santa Bárbara","Santa Juana","Talcahuano","Tirúa","Tomé","Tucapel","Yumbel","Angol","Carahue","Cholchol","Collipulli","Cunco","Curacautín","Curarrehue","Ercilla","Freire","Galvarino","Gorbea","Lautaro","Loncoche","Lonquimay","Los Sauces","Lumaco","Melipeuco","Nueva Imperial","Padre las Casas","Perquenco","Pitrufquén","Pucón","Purén","Renaico","Saavedra","Temuco","Teodoro Schmidt","Toltén","Traiguén","Victoria","Vilcún","Villarrica","Corral","Futrono","La Unión","Lago Ranco","Lanco","Los Lagos","Mariquina","Máfil","Paillaco","Panguipulli","Río Bueno","Valdivia","Ancud","Calbuco","Castro","Chaitén","Chonchi","Cochamó","Curaco de Vélez","Dalcahue","Fresia","Frutillar","Futaleufú","Hualaihué","Llanquihue","Los Muermos","Maullín","Osorno","Palena","Puerto Montt","Puerto Octay","Puerto Varas","Puqueldón","Purranque","Puyehue","Queilén","Quellón","Quemchi","Quinchao","Río Negro","San Juan de la Costa","San Pablo","Aisén","Chile Chico","Cisnes","Cochrane","Coihaique","Guaitecas","Lago Verde","O’Higgins","Río Ibáñez","Tortel","Antártica","Cabo de Hornos Ex Navarino","Laguna Blanca","Natales","Porvenir","Primavera","Punta Arenas","Río Verde","San Gregorio","Timaukel","Torres del Paine"],"description":"Commune of residence. Required if `country` is `CL`. One of: Arica, Camarones, General Lagos, Putre, Alto Hospicio, Camiña, Colchane, Huara, Iquique, Pica, Pozo Almonte, Antofagasta, Calama, María Elena, Mejillones, Ollagüe, San Pedro de Atacama, Sierra Gorda, Taltal, Tocopilla, Alto del Carmen, Caldera, Chañaral, Copiapó, Diego de Almagro, Freirina, Huasco, Tierra Amarilla, Vallenar, Andacollo, Canela, Combarbalá, Coquimbo, Illapel, La Higuera, La Serena, Los Vilos, Monte Patria, Ovalle, Paiguano, Punitaqui, Río Hurtado, Salamanca, Vicuña, Algarrobo, Cabildo, Calera, Calle Larga, Cartagena, Casablanca, Catemu, Concón, El Quisco, El Tabo, Hijuelas, Isla de Pascua, Juan Fernández, La Cruz, La Ligua, Limache, Llaillay, Los Andes, Nogales, Olmué, Panquehue, Papudo, Petorca, Puchuncaví, Putaendo, Quillota, Quilpué, Quintero, Rinconada, San Antonio, San Esteban, San Felipe, Santa María, Santo Domingo, Valparaíso, Villa Alemana, Viña del Mar, Zapallar, Alhué, Buin, Calera de Tango, Cerrillos, Cerro Navia, Colina, Conchalí, Curacaví, El Bosque, El Monte, Estación Central, Huechuraba, Independencia, Isla de Maipo, La Cisterna, La Florida, La Granja, La Pintana, La Reina, Lampa, Las Condes, Lo Barnechea, Lo Espejo, Lo Prado, Macul, Maipú, María Pinto, Melipilla, Ñuñoa, Padre Hurtado, Paine, Pedro Aguirre Cerda, Peñaflor, Peñalolén, Pirque, Providencia, Pudahuel, Puente Alto, Quilicura, Quinta Normal, Recoleta, Renca, San Bernardo, San Joaquín, San José de Maipo, San Miguel, San Pedro, San Ramón, Santiago, Talagante, Tiltil, Vitacura, Chimbarongo, Chépica, Codegua, Coinco, Coltauco, Doñihue, Graneros, La Estrella, Las Cabras, Litueche, Lolol, Machalí, Malloa, Marchihue, Nancagua, Navidad, Olivar, Palmilla, Paredones, Peralillo, Peumo, Pichidegua, Pichilemu, Placilla, Pumanque, Quinta de Tilcoco, Rancagua, Rengo, Requínoa, San Fernando, San Francisco de Mostazal, San Vicente de Tagua Tagua, Santa Cruz, Cauquenes, Chanco, Colbún, Constitución, Curepto, Curicó, Empedrado, Hualañé, Licantén, Linares, Longaví, Maule, Molina, Parral, Pelarco, Pelluhue, Pencahue, Rauco, Retiro, Romeral, Río Claro, Sagrada Familia, San Clemente, San Javier de Loncomilla, San Rafael, Talca, Teno, Vichuquén, Villa Alegre, Yerbas Buenas, Bulnes, Chillán Viejo, Chillán, Cobquecura, Coelemu, Coihueco, El Carmen, Ninhue, Ñiquén, Pemuco, Pinto, Portezuelo, Quillón, Quirihue, Ránquil, San Carlos, San Fabián, San Ignacio, San Nicolás, Treguaco, Yungay, Alto Biobío, Antuco, Arauco, Cabrero, Cañete, Chiguayante, Concepción, Contulmo, Coronel, Curanilahue, Florida, Hualpén, Hualqui, Laja, Lebu, Los Álamos, Los Ángeles, Lota, Mulchén, Nacimiento, Negrete, Penco, Quilaco, Quilleco, San Pedro de la Paz, San Rosendo, Santa Bárbara, Santa Juana, Talcahuano, Tirúa, Tomé, Tucapel, Yumbel, Angol, Carahue, Cholchol, Collipulli, Cunco, Curacautín, Curarrehue, Ercilla, Freire, Galvarino, Gorbea, Lautaro, Loncoche, Lonquimay, Los Sauces, Lumaco, Melipeuco, Nueva Imperial, Padre las Casas, Perquenco, Pitrufquén, Pucón, Purén, Renaico, Saavedra, Temuco, Teodoro Schmidt, Toltén, Traiguén, Victoria, Vilcún, Villarrica, Corral, Futrono, La Unión, Lago Ranco, Lanco, Los Lagos, Mariquina, Máfil, Paillaco, Panguipulli, Río Bueno, Valdivia, Ancud, Calbuco, Castro, Chaitén, Chonchi, Cochamó, Curaco de Vélez, Dalcahue, Fresia, Frutillar, Futaleufú, Hualaihué, Llanquihue, Los Muermos, Maullín, Osorno, Palena, Puerto Montt, Puerto Octay, Puerto Varas, Puqueldón, Purranque, Puyehue, Queilén, Quellón, Quemchi, Quinchao, Río Negro, San Juan de la Costa, San Pablo, Aisén, Chile Chico, Cisnes, Cochrane, Coihaique, Guaitecas, Lago Verde, O’Higgins, Río Ibáñez, Tortel, Antártica, Cabo de Hornos (Ex Navarino), Laguna Blanca, Natales, Porvenir, Primavera, Punta Arenas, Río Verde, San Gregorio, Timaukel, Torres del Paine."}},"required":["is_business","profession","gender","city","street","country","subject_comply","province","district","number","state","comune"],"title":"VerifyBasicRequest"}}}}
```

## The VerifyBasicResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"VerifyBasicResponse":{"type":"object","properties":{"status":{"type":"string","enum":["success"]},"data":{"type":"object","properties":{"metamap_url":{"type":"string","description":"Link for the verification process."}},"required":["metamap_url"]}},"required":["status","data"],"title":"VerifyBasicResponse"}}}}
```

## The VerifyTraderRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"VerifyTraderRequest":{"type":"object","properties":{"pep":{"type":"string","description":"**bool**. If user or company is financilly or legally regulated."},"subject_comply":{"type":"string","description":"**bool**. If user or company is financilly or legally regulated."},"is_public_servant":{"type":"string","description":"**bool**. If user works for a goverment."},"document_address_file":{"type":"string","format":"binary","description":"A document giving proof of residence of the user. The residence must be the same as given in the basic verification."},"document_address_type":{"type":"integer","enum":[3,30,35,36,37,38,39,41,40,42],"description":"One of:. **3** SERVICE. **30** PROOF_ADDRESS. **35** CREDIT_CARD_BILL. **36** SALARY_STATEMENTS. **37** NEIGHBOURS_CERTIFICATE. **38** NOTARY_ADDRESS_CERTIFICATE. **39** PRODUCT_BILL_WITH_PAYMENT_CERTIFICATE. **41** SERVICE_WITH_BIRTH. **40** SERVICE_WITH_MARRIAGE. **42** DRIVER_LICENSE_WITH_ADDRESS."}},"required":["pep","subject_comply","is_public_servant","document_address_file","document_address_type"],"title":"VerifyTraderRequest"}}}}
```

## The VerifyTraderResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"VerifyTraderResponse":{"type":"object","properties":{"status":{"type":"string","enum":["success"]}},"required":["status"],"title":"VerifyTraderResponse"}}}}
```

## The GetTraderPlusVerificationSchemasRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetTraderPlusVerificationSchemasRequest":{"type":"object","properties":{"country":{"type":"string","description":"Country of residence, given by the ISO 3166-1 alpha-2 standard."},"user_id":{"type":"string","description":"If the process is being made for a managed user, then this is the user id of the managed user."}},"required":["country"],"title":"GetTraderPlusVerificationSchemasRequest"}}}}
```

## The GetTraderPlusVerificationSchemasResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetTraderPlusVerificationSchemasResponse":{"type":"object","properties":{"status":{"type":"string","enum":["success"]},"data":{"type":"array","items":{"type":"object","description":"the schema."}}},"required":["status","data"],"title":"GetTraderPlusVerificationSchemasResponse"}}}}
```

## The VerifyTraderPlusRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"VerifyTraderPlusRequest":{"type":"object","properties":{"user_id":{"type":"string","description":"If the process is being made for a managed user, then this is the user id of the managed user."},"country":{"type":"string","description":"Country of the user, given by the ISO 3166-1 alpha-2 standard."},"declaration_template_id":{"type":"string","description":"The id of the schema."},"declaration_id":{"type":"string","description":"The id of the declaration."},"{filed_name}":{"oneOf":[{"type":"integer"},{"type":"string"},{"type":"boolean"}],"description":"A value required by the schema, its key (*field_key*) is defined in the corresponding schema. This endpoint may required many field like this. depending on the schema."},"{file_name}":{"type":"string","format":"binary","description":"A File, its key (*file_name*) is defined in the corresponding schema. This endpoint may require many fields like this, depending on the schema."}},"required":["country","declaration_template_id","declaration_id","{filed_name}","{file_name}"],"title":"VerifyTraderPlusRequest"}}}}
```

## The VerifyTraderPlusResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"VerifyTraderPlusResponse":{"type":"object","properties":{"status":{"type":"string","enum":["success"]}},"required":["status"],"title":"VerifyTraderPlusResponse"}}}}
```

## The GetInstitutionalCompanySchemasRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetInstitutionalCompanySchemasRequest":{"type":"object","properties":{"country":{"type":"string","description":"Country of the company to be verified as a 2 character representation, given by the ISO 3166-1 alpha-2 standard. Examples: AR, BR, CL, CO, PE."}},"required":["country"],"title":"GetInstitutionalCompanySchemasRequest"}}}}
```

## The GetInstitutionalCompanySchemasResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetInstitutionalCompanySchemasResponse":{"type":"object","properties":{"status":{"type":"string","enum":["success"]},"data":{"type":"array","items":{"type":"object","description":"the schema."}}},"required":["status","data"],"title":"GetInstitutionalCompanySchemasResponse"}}}}
```

## The VerifyInstitutionalCompanyRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"VerifyInstitutionalCompanyRequest":{"type":"object","properties":{"declaration_template_id":{"type":"integer","description":"The id of the schema."},"declaration_id":{"type":"integer","description":"The id of the declaration."},"country":{"type":"string","description":"Country of the company, given by the ISO 3166-1 alpha-2 standard."},"user_id":{"type":"string","description":"User that will be verifying the company. If not provided, then the authenticated user making the method call will be considered."},"{filed_name}":{"oneOf":[{"type":"integer"},{"type":"string"},{"type":"boolean"}],"description":"A value required by the schema, its key (*field_key*) is defined in the corresponding schema. This endpoint may required many field like this. depending on the schema."},"{file_name}":{"type":"string","format":"binary","description":"A File, the field key (*file_name*) is defined in the corresponding schema. This endpoint may require many fields like this, depending on the schema."}},"required":["declaration_template_id","country","{filed_name}","{file_name}"],"title":"VerifyInstitutionalCompanyRequest"}}}}
```

## The VerifyInstitutionalCompanyResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"VerifyInstitutionalCompanyResponse":{"type":"object","properties":{"status":{"type":"string","enum":["success"]}},"required":["status"],"title":"VerifyInstitutionalCompanyResponse"}}}}
```

## The GetInstitutionalCompanyVerificationStatusResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetInstitutionalCompanyVerificationStatusResponse":{"type":"object","properties":{"status":{"type":"string","enum":["success"]},"data":{"type":"object","properties":{"status":{"type":"string","enum":["success","in_review","pending","error","expired"],"description":"One of: success, in_review, pending, error, expired."},"form":{"type":"object","description":"The company information.","properties":{"country":{"type":"string","description":"Country of the company."},"city":{"type":"string","description":"City of the company."},"province":{"type":"string","description":"Province of the company."},"address":{"type":"string","description":"Address of the company."},"name":{"type":"string","description":"Name of the company."},"identity":{"type":"string","description":"Identity of the company."},"field":{"type":"string","description":"Sector of the company."}},"required":["country","city","province","address","name","identity","field"]}},"required":["status","form"]}},"required":["status","data"],"title":"GetInstitutionalCompanyVerificationStatusResponse"}}}}
```

## The GetInstitutionalMemberTypesResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetInstitutionalMemberTypesResponse":{"type":"object","properties":{"status":{"type":"string","enum":["success"]},"data":{"type":"array","items":{"type":"object","properties":{"value":{"type":"integer","description":"The ID of the member type."},"label":{"type":"string","description":"Member type description."}},"required":["value","label"]}}},"required":["status","data"],"title":"GetInstitutionalMemberTypesResponse"}}}}
```

## The GetInstitutionalMemberSchemasRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetInstitutionalMemberSchemasRequest":{"type":"object","properties":{"country":{"type":"string","description":"Country of the company to be verified, given by the ISO 3166-1 alpha-2 standard."},"member_type":{"type":"integer","enum":[1,2,3],"description":"Member type. One of: **1** Directory, **2** Beneficial owner, **3** Legal representative."}},"required":["country","member_type"],"title":"GetInstitutionalMemberSchemasRequest"}}}}
```

## The GetInstitutionalMemberSchemasResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetInstitutionalMemberSchemasResponse":{"type":"object","properties":{"status":{"type":"string","enum":["success"]},"data":{"type":"object","description":"the schema."}},"required":["status","data"],"title":"GetInstitutionalMemberSchemasResponse"}}}}
```

## The VerifyInstitutionalMemberRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"VerifyInstitutionalMemberRequest":{"type":"object","properties":{"member_type":{"type":"integer","description":"Member type id."},"member_template_id":{"type":"string","description":"Member scheme id."},"{filed_name}":{"oneOf":[{"type":"integer"},{"type":"string"},{"type":"boolean"}],"description":"A value required by the schema, its key (*field_key*) is defined in the corresponding schema. This endpoint may required many field like this. depending on the schema."},"{file_name}":{"type":"string","format":"binary","description":"A File, fhe field key (*file_name*) is defined in the corresponding schema. This endpoint may require many fields like this, depending on the schema."}},"required":["member_type","member_template_id","{filed_name}","{file_name}"],"title":"VerifyInstitutionalMemberRequest"}}}}
```

## The VerifyInstitutionalMemberResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"VerifyInstitutionalMemberResponse":{"type":"object","properties":{"status":{"type":"string","enum":["success"]}},"required":["status"],"title":"VerifyInstitutionalMemberResponse"}}}}
```

## The GetInstitutionalMemberVerificationStatusResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetInstitutionalMemberVerificationStatusResponse":{"type":"object","properties":{"status":{"type":"string","enum":["success"]},"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"Role of the user inside the company."},"name":{"type":"string","description":"Name of an user part of the company."},"createdAt":{"type":"string","description":"Creation time of the verification request."},"status":{"type":"string","enum":["success","error","pending"],"description":"One of: success, error, pending."}},"required":["type","name","createdAt","status"]}}},"required":["status","data"],"title":"GetInstitutionalMemberVerificationStatusResponse"}}}}
```

## The GetInstitutionalDocumentTypesResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetInstitutionalDocumentTypesResponse":{"type":"object","properties":{"status":{"type":"string","enum":["success"]},"data":{"type":"array","items":{"type":"object","properties":{"value":{"type":"integer","description":"The ID of the document type."},"label":{"type":"string","description":"Document type description."}},"required":["value","label"]}}},"required":["status","data"],"title":"GetInstitutionalDocumentTypesResponse"}}}}
```

## The VerifyInstitutionalDocumentRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"VerifyInstitutionalDocumentRequest":{"type":"object","properties":{"type":{"type":"integer","description":"Document type as given in document types."},"file":{"type":"string","format":"binary","description":"The document to verify."}},"required":["type","file"],"title":"VerifyInstitutionalDocumentRequest"}}}}
```

## The VerifyInstitutionalDocumentResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"VerifyInstitutionalDocumentResponse":{"type":"object","properties":{"status":{"type":"string","enum":["success"]}},"required":["status"],"title":"VerifyInstitutionalDocumentResponse"}}}}
```

## The GetInstitutionalDocumentVerificationStatusResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetInstitutionalDocumentVerificationStatusResponse":{"type":"object","properties":{"status":{"type":"string","enum":["success"]},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"The id of the document type."},"type":{"type":"string","description":"The document type."},"name":{"type":"string","description":"Name of the document file."},"createdAt":{"type":"string","description":"Creation time of the verification request."},"status":{"type":"string","enum":["success","error","pending"],"description":"One of: success, error, pending."}},"required":["id","type","name","createdAt","status"]}}},"required":["status","data"],"title":"GetInstitutionalDocumentVerificationStatusResponse"}}}}
```

## The GetVerificationStatusRequest object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetVerificationStatusRequest":{"type":"object","properties":{"user_id":{"type":"string","description":"The ID of the user to get the verification status from. If not defined, the verification status is for the authenticated user making the call."}},"required":[],"title":"GetVerificationStatusRequest"}}}}
```

## The GetVerificationStatusResponse object

```json
{"openapi":"3.2.0","info":{"title":"index.html","version":"1.0.0"},"components":{"schemas":{"GetVerificationStatusResponse":{"type":"object","properties":{"status":{"type":"string","enum":["success"]},"data":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the verification process."},"type":{"type":"string","enum":["basic","trader","trader_plus","institutional"],"description":"One of: basic, trader, trader_plus, institutional."},"status":{"type":"string","enum":["pending","approved","rejected"],"description":"One of: pending, approved, rejected."},"has_errors":{"type":"boolean","description":"If a current verification process has errors."},"errors":{"type":"array","items":{"type":"string"},"description":"The possible errors of the verification process."},"is_business":{"type":"boolean","description":"If the current user is considered a business (an institution)."},"verification_tier":{"type":"integer","enum":[0,1,2,3,4],"description":"One of: 0, 1, 2, 3, 4."},"current_process_data":{"type":"object","description":"Current user verification data in notbank."}},"required":["id","type","status","has_errors","errors","is_business","verification_tier","current_process_data"]}},"required":["status","data"],"title":"GetVerificationStatusResponse"}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://www.notbank.com/learn/api-reference/readme/models.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.