---
title: "The caller's wallet balance"
method: GET
path: "/api/v1/me/wallet"
tags: ["wallet"]
---

# The caller's wallet balance

`GET /api/v1/me/wallet`

## Request

- Base URL: `https://goshipyard.app`
- URL: `https://goshipyard.app/api/v1/me/wallet`
- Auth: HTTP bearer

Returns the spendable credit balance and a `topup_url`. Top-ups settle via Stripe Checkout in the browser, so load credit by opening `topup_url` — not through the API.

## Response `200`

The wallet.

- Wallet
  - `balance_cents` integer, required: Spendable credit, in cents.
  - `balance` string, required: Balance formatted as dollars, e.g. "$25.00".
  - `currency` string, required
  - `topup_url` string, uri, required: Open this in a browser to load credit (Stripe Checkout).
  - `recent` LedgerEntry[], required: The most recent ledger entries (up to 10).
    - `kind` string, required: deposit | withdrawal | bounty_fund | bounty_refund | payout
    - `amount_cents` integer, required: Signed: positive = credit, negative = debit.
    - `balance_after` integer, required
    - `memo` string
    - `created_at` string, date-time, required

## Other responses

- `401`: Missing or invalid API key.
- `429`: Too many requests — slow down.

---

[API](https://skmtc.dev/goshipyard/apis/shipyard-api.md) · [All operations](https://skmtc.dev/goshipyard/apis/shipyard-api/llms.txt) · [OpenAPI document](https://skmtc.dev/goshipyard/apis/shipyard-api/revisions/8f12372f1065?raw)
