Etch

Get etch address and fee

post
Body
runeNamestringRequiredExample: RUNE
inscriptionTypestringRequiredExample: text/plain
inscriptionContentstringRequiredExample: Some inscription content
Responses
chevron-right
200

Success

application/json
post
/api/etch/get-etch-address
200

Success

Get etch rune by id

get
Query parameters
selectstringOptional

Fields to select (comma separated). Use + prefix to include hidden fields. Example: name,status,+holders

populatestringOptional

Relations to populate (comma separated). Example: wallet,token

sortstringOptional

Sort field and order. Use - prefix for descending. Example: -createdAt

Responses
chevron-right
200

etch rune

application/json
get
/api/etch/runes/details
200

etch rune

Get etched runes

get
Query parameters
pagenumberOptional

Page number (default: 1)

Example: 1
pageSizenumberOptional

Number of items per page (default: 10)

Example: 10
sortstringOptional

Sort field and order. Use - prefix for descending. Example: -createdAt, createdAt

Example: -createdAt
selectstringOptional

Fields to select (comma separated). Use + prefix to include hidden fields. Example: name,status,+holders

populatestringOptional

Relations to populate (comma separated). Example: wallet,token

Responses
chevron-right
200

etched runes

application/json
get
/api/etch/runes
200

etched runes

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
runeNamestringRequiredExample: RUNE
inscriptionTypestringRequiredExample: text/plain
inscriptionContentstringRequiredExample: Some inscription content
userAddressstringRequired
feeTiernumber · min: 5000 · max: 100000Required

Fee tier for the pool (5000 = 0.5%, 10000 = 1%, 20000 = 2%, etc.)

Example: 10000
diamondHandRewardRatenumber · max: 1Optional

Diamond hands share of the available 66.67% (0-1, e.g., 0.5 = 50% of 66.67% = 33.33% total)

Example: 0.5
blockWithdrawalsbooleanOptional

Block withdrawals of this token from radFi (only internal transfers allowed)

Default: false
addLpSatsRatenumber · max: 1Optional

Percentage of raised funds to allocate to liquidity (0-1, e.g., 0.2 = 20% to LP, 80% to creator)

Example: 0.2
Responses
post
/api/etch/commit-tx
201Success

No content

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
signedBase64PsbtstringRequiredExample: base64psbt
runeNamestringRequiredExample: UNCOMMON•GOODS
inscriptionTypestringRequiredExample: text/plain
inscriptionContentstringRequiredExample: Some inscription content
symbolstringRequiredExample: R
creatorstringRequiredExample: tb1qg5s9rdd9ddhacql3upd7ntzrexp3kn95v4hndm
descriptionstringRequiredExample: Some description
displayTickerstringOptionalExample: R
Responses
post
/api/etch/submit-etching
201Success

No content

get
Query parameters
runeId_eqstringOptional
balance_gtenumberOptional
pagenumberOptional
pageSizenumberOptional
Responses
chevron-right
200Success

No content

get
/api/etch/top-holders
200Success

No content

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
runeIdstringRequired
userAddressstringRequired
Responses
post
/api/etch/build-get-reward-tx
201Success

No content

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
signedBase64TxstringRequired
userAddressstringRequired
Responses
post
/api/etch/sign-reward-tx
201Success

No content

get
Query parameters
userAddressstringRequired
runeIdsstringRequired

separated by comma

Example: 123:123,354:543
Responses
chevron-right
200Success

No content

get
/api/etch/rewards-amount
200Success

No content

Last updated