Equities

get

Retrieve a list of equities available in the system

Query parameters

modestring · enumOptional

Strategy applied when filtering/searching on multiple fields

Possible values:

orderanyOptional

Array of fields and directions to order. Supported fields: createdAt, nominalValue, issueDate, status, name, supply, undistributedAmount

Responses

200

Successfully retrieved a list of items.

application/json

get

/equities

HTTPcURLJavaScriptPython

GET /equities HTTP/1.1
Host: 
Accept: */*

200

Successfully retrieved a list of items.

{
  "pagination": {
    "size": 10,
    "page": 1,
    "totalItems": 25,
    "totalPages": 3
  },
  "items": [
    {
      "createdAt": "2025-12-14T02:07:43.581Z",
      "updatedAt": "2025-12-14T02:07:43.581Z",
      "id": "acd9090d-dc68-45b1-8192-b21feb596f6d",
      "currencyId": "61d68b4b-80ca-4998-8851-87eac97c4acd",
      "issuerId": "a0308c1f-1bad-439d-8d48-3c3c0804669f",
      "nominalValue": 10000,
      "issueDate": "2024-05-09T10:00:00.000Z",
      "status": "recorded",
      "issuingAccountAddress": "rCZ7MjgELsRmhhndtbqGyq1SBEc7NNJMb",
      "operationalAccountAddress": "rfFNMxPQrtW2KWn8uA8uGzcyAV3n9LqoRn",
      "name": "UAB Trys Gaideliai nematerialios akcijos",
      "supply": 5000000,
      "ipfsLink": "/ipfs/QmPZMtMmLMWQGCsASnMZVhn8c4kuryiAAFiqWGF4uGbNSo",
      "isin": "US4592001014",
      "undistributedAmount": 2000
    }
  ]
}

post

Create a new equity. Prepares blockchain accounts and issues provided total supply from cold to warm wallet. Makes equity ready for distribution.

Body

application/json

namestringRequired

A user friendly name of the asset (ex. Orange Bond)

Example: UAB Trys Gaideliai nematerialios akcijos

totalSupplyinteger · int64Required

Total supply of the asset that exist amongst all existing platforms together

Example: 5000000

currencyIdstring · uuidRequired

Unique UUID of the currency in scope of this gateway provided

Example: f6c3e50c-d382-4417-96aa-da84ecc1a100

issuerIdstring · uuidRequired

Unique UUID of issuer in scope of this gateway

Example: 4fe871d5-a1b5-434e-ae33-352760445101

nominalValueinteger · int64Required

Price of ONE share in sub-units

Example: 10000

issueDatestring · date-timeRequired

Issue registration date

Example: 2024-05-09T10:00:00.000Z

isinstring | nullableOptional

An International Securities Identification Number

Example: US4592001014

Responses

201

Successfully created an equity.

application/json

post

/equities

HTTPcURLJavaScriptPython

POST /equities HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 257

{
  "name": "UAB Trys Gaideliai nematerialios akcijos",
  "totalSupply": 5000000,
  "currencyId": "f6c3e50c-d382-4417-96aa-da84ecc1a100",
  "issuerId": "4fe871d5-a1b5-434e-ae33-352760445101",
  "nominalValue": 10000,
  "issueDate": "2024-05-09T10:00:00.000Z",
  "isin": "US4592001014"
}

201

Successfully created an equity.

{
  "createdAt": "2025-12-14T02:07:43.581Z",
  "updatedAt": "2025-12-14T02:07:43.581Z",
  "id": "acd9090d-dc68-45b1-8192-b21feb596f6d",
  "currencyId": "61d68b4b-80ca-4998-8851-87eac97c4acd",
  "issuerId": "a0308c1f-1bad-439d-8d48-3c3c0804669f",
  "nominalValue": 10000,
  "issueDate": "2024-05-09T10:00:00.000Z",
  "status": "recorded",
  "issuingAccountAddress": "rCZ7MjgELsRmhhndtbqGyq1SBEc7NNJMb",
  "operationalAccountAddress": "rfFNMxPQrtW2KWn8uA8uGzcyAV3n9LqoRn",
  "name": "UAB Trys Gaideliai nematerialios akcijos",
  "supply": 5000000,
  "ipfsLink": "/ipfs/QmPZMtMmLMWQGCsASnMZVhn8c4kuryiAAFiqWGF4uGbNSo",
  "isin": "US4592001014",
  "undistributedAmount": 2000
}

get

Retrieve full information about a single equity, specified by equity id in the path.

Path parameters

equityIdstring · uuidRequired

Equity UUID identifier, unique in scope of this node

Example: f3fb686a-4553-4df9-a5df-19e6e7d8a8ff

Responses

200

Successfully received equity.

application/json

get

/equities/{equityId}

HTTPcURLJavaScriptPython

GET /equities/{equityId} HTTP/1.1
Host: 
Accept: */*

200

Successfully received equity.

{
  "createdAt": "2025-12-14T02:07:43.581Z",
  "updatedAt": "2025-12-14T02:07:43.581Z",
  "id": "acd9090d-dc68-45b1-8192-b21feb596f6d",
  "currencyId": "61d68b4b-80ca-4998-8851-87eac97c4acd",
  "issuerId": "a0308c1f-1bad-439d-8d48-3c3c0804669f",
  "nominalValue": 10000,
  "issueDate": "2024-05-09T10:00:00.000Z",
  "status": "recorded",
  "issuingAccountAddress": "rCZ7MjgELsRmhhndtbqGyq1SBEc7NNJMb",
  "operationalAccountAddress": "rfFNMxPQrtW2KWn8uA8uGzcyAV3n9LqoRn",
  "name": "UAB Trys Gaideliai nematerialios akcijos",
  "supply": 5000000,
  "ipfsLink": "/ipfs/QmPZMtMmLMWQGCsASnMZVhn8c4kuryiAAFiqWGF4uGbNSo",
  "isin": "US4592001014",
  "undistributedAmount": 2000
}

patch

Issue additional equity tokens or burn existing ones, changing the total supply and, if chosen, nominal value.

Path parameters

equityIdstring · uuidRequired

Equity UUID identifier, unique in scope of this node

Example: f3fb686a-4553-4df9-a5df-19e6e7d8a8ff

Body

application/json

supplyinteger · int64Optional

Change supply of the equity to new amount (implies issuing additional equities or burning existing ones)

Example: 100

nominalValueinteger · int64Optional

New nominal value of the equity. If not provided, will remain the same.

Example: 10000

statusall ofOptional

Update equity status:

• closed - close equity

Example: closed

string · enumOptional

Status of equity

Possible values:

referencestringRequired

Reference to a document or corporate action number, etc. - anything that could help relate supply or nominal value change with other context

Example: Stock-split No. 12345

recordedAtstring · date-timeRequired

Day when the action was documented to be executed. This is not necessarily the day when the equity is actually changing supply or nominal value

Example: 2024-05-09T10:00:00.000Z

Responses

200

Equity successfully updated.

application/json

patch

/equities/{equityId}

HTTPcURLJavaScriptPython

PATCH /equities/{equityId} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 129

{
  "supply": 100,
  "nominalValue": 10000,
  "status": "closed",
  "reference": "Stock-split No. 12345",
  "recordedAt": "2024-05-09T10:00:00.000Z"
}

200

Equity successfully updated.

{
  "createdAt": "2025-12-14T02:07:43.581Z",
  "updatedAt": "2025-12-14T02:07:43.581Z",
  "id": "acd9090d-dc68-45b1-8192-b21feb596f6d",
  "currencyId": "61d68b4b-80ca-4998-8851-87eac97c4acd",
  "issuerId": "a0308c1f-1bad-439d-8d48-3c3c0804669f",
  "nominalValue": 10000,
  "issueDate": "2024-05-09T10:00:00.000Z",
  "status": "recorded",
  "issuingAccountAddress": "rCZ7MjgELsRmhhndtbqGyq1SBEc7NNJMb",
  "operationalAccountAddress": "rfFNMxPQrtW2KWn8uA8uGzcyAV3n9LqoRn",
  "name": "UAB Trys Gaideliai nematerialios akcijos",
  "supply": 5000000,
  "ipfsLink": "/ipfs/QmPZMtMmLMWQGCsASnMZVhn8c4kuryiAAFiqWGF4uGbNSo",
  "isin": "US4592001014",
  "undistributedAmount": 2000
}

post

Deduct equities from investors.

Path parameters

equityIdstring · uuidRequired

Equity UUID identifier, unique in scope of this node

Example: f3fb686a-4553-4df9-a5df-19e6e7d8a8ff

Body

application/json

referencestringRequired

Reference to a document or corporate action number, etc. - anything that could help relate deduction actions with other context

Example: Stock-split No. 12345

recordedAtstring · date-timeRequired

Day when the action was documented to be executed. This is not necessarily the day when the equity is actually deducted from the investor.

Example: 2024-05-09T10:00:00.000Z

Responses

201

Successfully created equity deduction

application/json

post

/equities/{equityId}/deductions

HTTPcURLJavaScriptPython

POST /equities/{equityId}/deductions HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 154

{
  "reference": "Stock-split No. 12345",
  "recordedAt": "2024-05-09T10:00:00.000Z",
  "deductees": [
    {
      "address": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
      "amount": 1000
    }
  ]
}

201

Successfully created equity deduction

[
  {
    "id": "2aff4a97-6160-4bae-9a1b-a684352513c4",
    "equityId": "8facf9b4-d456-434f-8522-8e2e7c7fb05e",
    "accountAddress": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
    "amount": 10,
    "reference": "Stock-split No. 12345",
    "recordedAt": "2024-05-09T10:00:00.000Z",
    "status": "successful"
  }
]

post

Create equity distribution.

Path parameters

equityIdstring · uuidRequired

Equity UUID identifier, unique in scope of this node

Example: f3fb686a-4553-4df9-a5df-19e6e7d8a8ff

Body

application/json

referencestringRequired

Reference to a document or corporate action number, etc. - anything that could help relate distribution actions with other context

Example: Stock-split No. 12345

recordedAtstring · date-timeRequired

Day when the action was documented to be executed. This is not necessarily the day when the equity is actually distributed to the investor.

Example: 2024-05-09T10:00:00.000Z

Responses

201

Successfully created equity distribution

application/json

post

/equities/{equityId}/distributions

HTTPcURLJavaScriptPython

POST /equities/{equityId}/distributions HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 155

{
  "reference": "Stock-split No. 12345",
  "recordedAt": "2024-05-09T10:00:00.000Z",
  "distributees": [
    {
      "address": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
      "amount": 10
    }
  ]
}

201

Successfully created equity distribution

[
  {
    "id": "b98a0216-d649-4abe-a76f-d91a04c44f76",
    "equityId": "472c5c99-c3f5-46a3-8f53-931adeb0d307",
    "accountAddress": "r49wKDuk5e7oZNHiY5GtwBeAo7ioGoxoH",
    "amount": 10,
    "reference": "Stock-split No. 12345",
    "recordedAt": "2024-05-09T10:00:00.000Z",
    "status": "successful"
  }
]

get

Retrieve a list of accounts with balance for specified equity.

Path parameters

equityIdstring · uuidRequired

Equity UUID identifier, unique in scope of this node

Example: f3fb686a-4553-4df9-a5df-19e6e7d8a8ff

Query parameters

Responses

200

Successfully retrieved a list of items.

application/json

get

/equities/{equityId}/accounts

HTTPcURLJavaScriptPython

GET /equities/{equityId}/accounts HTTP/1.1
Host: 
Accept: */*

200

Successfully retrieved a list of items.

{
  "pagination": {
    "size": 10,
    "page": 1,
    "totalItems": 25,
    "totalPages": 3
  },
  "items": [
    {
      "account": {
        "createdAt": "2025-12-14T02:07:43.581Z",
        "updatedAt": "2025-12-14T02:07:43.581Z",
        "nodeId": "fb098963-aa15-48e0-94cf-84d5b3829044",
        "address": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
        "type": "investor",
        "institutionSectorCode": "S.11",
        "walletType": "client-individual",
        "status": "active",
        "openedAt": "2025-12-14T02:07:43.581Z"
      },
      "amount": 10
    }
  ]
}