Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Basic authentication using the partner API keys from https://console.grainfinance.co/keys

Path Parameters

walletId
string<uuid>
required

The id of the wallet within the Grain platform.

Pattern: [0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}

Response

Wallet Retrieved

id
string<uuid>
required

The UUID of the Wallet in Grain's system.

Pattern: [0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}
Example:

"1b0ada1e-fa1b-4cfe-a553-01b340c5650e"

totalBalance
number<double>
required

The current balance, in the wallet currency.

Example:

10525

availableBalance
number<double>
required

The available balance (total minus reserved/pending amounts), in the wallet currency.

Example:

8500

collateralAmount
number<double> | null
required

The collateral amount held against open hedges, in the wallet currency.

Example:

2025

currency
string
required

The wallet currency (ISO 4217)

Example:

"EUR"

depositDetails
object
required

Account details for depositing funds to this wallet