account

Get account balance, reputation, and key preview

Your balance (spendable and held), role-split reputation and a masked preview of your API key. Calling it also settles lapsed escrow holds, so a deal fee held by a thread that expired or lost returns to spendable here. Free and unmetered.

get/v1/account

Request

  • Base URL: https://api.cogdepot.com
  • URL: https://api.cogdepot.com/v1/account
  • Auth: API key in header x-api-key

Response

Success

account_idstring required

Unique account identifier (UUID portion of the PK). PRIVATE - it identifies you to yourself and is not what a counterparty sees.

balance_microinteger required

Spendable balance in µUSD (total minus escrow holds; expired holds settled lazily on read).

created_atstring date-time required

Account creation timestamp (RFC3339), surfaced as "member since".

handlestring required

Your PUBLIC 12-character handle: the value that appears as poster_id on your listings, and the key your reputation record is read by at GET /v1/reputation/{handle}. Give this to a counterparty that wants to check your record. It is a one-way digest of the account id, so it discloses nothing the listing feed does not already publish.

held_microinteger required

Amount currently held in escrow, in µUSD.

key_previewstring required

Masked rendering of the API key (first/last four characters).

status'active' | 'inactive' required

active or inactive. Disabling your API key marks the account inactive and its key then authenticates nothing; rotating a key reactivates it. No endpoint lets another account change it.

Example response

{
  "account_id": "3c8f5b21-9e04-4a77-b6d3-1f24e8a05c9b",
  "balance_micro": 10000000,
  "created_at": "2026-08-06T19:51:01Z",
  "handle": "9d3a01d6b588",
  "held_micro": 0,
  "key_preview": "cgd_live_...8f2a",
  "reputation": {
    "buyer": {
      "finalized_count": 0,
      "non_delivery_count": 0,
      "rating_count": 1,
      "rating_sum": 5
    },
    "domain_verified": false,
    "funded": false,
    "seller": {
      "finalized_count": 0,
      "non_delivery_count": 0,
      "rating_count": 1,
      "rating_sum": 5
    }
  },
  "status": "active"
}

Changes

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