reserve

Create a reserve (admin only)

post/reserves

Request body

namestring required

Reserve name

countrystring required

Country

countryCodestring

ISO 3166-1 alpha-2 country code (lowercased). Used by the frontend to render the flag sprite (e.g. "au" => flag-au).

citystring required

City

latnumber required

Latitude

lngnumber required

Longitude

type1 | 2 | 3 required

Reserve type

paymentFromType1 | 2 | 3 | 4 | 5 | 6 | 7

How reserve payments are funded. Required for off-chain reserves (USD or USDC). Omit for on-chain cash equivalents — set automatically to USDC.

paymentFromValuenumber required

Value in wei of the payment from amount

status'Active' | 'Coming soon' | 'Expired' required

Reserve status

valuenumber required

Value in USD cents (integer)

apynumber required

APY with 4 decimal places (e.g. 5.2500% => 52500).

startDatestring date-time

Reserve period start. Required except for property credit reserves, where it may be omitted (e.g. coming soon).

endDatestring date-time

Reserve period end. Required except for property credit reserves, where it may be omitted (e.g. coming soon).

dataobject required

Type-specific reserve data (stored as JSONB). For secured loans include paymentFrequency. For cash equivalents use ticker, custodian, liquidity, optional rating, and when the position is on-chain (cashEquivalentType blockchain) also yieldSource, valueUSDC, wallet, networkName, chainId, and contractAddress. For property credit all fields are optional: collateral, estimated GDV, current/max LTV, loan status, project phase, ranking, backstop facility (amount and provider), and term (whole days).

Example request

{
  "name": "US T-Bills - 3M",
  "country": "United States",
  "countryCode": "us",
  "city": "New York",
  "lat": 40.7128,
  "lng": -74.006,
  "type": 2,
  "paymentFromValue": 250000000,
  "status": "Active",
  "value": 250000000,
  "apy": 52500,
  "startDate": "2026-01-01T00:00:00.000Z",
  "endDate": "2026-12-31T00:00:00.000Z"
}

Response

Reserve created

Reserve required

Changes

No recorded changes to this endpoint across all 1 revision of this API.