Account — API reference • URnetwork

POST/account/change-name

Bearer authaccountChangeName

Change the network name of the calling network. The previous name enters a reclaim cooldown. Subject to the account action rate limit.

Request bodyshow schema

network_name

string

new_name

string

Responses2 statuses · show schema

200

network_name

string

error

object

message

string

403

No body

Requestapplication/json

{
  "network_name": "string",
  "new_name": "string"
}

Response200

{
  "network_name": "string",
  "error": {
    "message": "string"
  }
}

Response403

No body

POST/account/claim-name

Bearer authaccountClaimName

Claim an unused network name for the calling network. Claiming and changing have SEPARATE daily budgets: a first-time claim does not consume any of the rename budget, and vice versa. Renaming a name that is still inside its reclaim cooldown is charged to the change-name budget instead.

Request bodyshow schema

network_name

string

new_name

string

Responses2 statuses · show schema

200

network_name

string

error

object

message

string

403

No body

Requestapplication/json

{
  "network_name": "string",
  "new_name": "string"
}

Response200

{
  "network_name": "string",
  "error": {
    "message": "string"
  }
}

Response403

No body

POST/account/api-key

Bearer authaccountCreateApiKey

Create an API key for the account.

Request bodyshow schema

name

string

Responses2 statuses · show schema

200

id

string

uuid

api_key

string

name

string

error

object

message

string

403

No body

Requestapplication/json

{
  "name": "string"
}

Response200

{
  "id": "00000000-0000-0000-0000-000000000000",
  "api_key": "string",
  "name": "string",
  "error": {
    "message": "string"
  }
}

Response403

No body

POST/account/api-key/remove

Bearer authaccountRemoveApiKey

Remove an API key for the account.

Request bodyshow schema

id

string

uuid

Responses2 statuses · show schema

200

error

object

message

string

403

No body

GET/account/api-keys

Bearer authaccountGetApiKeys

Fetches a list of API keys associated with the account. The list does not include the API key secrets, only metadata.

Responses2 statuses · show schema

200

api_keys

arraynull

error

object

message

string

403

No body

GET/account/payout-wallet

Bearer authaccountGetPayoutWallet

Fetches the payout wallet associated with the network

Responses2 statuses · show schema

200

wallet_id

stringnull

udid

403

No body

POST/account/payout-wallet

Bearer authaccountSetPayoutWallet

Set an existing account wallet as the wallet to receive network payments.

Request bodyshow schema

wallet_id

string

udid

Responses2 statuses · show schema

200

empty object

403

No body

GET/account/points

Bearer authaccountGetPoints

Retrieves account points earned. Eventually, users will be able to convert points for tokens

Responses1 status · show schema

200

network_points

array<AccountPoint>

array

account_point_id

string

uuid

network_id

string

uuid

event

string

What earned the points. The server only writes the four payout events today; referral is historical, kept so rows written before the referral award was withdrawn still validate.

enum: referral, payout, payout_linked_account, payout_multiplier, payout_reliability

point_value

integer

payment_plan_id

string

uuid

account_payment_id

string

uuid

linked_network_id

string

uuid

create_time

string

datetime

Response200

{
  "network_points": [
    {
      "account_point_id": "00000000-0000-0000-0000-000000000000",
      "network_id": "00000000-0000-0000-0000-000000000000",
      "event": "referral",
      "point_value": 0,
      "payment_plan_id": "00000000-0000-0000-0000-000000000000",
      "account_payment_id": "00000000-0000-0000-0000-000000000000",
      "linked_network_id": "00000000-0000-0000-0000-000000000000",
      "create_time": "string"
    }
  ]
}

GET/account/payments

Bearer authaccountGetPayouts

Retrieves list of account payments

Responses2 statuses · show schema

200

account_payments

array<AccountPayment>

array

payment_id

string

payment_plan_id

string

wallet_id

stringnull

network_id

string

payout_byte_count

integer

payout_nano_cents

integer

subsidy_payout_nano_cents

integer

reliability_subsidy_nano_cents

integer

min_sweep_time

string (date-time)

create_time

string (date-time)

payment_record

stringnull

token_type

stringnull

token_amount

number,null (float)

payment_time

string,null (date-time)

payment_receipt

stringnull

wallet_address

stringnull

blockchain

string

enum: MATIC, SOL

tx_hash

stringnull

completed

boolean

complete_time

string,null (date-time)

canceled

boolean

cancel_time

string,null (date-time)

error

GetNetworkAccountPaymentsError

message

string

403

No body

Response200

{
  "account_payments": [
    {
      "payment_id": "string",
      "payment_plan_id": "string",
      "wallet_id": null,
      "network_id": "string",
      "payout_byte_count": 0,
      "payout_nano_cents": 0,
      "subsidy_payout_nano_cents": 0,
      "reliability_subsidy_nano_cents": 0,
      "min_sweep_time": "2026-01-01T00:00:00Z",
      "create_time": "2026-01-01T00:00:00Z",
      "payment_record": null,
      "token_type": null,
      "token_amount": null,
      "payment_time": null,
      "payment_receipt": null,
      "wallet_address": null,
      "blockchain": "MATIC",
      "tx_hash": null,
      "completed": false,
      "complete_time": null,
      "canceled": false,
      "cancel_time": null
    }
  ],
  "error": {
    "message": "string"
  }
}

Response403

No body

POST/account/wallet

Bearer authaccountCreateWallet

Create a new wallet for your network. You can then use it as a payout wallet by posting to /account/payout-wallet.

Request bodyshow schema

network_id

string

Ignored. The wallet is always created for the caller's own network, taken from the bearer token; this field is read off the body only to be overwritten.

blockchain

string

The blockchain associated with the address. SOL and MATIC are payout chains; TAO is accepted and stored as a non-payout identity. Case-insensitive.

enum: SOL, MATIC, TAO

wallet_address

string

The wallet address on blockchain

default_token_type

string

We only support "USDC"

enum: USDC

Responses2 statuses · show schema

200

wallet_id

string

udid

403

No body

Requestapplication/json

{
  "network_id": "string",
  "blockchain": "SOL",
  "wallet_address": "string",
  "default_token_type": "USDC"
}

Response200

{
  "wallet_id": "00000000-0000-0000-0000-000000000000"
}

Response403

No body

GET/account/wallets

Bearer authaccountGetWallets

Get a list of wallets associated with your network

Responses2 statuses · show schema

200

wallets

array<AccountWallet>

A list of wallets associated with your network

array

wallet_id

string

udid

circle_wallet_id

string

If the wallet was created through the Circle flow, it is the ID associated with the Circle wallet.

network_id

string

udid

wallet_type

string

enum: circle_uc, external

blockchain

string

TAO appears for a wallet created as a non-payout identity.

enum: SOL, MATIC, TAO

wallet_address

string

Blockchain wallet address

active

boolean

default_token_type

string

enum: USDC

create_time

string

datetime

has_seeker_token

boolean

403

No body

Response200

{
  "wallets": [
    {
      "wallet_id": "00000000-0000-0000-0000-000000000000",
      "circle_wallet_id": "string",
      "network_id": "00000000-0000-0000-0000-000000000000",
      "wallet_type": "circle_uc",
      "blockchain": "SOL",
      "wallet_address": "string",
      "active": false,
      "default_token_type": "USDC",
      "create_time": "string",
      "has_seeker_token": false
    }
  ]
}

Response403

No body

POST/account/wallets/remove

Bearer authaccountRemoveWallet

Remove a wallet from your list of account wallets. Removing the payout wallet makes another active Solana or Polygon wallet of the network the payout wallet, when there is one, and names it in payout_wallet_id; otherwise USDC payouts are held until a payout wallet is set.

Request bodyshow schema

wallet_id

string

udid

Responses2 statuses · show schema

200

success

boolean

Wallet successfully removed

payout_wallet_id

string

udid. Set when the removed wallet was the network's payout wallet and another of the network's active Solana or Polygon wallets became the payout wallet in the same transaction (the newest, preferring the removed wallet's chain; never a Bittensor wallet). Absent when nothing was promoted, which leaves the network with no payout wallet, and from older servers. Apps show where payouts go now.

error

object

message

string

403

No body

Requestapplication/json

{
  "wallet_id": "00000000-0000-0000-0000-000000000000"
}

Response200

{
  "success": false,
  "payout_wallet_id": "00000000-0000-0000-0000-000000000000",
  "error": {
    "message": "string"
  }
}

Response403

No body

POST/account/wallets/verify-seeker

Bearer authaccountVerifySeekerToken

Verify that a wallet holds a Seeker or Saga Genesis token by validating a signed message. Either holding succeeds; a wallet with neither is refused with error.message and error.code seeker_token_not_found.

Request bodyshow schema

wallet_address

string

The wallet public key

wallet_signature

string

wallet_message

string

The signed message

Responses2 statuses · show schema

200

success

boolean

error

object

message

string

code

string

Why the wallet was not verified, for a localized message. seeker_token_not_found: the wallet holds no Seeker or Saga token. seeker_invalid_signature: the wallet signature did not verify. seeker_lookup_failed: the token lookup failed. Absent from older servers; clients fall back to message for an absent or unknown code.

403

No body

Requestapplication/json

{
  "wallet_address": "string",
  "wallet_signature": "string",
  "wallet_message": "string"
}

Response200

{
  "success": false,
  "error": {
    "message": "string",
    "code": "string"
  }
}

Response403

No body

GET/account/balance-codes

Bearer authaccountBalanceCodes

Fetch balance codes redeemed by network

Responses2 statuses · show schema

200

balance_codes

arraynull

error

NetworkBalanceCodesError

message

string

403

No body

GET/account/epochs

Bearer authaccountEpochs

The caller network's finalized epochs, newest first: the points earned inside each epoch's wall-clock window and the network's share of the operator pool in basis points (0 when no coldkey was attached, i.e. points only). limit defaults to 26 and is capped at 104.

While settlement v2 is configured, an epoch it settles is listed from the ledger instead of its v1 row, once a finalized v2 root covering it has been recorded: it carries amount_rao, the network's amount of the epoch, and its share_bps is that amount's share of the epoch's amounts.

Parameters

limit(query)

integer

Epochs to list; absent or 0 means 26, and above 104 means 104.

Responses2 statuses · show schema

200

epochs

array<AccountEpoch>

array

epoch

integer

start_millis

integer

Epoch window start, unix milliseconds.

end_millis

integer

Epoch window end, unix milliseconds.

points

number (double)

Points earned inside the window.

share_bps

integer

The network's share of the operator pool in basis points; 0 when no coldkey was attached. For a settlement v2 epoch, the share of the epoch's amounts that amount_rao is, rounded down; 0 when the epoch has no amounts.

amount_rao

string

Settlement v2 epochs only, absent for a v1 epoch: the network's amount of the epoch from the ledger, a decimal string of rao; "0" when the network has none.

error

object

message

string

400

No body

Response200

{
  "epochs": [
    {
      "epoch": 0,
      "start_millis": 0,
      "end_millis": 0,
      "points": 0,
      "share_bps": 0,
      "amount_rao": "string"
    }
  ],
  "error": {
    "message": "string"
  }
}

Response400

No body

GET/account/referral-code

Bearer authaccountReferralCode

Unique network code to refer new users

Responses1 status · show schema

200

referral_code

string

udid

total_referrals

integer

max_referrals

integer

Referrals a network is paid for. 0 when the server has no referral cap configured (uncapped); clients treat 0 as unknown.

bonus_per_referral_bytes

integer

Bytes granted to the referrer per referral, per bonus period. 0 when unknown.

referred_bonus_bytes

integer

Bytes granted to the referred network, per bonus period. 0 when unknown.

bonus_period_seconds

integer

The bonus grant period in seconds (24h = 86400). 0 when unknown.

has_referral_network

boolean

True when this network is linked to a referrer and earns the referred bonus.

Response200

{
  "referral_code": "00000000-0000-0000-0000-000000000000",
  "total_referrals": 0,
  "max_referrals": 0,
  "bonus_per_referral_bytes": 0,
  "referred_bonus_bytes": 0,
  "bonus_period_seconds": 0,
  "has_referral_network": false
}

GET/account/referral-network

Bearer authaccountReferralNetwork

Get the network that was referred the authenticated network

Responses1 status · show schema

200

network

ReferralNetwork

id

string

uuid

name

string

error

object

message

string

GET/account/unlink-referral-network

Bearer authaccountUnlinkReferralNetwork

Unlink the referral network from the authenticated network.

Responses2 statuses · show schema

200

empty object

403

No body

POST/account/set-referral

Bearer authaccountSetReferral

Set the parent referral network for the authenticated network.

Request bodyshow schema

referral_code

string

Responses2 statuses · show schema

200

error

object

message

string

403

No body