Etch

Etch related API endpoints

Get etch address and fee

post

Body

application/json

runeNamestringRequiredExample: RUNE

inscriptionTypestringRequiredExample: text/plain

inscriptionContentstringRequiredExample: Some inscription content

Responses

200

Success

application/json

post

/api/etch/get-etch-address

HTTPcURLJavaScriptPython

POST /api/etch/get-etch-address HTTP/1.1
Host: api.radfi.co
Content-Type: application/json
Accept: */*
Content-Length: 98

{
  "runeName": "RUNE",
  "inscriptionType": "text/plain",
  "inscriptionContent": "Some inscription content"
}

200

Success

{
  "code": "1",
  "message": "common.success",
  "data": {},
  "metaData": {
    "totalItems": 1,
    "currentPage": 1,
    "pageSize": 1,
    "totalPages": 1
  }
}

Get etch rune by id

get

Responses

200

etch rune

application/json

get

/api/etch/runes/details

HTTPcURLJavaScriptPython

GET /api/etch/runes/details HTTP/1.1
Host: api.radfi.co
Accept: */*

200

etch rune

{
  "code": "1",
  "message": "common.success",
  "data": {},
  "metaData": {
    "totalItems": 1,
    "currentPage": 1,
    "pageSize": 1,
    "totalPages": 1
  }
}

Get etched runes

get

Responses

200

etched runes

application/json

get

/api/etch/runes

HTTPcURLJavaScriptPython

GET /api/etch/runes HTTP/1.1
Host: api.radfi.co
Accept: */*

200

etched runes

{
  "code": "1",
  "message": "common.success",
  "data": [
    {}
  ],
  "metaData": {
    "totalItems": 1,
    "currentPage": 1,
    "pageSize": 1,
    "totalPages": 1
  }
}

post

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

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

201Success

No content

post

/api/etch/commit-tx

HTTPcURLJavaScriptPython

POST /api/etch/commit-tx HTTP/1.1
Host: api.radfi.co
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 208

{
  "runeName": "RUNE",
  "inscriptionType": "text/plain",
  "inscriptionContent": "Some inscription content",
  "userAddress": "text",
  "feeTier": 10000,
  "diamondHandRewardRate": 0.5,
  "blockWithdrawals": false,
  "addLpSatsRate": 0.2
}

201Success

No content

post

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

signedBase64PsbtstringRequiredExample: base64psbt

runeNamestringRequiredExample: UNCOMMON•GOODS

inscriptionTypestringRequiredExample: text/plain

inscriptionContentstringRequiredExample: Some inscription content

symbolstringRequiredExample: R

creatorstringRequiredExample: tb1qg5s9rdd9ddhacql3upd7ntzrexp3kn95v4hndm

descriptionstringRequiredExample: Some description

displayTickerstringOptionalExample: R

Responses

201Success

No content

post

/api/etch/submit-etching

HTTPcURLJavaScriptPython

POST /api/etch/submit-etching HTTP/1.1
Host: api.radfi.co
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 373

{
  "signedBase64Psbt": "base64psbt",
  "runeName": "UNCOMMON•GOODS",
  "inscriptionType": "text/plain",
  "inscriptionContent": "Some inscription content",
  "symbol": "R",
  "creator": "tb1qg5s9rdd9ddhacql3upd7ntzrexp3kn95v4hndm",
  "description": "Some description",
  "displayTicker": "R",
  "social": {
    "x": "https://x.com/runeCreator",
    "telegram": "https://t.me/runeCreator",
    "website": "https://rune.com"
  }
}

201Success

No content

get

Query parameters

runeId_eqstringOptional

balance_gtenumberOptional

pagenumberOptional

pageSizenumberOptional

Responses

200Success

get

/api/etch/top-holders

HTTPcURLJavaScriptPython

GET /api/etch/top-holders HTTP/1.1
Host: api.radfi.co
Accept: */*

200Success

No content

post

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

runeIdstringRequired

userAddressstringRequired

Responses

201Success

No content

post

/api/etch/build-get-reward-tx

HTTPcURLJavaScriptPython

POST /api/etch/build-get-reward-tx HTTP/1.1
Host: api.radfi.co
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38

{
  "runeId": "text",
  "userAddress": "text"
}

201Success

No content

post

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

signedBase64TxstringRequired

userAddressstringRequired

Responses

201Success

No content

post

/api/etch/sign-reward-tx

HTTPcURLJavaScriptPython

POST /api/etch/sign-reward-tx HTTP/1.1
Host: api.radfi.co
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 46

{
  "signedBase64Tx": "text",
  "userAddress": "text"
}

201Success

No content

get

Query parameters

userAddressstringRequired

runeIdsstringRequired

separated by comma

Example: 123:123,354:543

Responses

200Success

get

/api/etch/rewards-amount

HTTPcURLJavaScriptPython

GET /api/etch/rewards-amount?userAddress=text&runeIds=123%3A123%2C354%3A543 HTTP/1.1
Host: api.radfi.co
Accept: */*

200Success

No content

put

Path parameters

runeIdstringRequired

Body

application/json

Responses

200Success

put

/api/etch/{runeId}

HTTPcURLJavaScriptPython

PUT /api/etch/{runeId} HTTP/1.1
Host: api.radfi.co
Content-Type: application/json
Accept: */*
Content-Length: 111

{
  "social": {
    "x": "https://x.com/runeCreator",
    "telegram": "https://t.me/runeCreator",
    "website": "https://rune.com"
  }
}

200Success

No content