Skip to main content
GET
/
get-investments-by-sto-id
Get investments associated with a specific STO ID
curl --request GET \
  --url https://api.sandbox.brickken.com/get-investments-by-sto-id \
  --header 'x-api-key: <api-key>'
{
  "offeringTransactionsList": [
    {
      "id": "42594b34-1c1f-4e03-9dd2-78b16ff9826e",
      "date": "2024-06-06T09:35:43.106Z",
      "user": "investor.email@example.com",
      "amountInUSD": "500.00",
      "status": "invest",
      "txHash": "0xabcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890",
      "currency": "USDC"
    }
  ],
  "total": 42
}
Retrieves investments for a specific STO.

​
Query Parameters

  • tokenSymbol (required): Token symbol
  • id (required): STO ID

​
Example

curl --request GET \
  --url 'https://api.sandbox.brickken.com/get-investments-by-sto-id?tokenSymbol=EXMPL&id=123' \
  --header 'x-api-key: YOUR_API_KEY'

​
Response

{
  "investments": [
    {
      "investorAddress": "0x...",
      "amount": "1000",
      "timestamp": 1234567890
    }
  ]
}

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
tokenSymbol
string
required

The symbol of the token.

​
id
string<uuid>
required

The unique identifier (UUID) of the STO.

Response

200 - application/json

Successful response - Investments for the specified STO retrieved.

Contains a list of offering transactions and the total count.

​
offeringTransactionsList
object[]
required

An array containing the details of offering-related transactions (investments for this STO).

​
total
integer<int32>
required

The total number of investment records found for this STO.

Example:

42