Trades

Get trade by id - id could be either the entity id or tid

get
Authorizations
X-API-KEYstringRequired
Path parameters
idone ofRequired
stringOptional
or
string · min: 1 · max: 50OptionalExample: tid_00041061050r3gg28a1c60t3gf
Query parameters
investmentTypestring · enumOptionalPossible values:
tradeStatusstring · enumOptionalPossible values:
saStatusstring · enumOptionalPossible values:
saCheckstring · enumOptionalPossible values:
txnPaymentMethodstring · enumOptionalPossible values:
fundingStatusstring · enumOptionalPossible values:
txnCheckstring · enumOptionalPossible values:
systemReviewCheckstring · enumOptionalPossible values:
complianceReviewstring · enumOptionalPossible values:
beenDisbursedstring · enumOptionalPossible values:
searchstringOptionalExample: Mike
offeringIdanyOptionalExample: offering_00041061050r3gg28a1c60t3gf
fromstring · nullableOptionalExample: MM/DD/YYYY
tostring · nullableOptionalExample: MM/DD/YYYY
minAmountanyOptionalExample: 2500.00
maxAmountanyOptionalExample: 15000000.50
managedBystring · enumOptionalPossible values:
investorAccountIdanyOptional
includestringOptionalExample: tradeDisbursements,adjustments,account,issuer,lineItems,transactions,investorAccount,offering,paymentMethod
Responses
chevron-right
200

200

application/json
idstringRequiredExample: entityprefix_01j1xgme5qeqq97gpdztd7e4a6
__entitystringOptionalExample: Entity
createdAtone ofRequiredExample: 2026-03-27T15:47:09.539Z
string · date-timeOptional
or
string · date-timeOptional
updatedAtone ofRequiredExample: 2026-03-27T15:47:09.539Z
string · date-timeOptional
or
string · date-timeOptional
deletedAtone of · nullableRequiredExample: 2026-03-27T15:47:09.540Z
string · date-timeOptional
or
string · date-timeOptional
investorAccountIdany · nullableRequired
investorAccountany · nullableOptional
offeringany · nullableOptional
accountIdstring · nullableRequiredExample: account_01j1xgme5qeqq97gpdztd7e4a6
accountany · nullableRequired
offeringIdany · nullableRequired
paymentMethodIdany · nullableRequired
paymentMethodany · nullableOptional
userIdany · nullableRequired
tradeNumberstringRequired
ipstring · nullableRequired
tidstring · nullableRequired
investmentTypestring · enumRequiredPossible values:
purchasedSharesintegerRequired
bonusSharesinteger · nullableRequired
totalNumberOfSharesintegerRequired
pricePerSharenumberRequired
totalAmountnumber · nullableRequired
tradeStatusstring · enumRequiredPossible values:
tradeStatusUnmappedstring · nullableRequired
tradeDatestring · date-time · nullableRequired
saStatusstring · enumRequiredPossible values:
saStatusUnmappedstring · nullableRequired
saUrlstring · nullableRequired
saSignedAtstring · date-time · nullableRequired
saExtractedNumberOfSharesstring · nullableRequired
saExtractedTotalAmountstring · nullableRequired
saExtractedPricePerSharestring · nullableRequired
saExtractedInvestorTypestring · nullableRequired
saExtractedSignerstring · nullableRequired
saExtractedSignatureDatestring · date-time · nullableRequired
saExtractedSigner2string · nullableRequired
saExtractedSignatureDate2string · date-time · nullableRequired
saCheckstring · enumRequiredPossible values:
saCheckedAtstring · date-time · nullableRequired
txnTidstring · nullableRequired
txnResponsestring · nullableRequired
txnPaymentMethodstring · enum · nullableRequiredPossible values:
txnCurrencyCodestring · min: 3 · max: 3 · nullableRequired
txnChargedAmountnumber · nullableRequired
txnDatestring · date-time · nullableRequired
txnSettledDatestring · date-time · nullableRequired
fundingStatusstring · enum · nullableRequiredPossible values:
fundingStatusUnmappedstring · nullableRequired
txnCheckstring · enum · nullableRequiredPossible values:
txnCheckedAtstring · date-time · nullableRequired
txnLogstring · nullableRequired
systemReviewCheckstring · enum · nullableRequiredPossible values:
systemReviewCheckedAtstring · date-time · nullableRequired
systemReviewLogstring · nullableRequired
complianceReviewstring · enum · nullableRequiredPossible values:
complianceReviewNotesstring · nullableRequired
complianceReviewerIdstring · nullableRequired
issuerIdany · nullableRequired
complianceReviewNamestring · nullableRequired
complianceReviewAtstring · date-time · nullableRequired
tradeTypestring · enum · nullableRequiredPossible values:
placedAtstring · date-time · nullableRequired
platformstringRequired
cancelledAtstring · date-time · nullableRequired
cancelledByIdstring · nullableRequired
cancelledReasonstring · nullableRequired
cancellationPeriodnumber · nullableRequired
disbursedbooleanOptional
tradeAdjustmentsnumber · nullableOptional
chargedAmountnumber · nullableOptional
balancenumber · nullableOptional
isUncleared24hbooleanRequired
termnumber · nullableRequired
exercisePricenumber · nullableRequired
warrantPercentagenumber · nullableRequired
calculationMethodstring · enum · nullableRequiredPossible values:
incrementThresholdnumber · nullableRequired
get
/clients/api/v1/trades/{id}

Patch a trade status

patch
Authorizations
X-API-KEYstringRequired
Path parameters
idone ofRequired
stringOptional
or
string · min: 1 · max: 50OptionalExample: tid_00041061050r3gg28a1c60t3gf
Body
tradeStatusstring · enumRequiredPossible values:
Responses
patch
/clients/api/v1/trades/{id}

Get trades

get
Authorizations
X-API-KEYstringRequired
Query parameters
pagenumber · nullableOptionalDefault: 1
limitnumber · nullableOptionalDefault: 10
investmentTypestring · enumOptionalPossible values:
tradeStatusstring · enumOptionalPossible values:
saStatusstring · enumOptionalPossible values:
saCheckstring · enumOptionalPossible values:
txnPaymentMethodstring · enumOptionalPossible values:
fundingStatusstring · enumOptionalPossible values:
txnCheckstring · enumOptionalPossible values:
systemReviewCheckstring · enumOptionalPossible values:
complianceReviewstring · enumOptionalPossible values:
beenDisbursedstring · enumOptionalPossible values:
searchstringOptionalExample: Mike
offeringIdanyOptionalExample: offering_00041061050r3gg28a1c60t3gf
fromstring · nullableOptionalExample: MM/DD/YYYY
tostring · nullableOptionalExample: MM/DD/YYYY
minAmountanyOptionalExample: 2500.00
maxAmountanyOptionalExample: 15000000.50
managedBystring · enumOptionalPossible values:
investorAccountIdanyOptional
includestringOptionalExample: tradeDisbursements,adjustments,account,issuer,lineItems,transactions,investorAccount,offering,paymentMethod
Responses
chevron-right
200

200

application/json
get
/clients/api/v1/trades

Create Trades

post
Authorizations
X-API-KEYstringRequired
Body
investorAccountIdanyOptional
investmentTypestring · enumOptionalPossible values:
Responses
post
/clients/api/v1/trades/

Create a Line Item

post
Authorizations
X-API-KEYstringRequired
Query parameters
resetstringOptionalDefault: false
Body
assetIdstringRequiredExample: asset_00041061050r3gg28a1c60t3gf
quantitynumber · max: 1000000000Required
Responses
post
/clients/api/v1/trades/line-items

Attach subdoc to trade

post
Authorizations
X-API-KEYstringRequired
Path parameters
idone ofRequired
stringOptional
or
string · min: 1 · max: 50OptionalExample: tid_00041061050r3gg28a1c60t3gf
Body
lineItemIdstringRequiredExample: trade_line_item_01kctsycw3fq7sj6hedvy62cja
fileIdanyRequiredExample: file_01je6ht4b8fbmttkzh2hs82xqp
primarySignatureStatusstring · enumRequiredExample: SIGNEDPossible values:
secondarySignatureStatusstring · enumOptionalExample: SIGNEDPossible values:
Responses
chevron-right
200

200

application/json
successbooleanRequired
messagestringRequired
post
/clients/api/v1/trades/{id}/attach-subdoc

Update attached subdoc for trade

put
Authorizations
X-API-KEYstringRequired
Path parameters
idone ofRequired
stringOptional
or
string · min: 1 · max: 50OptionalExample: tid_00041061050r3gg28a1c60t3gf
Body
lineItemIdstringOptionalExample: trade_line_item_01kctsycw3fq7sj6hedvy62cja
fileIdanyOptionalExample: file_01je6ht4b8fbmttkzh2hs82xqp
primarySignatureStatusstring · enumOptionalExample: SIGNEDPossible values:
secondarySignatureStatusstring · enumOptionalExample: SIGNEDPossible values:
Responses
chevron-right
200

200

application/json
successbooleanRequired
messagestringRequired
put
/clients/api/v1/trades/{id}/attach-subdoc

Update subdoc signature statuses for trade

patch
Authorizations
X-API-KEYstringRequired
Path parameters
idone ofRequired
stringOptional
or
string · min: 1 · max: 50OptionalExample: tid_00041061050r3gg28a1c60t3gf
Body
lineItemIdstringOptional

Optional. If not provided, updates the first line item with an attached subdoc. Required for trades with multiple line items.

Example: trade_line_item_01kctsycw3fq7sj6hedvy62cja
primarySignatureStatusstring · enumOptional

Primary signer signature status

Example: SIGNEDPossible values:
secondarySignatureStatusstring · enumOptional

Secondary signer signature status. Only applicable for JOINT investor accounts.

Example: SIGNEDPossible values:
Responses
chevron-right
200

200

application/json
successbooleanRequired
messagestringRequired
patch
/clients/api/v1/trades/{id}/sign

Last updated