ar.io DocumentationBalance
Account balance and credit management
Get Current Balance of winc
Use a signed request or a previously obtained JWT to get the signing wallet's current service balance in winc
Query Parameters
Destination wallet address, required if no signature headers are provided
Header Parameters
The signature value derived from signing the request's data concatenated with the provided nonce using the private key from the provided public key
The nonce value concatenated with the request's data when deriving the provided the signature
The "modulus" of the JWK used to create the signature header
Response Body
curl -X GET "https://turbo.ardrive.io/v1/balance?address=string" \ -H "x-signature: string" \ -H "x-nonce: string" \ -H "x-public-key: string"{
"controlledWinc": "string",
"winc": "string",
"effectiveBalance": "string",
"givenApprovals": [
{
"approvalDataItemId": "abcdefghijklmnopqrxtuvwxyz123456789ABCDEFGH",
"approvedAddress": "abcdefghijklmnopqrxtuvwxyz123456789ABCDEFGH",
"payingAddress": "abcdefghijklmnopqrxtuvwxyz123456789ABCDEFGH",
"approvedWincAmount": "332824926",
"usedWincAmount": "332824926",
"creationDate": "2023-05-17T21:46:38.404Z",
"expirationDate": "2023-05-17T21:46:38.404Z"
}
],
"receivedApprovals": [
{
"approvalDataItemId": "abcdefghijklmnopqrxtuvwxyz123456789ABCDEFGH",
"approvedAddress": "abcdefghijklmnopqrxtuvwxyz123456789ABCDEFGH",
"payingAddress": "abcdefghijklmnopqrxtuvwxyz123456789ABCDEFGH",
"approvedWincAmount": "332824926",
"usedWincAmount": "332824926",
"creationDate": "2023-05-17T21:46:38.404Z",
"expirationDate": "2023-05-17T21:46:38.404Z"
}
]
}"Invalid signature or missing required headers""User Not Found""Database unavailable"Get a wallet's remaining free-tier allowance
Open-by-address, read-only, and advisory: how much of the free tier a
wallet has left, so a client can decide up front whether an upload will be
free. Unlike /balance this works for a wallet with no account row yet (a
brand-new or free-only wallet still has a full allowance), so it never
404s the free-tier audience. The authoritative decision still happens at
upload time (reserve-balance), and the figure is a point-in-time snapshot.
Query Parameters
Wallet address to look up (Arweave, Ethereum, or Solana). Ethereum addresses are normalized to their EIP-55 checksum form.
Response Body
curl -X GET "https://turbo.ardrive.io/v1/account/free?address=string"{
"bytesRemaining": 0
}"Missing address in query parameters""Cloud Database Unavailable"Get Current Balance of winc (ecosystem-compatible)
Stable-API alias for the balance lookup. Resolves the wallet address from
the address query parameter (or a signed request) and returns the
current balance in winc.
Query Parameters
Wallet address to look up. Required if no signature headers are provided.
Header Parameters
The signature value derived from signing the request's data concatenated with the provided nonce using the private key from the provided public key
The nonce value concatenated with the request's data when deriving the provided the signature
The "modulus" of the JWK used to create the signature header
Response Body
curl -X GET "https://turbo.ardrive.io/v1/account/balance?address=string" \ -H "x-signature: string" \ -H "x-nonce: string" \ -H "x-public-key: string"{
"controlledWinc": "string",
"winc": "string",
"effectiveBalance": "string",
"givenApprovals": [
{
"approvalDataItemId": "abcdefghijklmnopqrxtuvwxyz123456789ABCDEFGH",
"approvedAddress": "abcdefghijklmnopqrxtuvwxyz123456789ABCDEFGH",
"payingAddress": "abcdefghijklmnopqrxtuvwxyz123456789ABCDEFGH",
"approvedWincAmount": "332824926",
"usedWincAmount": "332824926",
"creationDate": "2023-05-17T21:46:38.404Z",
"expirationDate": "2023-05-17T21:46:38.404Z"
}
],
"receivedApprovals": [
{
"approvalDataItemId": "abcdefghijklmnopqrxtuvwxyz123456789ABCDEFGH",
"approvedAddress": "abcdefghijklmnopqrxtuvwxyz123456789ABCDEFGH",
"payingAddress": "abcdefghijklmnopqrxtuvwxyz123456789ABCDEFGH",
"approvedWincAmount": "332824926",
"usedWincAmount": "332824926",
"creationDate": "2023-05-17T21:46:38.404Z",
"expirationDate": "2023-05-17T21:46:38.404Z"
}
]
}"Invalid signature or missing required headers""User Not Found"Get Current Balance of winc for a token (ecosystem-compatible)
Stable-API alias for the balance lookup, scoped by a token path segment
(currently unused - kept for ecosystem compatibility). Resolves the wallet
address from the address query parameter (or a signed request) and
returns the current balance in winc.
Path Parameters
Currently unused, kept for ecosystem compatibility.
Query Parameters
Wallet address to look up. Required if no signature headers are provided.
Header Parameters
The signature value derived from signing the request's data concatenated with the provided nonce using the private key from the provided public key
The nonce value concatenated with the request's data when deriving the provided the signature
The "modulus" of the JWK used to create the signature header
Response Body
curl -X GET "https://turbo.ardrive.io/v1/account/balance/arweave?address=string" \ -H "x-signature: string" \ -H "x-nonce: string" \ -H "x-public-key: string"{
"controlledWinc": "string",
"winc": "string",
"effectiveBalance": "string",
"givenApprovals": [
{
"approvalDataItemId": "abcdefghijklmnopqrxtuvwxyz123456789ABCDEFGH",
"approvedAddress": "abcdefghijklmnopqrxtuvwxyz123456789ABCDEFGH",
"payingAddress": "abcdefghijklmnopqrxtuvwxyz123456789ABCDEFGH",
"approvedWincAmount": "332824926",
"usedWincAmount": "332824926",
"creationDate": "2023-05-17T21:46:38.404Z",
"expirationDate": "2023-05-17T21:46:38.404Z"
}
],
"receivedApprovals": [
{
"approvalDataItemId": "abcdefghijklmnopqrxtuvwxyz123456789ABCDEFGH",
"approvedAddress": "abcdefghijklmnopqrxtuvwxyz123456789ABCDEFGH",
"payingAddress": "abcdefghijklmnopqrxtuvwxyz123456789ABCDEFGH",
"approvedWincAmount": "332824926",
"usedWincAmount": "332824926",
"creationDate": "2023-05-17T21:46:38.404Z",
"expirationDate": "2023-05-17T21:46:38.404Z"
}
]
}"Invalid signature or missing required headers""User Not Found"How is this guide?