Resolution Service API (1.0.0)

The Resolution Service API is used to cache domain data and metadata from any blockchain for easy retrieval without requiring direct access to blockchain APIs.

Domains

Get domain

SecurityapiKeyAuth
Request
path Parameters
domainName
required
string
Responses
200
get/domains/{domainName}
Request samples
Response samples
application/json
{
  • "meta": {
    },
  • "records": { }
}

Get domains list

SecurityapiKeyAuth
Request
query Parameters
resolution
any
owners
Array of strings
tlds
any
sortBy
string
Enum: "id" "name" "created_at"
sortDirection
string
Enum: "ASC" "DESC"
perPage
integer [ 1 .. 200 ]
startingAfter
any
Responses
200

Successful response

get/domains
Request samples
Response samples
application/json
{
  • "data": [
    ]
}

Get domains last transfer

SecurityapiKeyAuth
Request
path Parameters
domainName
required
string
Responses
200

Successful response

get/domains/{domainName}/transfers/latest
Request samples
Response samples
application/json
{
  • "data": [
    ]
}

Get domains records

SecurityapiKeyAuth
Request
query Parameters
domains
required
Array of strings <= 50 items
key
string
Responses
200

Successful response

get/records
Request samples
Response samples
application/json
{
  • "data": [
    ]
}

Reverse

Get reverse

SecurityapiKeyAuth
Request
path Parameters
address
required
string
Responses
200
get/reverse/{address}
Request samples
Response samples
application/json
{
  • "meta": {
    },
  • "records": { }
}

Get bulk reverse resolution

SecurityapiKeyAuth
Request
Request Body schema: application/json

BulkReverseQueryParams

addresses
required
Array of strings [ 1 .. 1000 ] items unique
Responses
200
post/reverse/query
Request samples
application/json
{
  • "addresses": [
    ]
}
Response samples
application/json
{
  • "data": [
    ]
}

Status

Get root

Responses
200

Successful response

get/
Request samples

Get status

Responses
200
get/status
Request samples
Response samples
application/json
{
  • "blockchain": {
    }
}

Liveness check

Responses
200

Successful response

get/liveness_check
Request samples

Readiness check

Responses
200

Successful response

get/readiness_check
Request samples

List supported tlds

Responses
200

Successful response

get/supported_tlds
Request samples

Meta Data

Get dead data

Request
path Parameters
domainOrToken
required
string
Responses
200
get/deaddata/{domainOrToken}
Request samples

Get meta data

Request
path Parameters
domainOrToken
required
string
query Parameters
withOverlay
any
Responses
200
get/metadata/{domainOrToken}
Request samples

Get image

Request
path Parameters
domainOrToken
required
string
query Parameters
withOverlay
any
Responses
200
get/image/{domainOrToken}
Request samples

Get image src

Request
path Parameters
domainOrToken
required
string
query Parameters
withOverlay
any
Responses
200

Successful response

get/image-src/{domainOrToken}
Request samples

Enrollment

Post enroll

Request
header Parameters
app-auth-token
string
Request Body schema: application/json

APIKeyEnrollmentParams

key
required
string non-empty
name
required
string non-empty
Responses
200

Successful response

post/enroll
Request samples
application/json
{
  • "key": "string",
  • "name": "string"
}