Assets

Get assets

get
Authorizations
X-API-KEYstringRequired
Query parameters
pagenumber · nullableOptionalDefault: 1
limitnumber · nullableOptionalDefault: 10
includestringOptionalExample: account, offering, bonusTiers
namestringOptional
accountIdstringOptionalExample: account_01j1xgme5qeqq97gpdztd7e4a6
offeringIdanyOptionalExample: offering_01jayn2qkpeebav9gjpqx7xm8j
issuerIdanyOptional
typestring · enumOptionalPossible values:
Responses
chevron-right
200

200

application/json
get
/clients/api/v1/assets

Create an asset

post
Authorizations
X-API-KEYstringRequired
Body
offeringIdanyRequiredExample: offering_01jayn2qkpeebav9gjpqx7xm8j
namestring · min: 2 · max: 50RequiredExample: Asset name
typestring · enumRequiredExample: STOCKPossible values:
pricePerUnitnumber · min: 0.01 · max: 10000000000 · nullableRequiredExample: 2000
totalUnitsnumber · min: 1 · max: 10000000000 · nullableRequiredExample: 5200
yieldnumber · min: 0.01 · max: 10000000000 · nullableOptionalExample: 1200
durationnumber · min: 1 · max: 1000 · nullableOptionalExample: 1
durationTypestring · enum · nullableOptionalExample: DAYSPossible values:
templatestring · enumOptionalDefault: STANDARDExample: STANDARDPossible values:
tiersnumber[] · nullableOptional
enableBonusbooleanOptionalDefault: falseExample: false
interestRatenumber · min: 0.01 · max: 100 · nullableOptionalExample: 10
Responses
post
/clients/api/v1/assets

Get asset by id

get
Authorizations
X-API-KEYstringRequired
Path parameters
idstringRequiredExample: asset_00041061050r3gg28a1c60t3gf
Query parameters
includestringOptionalExample: account, offering, bonusTiers
Responses
chevron-right
200

200

application/json
idstringRequiredExample: asset_00041061050r3gg28a1c60t3gf
__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
namestringRequired
typestring · enum · nullableRequiredPossible values:
pricePerUnitnumber · nullableRequired
totalUnitsnumber · nullableRequired
totalAmountnumber · nullableRequired
yieldnumber · nullableRequired
durationnumber · nullableRequired
durationTypestring · enum · nullableRequiredPossible values:
accountIdstringRequired
offeringIdstringRequired
offeringany · nullableOptional
templatestring · enumRequiredPossible values:
tiersnumber[] · nullableRequired
enableBonusbooleanRequired
interestRatenumber · nullableRequired
get
/clients/api/v1/assets/{id}

Update asset

put
Authorizations
X-API-KEYstringRequired
Path parameters
idstringRequiredExample: asset_00041061050r3gg28a1c60t3gf
Body
namestring · min: 2 · max: 50OptionalExample: Z
typestring · enumOptionalExample: STOCKPossible values:
pricePerUnitnumber · min: 0.01 · max: 10000000000 · nullableOptionalExample: 2000
totalUnitsnumber · min: 1 · max: 10000000000 · nullableOptionalExample: 5200
yieldnumber · min: 0.01 · max: 10000000000 · nullableOptionalExample: 1200
durationnumber · min: 1 · max: 1000 · nullableOptionalExample: 1
durationTypestring · enum · nullableOptionalExample: DAYSPossible values:
templatestring · enum · nullableOptionalDefault: STANDARDExample: STANDARDPossible values:
tiersnumber[] · nullableOptional
enableBonusbooleanOptionalExample: false
interestRatenumber · min: 0.01 · max: 100 · nullableOptionalExample: 10
Responses
put
/clients/api/v1/assets/{id}

Last updated