GET /api/me/coins

Account required · HTTP API reference

All endpoints · Authentication and retries · Download OpenAPI

Requires a signed-in account and permission to access this resource. Use identifiers returned by your own account's earlier requests.

Request

Parameter	Location	Type and requirement
`limit`	query	string · optional

No request body.

Example

Examples use fictional data. Replace identifiers with resources you can access. For account requests, cookies.txt must contain your own session; set CSRF_TOKEN to the matching CSRF cookie value where required.

cURL (POSIX shell)

curl --include \
  --request GET \
  'https://api.weavers.app/api/me/coins' \
  --cookie cookies.txt --cookie-jar cookies.txt

Responses

200 · Successful response.

application/json

200 example · synthetic data

{
  "balance": 1,
  "wallets": {
    "earned": 1,
    "promo": 1,
    "purchased": 1,
    "total": 1
  },
  "ledger": [],
  "shareCap": {
    "cap": 1,
    "used": 1,
    "remaining": 1,
    "timezone": "example",
    "localDate": "2025-01-01",
    "resetsAt": null
  },
  "onboarding": {
    "completedAt": null,
    "reward": 1
  },
  "premium": {
    "status": "active",
    "hasPremiumAccess": false,
    "tier": null,
    "provider": null,
    "stipendCredits": 1,
    "currentPeriodStart": null,
    "currentPeriodEnd": null,
    "canceledAt": null,
    "stipendAwardedNow": false,
    "stipendAmountAwarded": 1
  },
  "sandboxEnabled": false
}

View response model

balance required · number

wallets required · object

View wallets model

earned required · number

promo required · number

purchased required · number

total required · number

Additional fields: JSON values.

ledger required · array of object

View ledger model

Array items:

id required · number

sourceType required · string

sourceId required · string

amount required · number

createdAt required · string

metadata required · null | object

View metadata model

Variant 1: null

null

Variant 2: object

Additional fields: JSON value.

walletType required · "earned" | "promo" | "purchased"

expiresAt required · null | string

View expiresAt model

Variant 1: null

null

Variant 2: string

string

provider required · null | string

View provider model

Variant 1: null

null

Variant 2: string

string

externalReference required · null | string

View externalReference model

Variant 1: null

null

Variant 2: string

string

Additional fields: JSON values.

shareCap required · object

View shareCap model

cap required · number

used required · number

remaining required · number

timezone required · string

localDate required · string

resetsAt required · null | string

View resetsAt model

Variant 1: null

null

Variant 2: string

string

Additional fields: JSON values.

onboarding required · object

View onboarding model

completedAt required · null | string

View completedAt model

Variant 1: null

null

Variant 2: string

string

reward required · number

Additional fields: JSON values.

premium required · object

View premium model

status required · "active" | "inactive" | "canceled"

hasPremiumAccess required · boolean

tier required · null | string

View tier model

Variant 1: null

null

Variant 2: string

string

provider required · null | string

View provider model

Variant 1: null

null

Variant 2: string

string

stipendCredits required · number

currentPeriodStart required · null | string

View currentPeriodStart model

Variant 1: null

null

Variant 2: string

string

currentPeriodEnd required · null | string

View currentPeriodEnd model

Variant 1: null

null

Variant 2: string

string

canceledAt required · null | string

View canceledAt model

Variant 1: null

null

Variant 2: string

string

stipendAwardedNow required · boolean

stipendAmountAwarded required · number

Additional fields: JSON values.

sandboxEnabled required · boolean

Additional fields: JSON values.

400 · Invalid request.

application/json

400 example · synthetic data

{}

View response model

Error envelopes can include resource-specific details. Check the status before reading these fields.

error optional · string

code optional · string

message optional · string

Additional fields: JSON values.

401 · Authentication is missing or invalid.

application/json

401 example · synthetic data

{}

View response model

Error envelopes can include resource-specific details. Check the status before reading these fields.

error optional · string

code optional · string

message optional · string

Additional fields: JSON values.

403 · Permission, origin or CSRF check failed.

application/json

403 example · synthetic data

{}

View response model

Error envelopes can include resource-specific details. Check the status before reading these fields.

error optional · string

code optional · string

message optional · string

Additional fields: JSON values.

429 · Rate limit reached; honor Retry-After when supplied.

application/json

429 example · synthetic data

{}

View response model

Error envelopes can include resource-specific details. Check the status before reading these fields.

error optional · string

code optional · string

message optional · string

Additional fields: JSON values.

500 · Server failure.

application/json

500 example · synthetic data

{
  "error": "example"
}

View response model

Variant 1: object

error required · string

Additional fields: JSON values.