Trades

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

get

Authorizations

api_key

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

200

200

application/json

401

401

application/json

403

403

application/json

404

404

application/json

get

/clients/api/v1/trades/{id}

HTTPcURLJavaScriptPython

GET /clients/api/v1/trades/{id} HTTP/1.1
Host: platform.dalmoregroup.com
X-API-KEY: YOUR_API_KEY
Accept: */*

{
  "id": "entityprefix_01j1xgme5qeqq97gpdztd7e4a6",
  "__entity": "Entity",
  "createdAt": "2026-02-02T18:26:08.573Z",
  "updatedAt": "2026-02-02T18:26:08.573Z",
  "deletedAt": "2026-02-02T18:26:08.574Z",
  "investorAccountId": null,
  "investorAccount": null,
  "offering": null,
  "accountId": "account_01j1xgme5qeqq97gpdztd7e4a6",
  "account": null,
  "offeringId": null,
  "paymentMethodId": null,
  "paymentMethod": null,
  "userId": null,
  "tradeNumber": "text",
  "ip": "text",
  "tid": "text",
  "investmentType": "INDIVIDUAL",
  "purchasedShares": 1,
  "bonusShares": 1,
  "totalNumberOfShares": 1,
  "pricePerShare": 1,
  "lineItems": [],
  "adjustments": [],
  "transactions": [],
  "totalAmount": 1,
  "tradeStatus": "CART",
  "tradeStatusUnmapped": "text",
  "tradeDate": "2026-02-03T16:40:14.742Z",
  "saStatus": "PENDING",
  "saStatusUnmapped": "text",
  "saUrl": "text",
  "saSignedAt": "2026-02-03T16:40:14.742Z",
  "saExtractedNumberOfShares": "text",
  "saExtractedTotalAmount": "text",
  "saExtractedPricePerShare": "text",
  "saExtractedInvestorType": "text",
  "saExtractedSigner": "text",
  "saExtractedSignatureDate": "2026-02-03T16:40:14.742Z",
  "saExtractedSigner2": "text",
  "saExtractedSignatureDate2": "2026-02-03T16:40:14.742Z",
  "saCheck": "PENDING",
  "saCheckedAt": "2026-02-03T16:40:14.742Z",
  "saLog": {
    "finalStatus": "PENDING",
    "matchResults": [
      {
        "tradeLineItemId": "trade_line_item_01kctsycw3fq7sj6hedvy62cja",
        "signerName": {
          "actual": "text",
          "status": "MATCHED",
          "extracted": "text",
          "corrected": "text"
        },
        "totalAmount": {
          "actual": "text",
          "status": "MATCHED",
          "extracted": "text",
          "corrected": "text"
        },
        "investorName": {
          "actual": "text",
          "status": "MATCHED",
          "extracted": "text",
          "corrected": "text"
        },
        "numberOfShares": {
          "actual": "text",
          "status": "MATCHED",
          "extracted": "text",
          "corrected": "text"
        }
      }
    ]
  },
  "txnTid": "text",
  "txnResponse": "text",
  "txnPaymentMethod": "CREDIT_CARD",
  "txnCurrencyCode": "text",
  "txnChargedAmount": 1,
  "txnDate": "2026-02-03T16:40:14.742Z",
  "txnSettledDate": "2026-02-03T16:40:14.742Z",
  "fundingStatus": "PENDING",
  "fundingStatusUnmapped": "text",
  "txnCheck": "PENDING",
  "txnCheckedAt": "2026-02-03T16:40:14.742Z",
  "txnLog": "text",
  "systemReviewCheck": "PENDING",
  "systemReviewCheckedAt": "2026-02-03T16:40:14.742Z",
  "systemReviewLog": "text",
  "complianceReview": "PENDING",
  "complianceReviewNotes": "text",
  "complianceReviewerId": "text",
  "issuerId": null,
  "complianceReviewName": "text",
  "complianceReviewAt": "2026-02-03T16:40:14.742Z",
  "tradeType": "PURCHASE",
  "placedAt": "2026-02-03T16:40:14.742Z",
  "platform": "text",
  "cancelledAt": "2026-02-03T16:40:14.742Z",
  "cancelledById": "text",
  "cancelledReason": "text",
  "cancellationPeriod": 1,
  "disbursed": true,
  "tradeAdjustments": 1,
  "chargedAmount": 1,
  "balance": 1,
  "isUncleared24h": true
}

Patch a trade status

patch

Authorizations

api_key

X-API-KEYstringRequired

Path parameters

idone ofRequired

stringOptional

or

string · min: 1 · max: 50OptionalExample: tid_00041061050r3gg28a1c60t3gf

Body

application/json

tradeStatusstring · enumRequiredPossible values:

Responses

201

201

application/json

400

400

application/json

401

401

application/json

403

403

application/json

500

500

application/json

patch

/clients/api/v1/trades/{id}

HTTPcURLJavaScriptPython

PATCH /clients/api/v1/trades/{id} HTTP/1.1
Host: platform.dalmoregroup.com
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 22

{
  "tradeStatus": "CART"
}

{
  "id": "entityprefix_01j1xgme5qeqq97gpdztd7e4a6",
  "__entity": "Entity",
  "createdAt": "2026-02-02T18:26:08.573Z",
  "updatedAt": "2026-02-02T18:26:08.573Z",
  "deletedAt": "2026-02-02T18:26:08.574Z",
  "investorAccountId": null,
  "investorAccount": null,
  "offering": null,
  "accountId": "account_01j1xgme5qeqq97gpdztd7e4a6",
  "account": null,
  "offeringId": null,
  "paymentMethodId": null,
  "paymentMethod": null,
  "userId": null,
  "tradeNumber": "text",
  "ip": "text",
  "tid": "text",
  "investmentType": "INDIVIDUAL",
  "purchasedShares": 1,
  "bonusShares": 1,
  "totalNumberOfShares": 1,
  "pricePerShare": 1,
  "lineItems": [],
  "adjustments": [],
  "transactions": [],
  "totalAmount": 1,
  "tradeStatus": "CART",
  "tradeStatusUnmapped": "text",
  "tradeDate": "2026-02-03T16:40:14.742Z",
  "saStatus": "PENDING",
  "saStatusUnmapped": "text",
  "saUrl": "text",
  "saSignedAt": "2026-02-03T16:40:14.742Z",
  "saExtractedNumberOfShares": "text",
  "saExtractedTotalAmount": "text",
  "saExtractedPricePerShare": "text",
  "saExtractedInvestorType": "text",
  "saExtractedSigner": "text",
  "saExtractedSignatureDate": "2026-02-03T16:40:14.742Z",
  "saExtractedSigner2": "text",
  "saExtractedSignatureDate2": "2026-02-03T16:40:14.742Z",
  "saCheck": "PENDING",
  "saCheckedAt": "2026-02-03T16:40:14.742Z",
  "saLog": {
    "finalStatus": "PENDING",
    "matchResults": [
      {
        "tradeLineItemId": "trade_line_item_01kctsycw3fq7sj6hedvy62cja",
        "signerName": {
          "actual": "text",
          "status": "MATCHED",
          "extracted": "text",
          "corrected": "text"
        },
        "totalAmount": {
          "actual": "text",
          "status": "MATCHED",
          "extracted": "text",
          "corrected": "text"
        },
        "investorName": {
          "actual": "text",
          "status": "MATCHED",
          "extracted": "text",
          "corrected": "text"
        },
        "numberOfShares": {
          "actual": "text",
          "status": "MATCHED",
          "extracted": "text",
          "corrected": "text"
        }
      }
    ]
  },
  "txnTid": "text",
  "txnResponse": "text",
  "txnPaymentMethod": "CREDIT_CARD",
  "txnCurrencyCode": "text",
  "txnChargedAmount": 1,
  "txnDate": "2026-02-03T16:40:14.742Z",
  "txnSettledDate": "2026-02-03T16:40:14.742Z",
  "fundingStatus": "PENDING",
  "fundingStatusUnmapped": "text",
  "txnCheck": "PENDING",
  "txnCheckedAt": "2026-02-03T16:40:14.742Z",
  "txnLog": "text",
  "systemReviewCheck": "PENDING",
  "systemReviewCheckedAt": "2026-02-03T16:40:14.742Z",
  "systemReviewLog": "text",
  "complianceReview": "PENDING",
  "complianceReviewNotes": "text",
  "complianceReviewerId": "text",
  "issuerId": null,
  "complianceReviewName": "text",
  "complianceReviewAt": "2026-02-03T16:40:14.742Z",
  "tradeType": "PURCHASE",
  "placedAt": "2026-02-03T16:40:14.742Z",
  "platform": "text",
  "cancelledAt": "2026-02-03T16:40:14.742Z",
  "cancelledById": "text",
  "cancelledReason": "text",
  "cancellationPeriod": 1,
  "disbursed": true,
  "tradeAdjustments": 1,
  "chargedAmount": 1,
  "balance": 1,
  "isUncleared24h": true
}

Get trades

get

Authorizations

api_key

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

200

200

application/json

401

401

application/json

403

403

application/json

get

/clients/api/v1/trades

HTTPcURLJavaScriptPython

GET /clients/api/v1/trades HTTP/1.1
Host: platform.dalmoregroup.com
X-API-KEY: YOUR_API_KEY
Accept: */*

{
  "items": [
    {
      "id": "entityprefix_01j1xgme5qeqq97gpdztd7e4a6",
      "__entity": "Entity",
      "createdAt": "2026-02-02T18:26:08.573Z",
      "updatedAt": "2026-02-02T18:26:08.573Z",
      "deletedAt": "2026-02-02T18:26:08.574Z",
      "investorAccountId": null,
      "investorAccount": null,
      "offering": null,
      "accountId": "account_01j1xgme5qeqq97gpdztd7e4a6",
      "account": null,
      "offeringId": null,
      "paymentMethodId": null,
      "paymentMethod": null,
      "userId": null,
      "tradeNumber": "text",
      "ip": "text",
      "tid": "text",
      "investmentType": "INDIVIDUAL",
      "purchasedShares": 1,
      "bonusShares": 1,
      "totalNumberOfShares": 1,
      "pricePerShare": 1,
      "lineItems": [],
      "adjustments": [],
      "transactions": [],
      "totalAmount": 1,
      "tradeStatus": "CART",
      "tradeStatusUnmapped": "text",
      "tradeDate": "2026-02-03T16:40:14.742Z",
      "saStatus": "PENDING",
      "saStatusUnmapped": "text",
      "saUrl": "text",
      "saSignedAt": "2026-02-03T16:40:14.742Z",
      "saExtractedNumberOfShares": "text",
      "saExtractedTotalAmount": "text",
      "saExtractedPricePerShare": "text",
      "saExtractedInvestorType": "text",
      "saExtractedSigner": "text",
      "saExtractedSignatureDate": "2026-02-03T16:40:14.742Z",
      "saExtractedSigner2": "text",
      "saExtractedSignatureDate2": "2026-02-03T16:40:14.742Z",
      "saCheck": "PENDING",
      "saCheckedAt": "2026-02-03T16:40:14.742Z",
      "saLog": {
        "finalStatus": "PENDING",
        "matchResults": [
          {
            "tradeLineItemId": "trade_line_item_01kctsycw3fq7sj6hedvy62cja",
            "signerName": {
              "actual": "text",
              "status": "MATCHED",
              "extracted": "text",
              "corrected": "text"
            },
            "totalAmount": {
              "actual": "text",
              "status": "MATCHED",
              "extracted": "text",
              "corrected": "text"
            },
            "investorName": {
              "actual": "text",
              "status": "MATCHED",
              "extracted": "text",
              "corrected": "text"
            },
            "numberOfShares": {
              "actual": "text",
              "status": "MATCHED",
              "extracted": "text",
              "corrected": "text"
            }
          }
        ]
      },
      "txnTid": "text",
      "txnResponse": "text",
      "txnPaymentMethod": "CREDIT_CARD",
      "txnCurrencyCode": "text",
      "txnChargedAmount": 1,
      "txnDate": "2026-02-03T16:40:14.742Z",
      "txnSettledDate": "2026-02-03T16:40:14.742Z",
      "fundingStatus": "PENDING",
      "fundingStatusUnmapped": "text",
      "txnCheck": "PENDING",
      "txnCheckedAt": "2026-02-03T16:40:14.742Z",
      "txnLog": "text",
      "systemReviewCheck": "PENDING",
      "systemReviewCheckedAt": "2026-02-03T16:40:14.742Z",
      "systemReviewLog": "text",
      "complianceReview": "PENDING",
      "complianceReviewNotes": "text",
      "complianceReviewerId": "text",
      "issuerId": null,
      "complianceReviewName": "text",
      "complianceReviewAt": "2026-02-03T16:40:14.742Z",
      "tradeType": "PURCHASE",
      "placedAt": "2026-02-03T16:40:14.742Z",
      "platform": "text",
      "cancelledAt": "2026-02-03T16:40:14.742Z",
      "cancelledById": "text",
      "cancelledReason": "text",
      "cancellationPeriod": 1,
      "disbursed": true,
      "tradeAdjustments": 1,
      "chargedAmount": 1,
      "balance": 1,
      "isUncleared24h": true
    }
  ],
  "meta": {
    "itemCount": 1,
    "totalItems": 10,
    "itemsPerPage": 1,
    "totalPages": 10,
    "currentPage": 1
  }
}

Create Trades

post

Authorizations

api_key

X-API-KEYstringRequired

Body

application/json

investorAccountIdanyOptional

investmentTypestring · enumOptionalPossible values:

Responses

201

201

application/json

401

401

application/json

403

403

application/json

post

/clients/api/v1/trades/

HTTPcURLJavaScriptPython

POST /clients/api/v1/trades/ HTTP/1.1
Host: platform.dalmoregroup.com
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 56

{
  "investorAccountId": null,
  "investmentType": "INDIVIDUAL"
}

{
  "id": "entityprefix_01j1xgme5qeqq97gpdztd7e4a6",
  "__entity": "Entity",
  "createdAt": "2026-02-02T18:26:08.573Z",
  "updatedAt": "2026-02-02T18:26:08.573Z",
  "deletedAt": "2026-02-02T18:26:08.574Z",
  "investorAccountId": null,
  "accountId": "text",
  "offeringId": "text",
  "tid": "text",
  "investmentType": "INDIVIDUAL",
  "purchasedShares": 1,
  "bonusShares": 1,
  "totalNumberOfShares": 1,
  "pricePerShare": 1,
  "totalAmount": 1,
  "tradeStatus": "CART",
  "tradeStatusUnmapped": "text",
  "tradeDate": "2026-02-03T16:40:14.742Z",
  "paymentMethodId": null
}

Create a Line Item

post

Authorizations

api_key

X-API-KEYstringRequired

Query parameters

resetstringOptionalDefault: false

Body

application/json

assetIdstringRequiredExample: asset_00041061050r3gg28a1c60t3gf

quantitynumber · max: 1000000000Required

Responses

201

201

application/json

400

400

application/json

401

401

application/json

403

403

application/json

500

500

application/json

post

/clients/api/v1/trades/line-items

HTTPcURLJavaScriptPython

POST /clients/api/v1/trades/line-items HTTP/1.1
Host: platform.dalmoregroup.com
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 59

{
  "assetId": "asset_00041061050r3gg28a1c60t3gf",
  "quantity": 1
}

{
  "assetName": "text",
  "total": 1,
  "pricePerShare": 1,
  "id": "trade_line_item_01kctsycw3fq7sj6hedvy62cja",
  "quantity": 1
}

Attach subdoc to trade

post

Authorizations

api_key

X-API-KEYstringRequired

Path parameters

idone ofRequired

stringOptional

or

string · min: 1 · max: 50OptionalExample: tid_00041061050r3gg28a1c60t3gf

Body

application/json

lineItemIdstringRequiredExample: trade_line_item_01kctsycw3fq7sj6hedvy62cja

fileIdanyRequiredExample: file_01je6ht4b8fbmttkzh2hs82xqp

primarySignatureStatusstring · enumRequiredExample: SIGNEDPossible values:

secondarySignatureStatusstring · enumOptionalExample: SIGNEDPossible values:

Responses

200

200

application/json

400

400

application/json

401

401

application/json

403

403

application/json

404

404

application/json

500

500

application/json

post

/clients/api/v1/trades/{id}/attach-subdoc

HTTPcURLJavaScriptPython

POST /clients/api/v1/trades/{id}/attach-subdoc HTTP/1.1
Host: platform.dalmoregroup.com
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 172

{
  "lineItemId": "trade_line_item_01kctsycw3fq7sj6hedvy62cja",
  "fileId": "file_01je6ht4b8fbmttkzh2hs82xqp",
  "primarySignatureStatus": "SIGNED",
  "secondarySignatureStatus": "SIGNED"
}

{
  "success": true,
  "message": "text"
}

Update attached subdoc for trade

put

Authorizations

api_key

X-API-KEYstringRequired

Path parameters

idone ofRequired

stringOptional

or

string · min: 1 · max: 50OptionalExample: tid_00041061050r3gg28a1c60t3gf

Body

application/json

lineItemIdstringOptionalExample: trade_line_item_01kctsycw3fq7sj6hedvy62cja

fileIdanyOptionalExample: file_01je6ht4b8fbmttkzh2hs82xqp

primarySignatureStatusstring · enumOptionalExample: SIGNEDPossible values:

secondarySignatureStatusstring · enumOptionalExample: SIGNEDPossible values:

Responses

200

200

application/json

400

400

application/json

401

401

application/json

403

403

application/json

404

404

application/json

500

500

application/json

put

/clients/api/v1/trades/{id}/attach-subdoc

HTTPcURLJavaScriptPython

PUT /clients/api/v1/trades/{id}/attach-subdoc HTTP/1.1
Host: platform.dalmoregroup.com
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 172

{
  "lineItemId": "trade_line_item_01kctsycw3fq7sj6hedvy62cja",
  "fileId": "file_01je6ht4b8fbmttkzh2hs82xqp",
  "primarySignatureStatus": "SIGNED",
  "secondarySignatureStatus": "SIGNED"
}

{
  "success": true,
  "message": "text"
}

Update subdoc signature statuses for trade

patch

Authorizations

api_key

X-API-KEYstringRequired

Path parameters

idone ofRequired

stringOptional

or

string · min: 1 · max: 50OptionalExample: tid_00041061050r3gg28a1c60t3gf

Body

application/json

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

200

200

application/json

400

400

application/json

401

401

application/json

403

403

application/json

404

404

application/json

500

500

application/json

patch

/clients/api/v1/trades/{id}/sign

HTTPcURLJavaScriptPython

PATCH /clients/api/v1/trades/{id}/sign HTTP/1.1
Host: platform.dalmoregroup.com
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 129

{
  "lineItemId": "trade_line_item_01kctsycw3fq7sj6hedvy62cja",
  "primarySignatureStatus": "SIGNED",
  "secondarySignatureStatus": "SIGNED"
}

{
  "success": true,
  "message": "text"
}