Skip to main content
POST
Build a DRep registration/deregistration transaction

Authorizations

X-Api-Key
string
header
required

API key (programmatic access — recommended)

Send your API key in the X-Api-Key header. Keys start with nxs_ and are created in the dashboard (or via POST /api/keys with a session JWT).

Each key is scoped to one chain and one network (for example cardano-mainnet), fixed at creation time. It cannot query a different network on the same chain, and it cannot query a different chain at all. A mismatched network parameter returns 400 Network Mismatch. Create one key per chain and network under the same account.

This is the credential most integrations should use.

Query Parameters

network
enum<string>
Available options:
CARDANO_MAINNET,
CARDANO_PREPROD,
CARDANO_PREVIEW,
APEX_PRIME_MAINNET,
APEX_VECTOR_MAINNET,
APEX_VECTOR_TESTNET,
MIDNIGHT_MAINNET,
MIDNIGHT_PREPROD,
MIDNIGHT_PREVIEW,
BITCOIN_MAINNET,
BITCOIN_TESTNET4

Body

application/json
drepCredentialHash
string
required
Required string length: 56
changeAddress
string
required
Maximum string length: 256
scriptCredential
boolean
anchorUrl
string
Maximum string length: 128
Pattern: ^https?://.*
anchorDataHash
string
Required string length: 64
deregister
boolean
utxos
object[]
Maximum array length: 200
senderAddress
string
network
enum<string>
Available options:
CARDANO_MAINNET,
CARDANO_PREPROD,
CARDANO_PREVIEW,
APEX_PRIME_MAINNET,
APEX_VECTOR_MAINNET,
APEX_VECTOR_TESTNET,
MIDNIGHT_MAINNET,
MIDNIGHT_PREPROD,
MIDNIGHT_PREVIEW,
BITCOIN_MAINNET,
BITCOIN_TESTNET4
ttl
integer<int64>

Response

DRep registration transaction built successfully

tx_cbor
string
tx_hash
string
estimated_fee
string
estimated_signatures
integer<int32>
{key}
any