Gyvar docs
API reference v1Addresses

The Address object

The shape of an address wherever the API returns one.

Every endpoint that returns an address returns this shape, wrapped in a data envelope.

Attributes

id

uuid · always present

Gyvar's id for this address.

chain

enum · always present

A chain that can hold a receive address. Lightning uses invoices instead. One of: bitcoin, tron, ethereum, polygon, solana, base, bsc.

address

string · always present

The on-chain address. Send funds here.

assets

array of string · always present

Every asset this address credits, e.g. ["USDT","USDC"] on ethereum.

label

string · optional

—

reference

string · optional

—

created_at

timestamp · always present

—

The Address object
{
  "id": "0d6c2f3a-1b4e-4c9a-9f2d-7a1e5c8b3d60",
  "chain": "bitcoin",
  "address": "0x2f1a9C4b7E3d5A8f6B0c1D4e7A9b2C5d8E3f6A1b",
  "assets": [
    "USDT",
    "USDC"
  ],
  "label": "Ama Owusu",
  "reference": "customer_8842",
  "created_at": "2026-09-01T10:04:11Z"
}

Addresses

Standing on-chain addresses for receiving BTC, USDT and USDC.

Create or fetch an address

Returns the address for your `reference` on a chain, creating it if needed: 201 when created, 200 when it already existed. Needs the `receive` capability.

On this page

Attributesidchainaddressassetslabelreferencecreated_at