Trade Activity
Retrieve trade activity information about a StoneX account.
POST
/account-api/v1/trade-activity
Request Body
- Schema
- Example
When using the trade-activity
endpoint you are always required to send the below attributes.
The remainder of the payload should only include data blocks which are being updated.
Attributes | Data Type | Length | Description |
---|---|---|---|
dateFrom | String | ||
dateTo | String | ||
accountNumber | String | 8 | StoneX Account Number |
{
"dateFrom": "string",
"dateTo": "string",
"accountNumber": "string"
}
Response
- Schema
- Example
Successful Response
The response for a Successful request will look like:
Attributes | Data Type | Length | Description |
---|---|---|---|
statusCode | Integer | 3 | Code identifies success of request |
message | String | Outcome of request | |
data | Main field containing information of request | ||
errors | API errors | ||
traceId | String | Unique identifier | |
hasErrors | Boolean | True or False |
{
"statusCode": 0,
"message": "string",
"data": {
"activity": [
{
"processDate": "string",
"transType": "string",
"controlNo": "string",
"acctNo": "string",
"acctType": "string",
"secNo": "string",
"cusip": "string",
"symbol": "string",
"quantity": "string",
"price": "string",
"buySell": "string",
"netAmount": "string",
"secType": "string",
"recCode": "string",
"description": "string",
"description1": "string",
"description2": "string",
"description3": "string",
"currency": "string",
"sourceType": "string",
"asOfDate": "string",
"rebill": "string",
"industryGroupDescription": "string",
"rebillStatus": "string",
"cancelType": "string",
"cancel": "string",
"cancelStatus": "string",
"commission": "string",
"exchId": "string",
"fxRate": "string",
"handle": "string",
"interest": "string",
"lookalike": "string",
"offsetAcctNo": "string",
"origin": "string",
"postage": "string",
"principal": "string",
"secFee": "string",
"settleDate": "string",
"tagNo": "string",
"tradeDate": "string",
"tranId": "string",
"userField": "string",
"activityType": "string",
"note": "string",
"sedol": "string",
"isin": "string",
"activityTypeViews": "string",
"activityTypeViewsList": [
"string"
],
"sourceCode": "string"
}
]
},
"errors": [
{
"code": "string",
"field": "string",
"reason": "string"
}
],
"traceId": "string",
"hasErrors": true
}
- Schema
- Example
A successful request will respond with a result containing the account number, account status & all the current account data.
Attributes | Data Type | Length | Description |
---|---|---|---|
processDate | String | 8 | Date the payment is initiated |
transType | String | Type of Transaction | |
controlNo | String | 9 | Identifier that some companies use to authenticate shareholders |
acctNo | String | 8 | StoneX Account Number |
acctType | String | 1 | Account type indicator |
cusip | String | 9 | ID for a security |
symbol | String | Unique combination of letters and numbers that represent a particular stock or security | |
quantity | String | Number of shares, option contracts, or face value of bonds | |
price | String | Trade execution price per share, option contract or face value of bonds | |
buySell | String | 3 | Identifies the buy/sell code for an order |
netAmount | String | Amount left after all activity is settled | |
secType | String | 2 | Security type code |
recCode | String | 1 | Access record type |
description | String | 24 | Description |
description1 | String | 24 | Description Line 1 |
description2 | String | 24 | Description Line 2 |
description3 | String | 24 | Description Line 3 |
currency | String | 5 | Currency |
sourceType | String | ||
asOfDate | String | 10 | Transaction processing date is reported using the as-of date rather than the actual processing date |
rebill | String | To bill again | |
industryGroupDescription | String | ||
rebillStatus | String | 1 | Rebilled request status code |
cancelType | String | ||
cancel | String | 1 | Cancel indicator |
cancelStatus | String | ||
commission | String | Amount of commission on the trade | |
exchId | String | ||
fxRate | String | Rate at which one currency will be exchanged for another currency | |
handle | String | Amount of handling fee charged on the trade | |
interest | String | Interest accrued | |
lookalike | String | ||
offsetAcctNo | String | Account number of the contra account | |
origin | String | 5 | Order origin code |
postage | String | 5 | Amount of postage charged on the trade |
principal | String | 1 | If principal payments should be directed into the customer's free credit balance for reinvestment |
settleDate | String | 10 | Date when a transaction settles whereby parties pay for securities purchased and surrender securities sold |
tagNo | String | Number assigned to a trade for bundling purposes | |
tradeDate | String | 10 | Date upon which a transaction is executed (filled) |
tranId | String | 1 | Identifies an entry originating outside of the BETAHost System |
userField | String | ||
activityType | String | ||
note | String | 120 | Memo |
sedol | String | 7 | Code assigned to securities that trade on the London Stock Exchange and various smaller exchanges in the United Kingdom |
isin | String | 12 | Identifies a specific security |
activityTypeViews | String | ||
activityTypeViewsList | String | ||
sourceCode | String | 10 | Source Code |
{
"statusCode": 0,
"message": "string",
"data": {
"activity": [
{
"processDate": "string",
"transType": "string",
"controlNo": "string",
"acctNo": "string",
"acctType": "string",
"secNo": "string",
"cusip": "string",
"symbol": "string",
"quantity": "string",
"price": "string",
"buySell": "string",
"netAmount": "string",
"secType": "string",
"recCode": "string",
"description": "string",
"description1": "string",
"description2": "string",
"description3": "string",
"currency": "string",
"sourceType": "string",
"asOfDate": "string",
"rebill": "string",
"industryGroupDescription": "string",
"rebillStatus": "string",
"cancelType": "string",
"cancel": "string",
"cancelStatus": "string",
"commission": "string",
"exchId": "string",
"fxRate": "string",
"handle": "string",
"interest": "string",
"lookalike": "string",
"offsetAcctNo": "string",
"origin": "string",
"postage": "string",
"principal": "string",
"secFee": "string",
"settleDate": "string",
"tagNo": "string",
"tradeDate": "string",
"tranId": "string",
"userField": "string",
"activityType": "string",
"note": "string",
"sedol": "string",
"isin": "string",
"activityTypeViews": "string",
"activityTypeViewsList": [
"string"
],
"sourceCode": "string"
}
]
},
"errors": [
{
"code": "string",
"field": "string",
"reason": "string"
}
],
"traceId": "string",
"hasErrors": true
}