API Reference

Retrieve Project Domains

get
https://stage-api.didhub.com/openapi/v1/projects//domains/
Path Params
string
enum
required

The project of the domain to resolve

Query Params
string
length ≤ 1024

The domain name that you want to retrieve activities for

address
array of strings

The wallet address that you want to retrieve activities for

address
chain
array of strings

The chain Name that you want to retrieve activities for, i.e. ETHEREUM, POLYGON, etc

chain
string
enum

The currency of the domain to resolve

Allowed:
status
array of strings

The domain status to search

status
marketStatus
array of strings

The market status to search. Others refer to the domains that are not listed not unregistered.

marketStatus
boolean

Whether the domain name is for sale

characterSet
array of strings

The character sets to search. One of more in ['Emoji', 'Mixed', 'Letter', 'Alphanumeric', 'Digit']

characterSet
matchType
array of strings

The match type to search. One or more in ['Precise', 'Fuzzy', 'Prefix', 'Suffix', 'Infix']

matchType
tld
array of strings

The top level domain that you want to retrieve activities for, i.e. eth

tld
string
enum

The payment token to search. Requires also priceMin and priceMax

Allowed:
number

The minimum price to search. Requires also paymentToken and priceMax

number

The maximum price to search. Requires also paymentToken and priceMin

integer

The minimum expiry to search. Requires also expiryMax

integer

The maximum expiry to search. Requires also expiryMin

integer

The minimum registration date to search. Requires also registrationMax

integer

The maximum registration date to search. Requires also registrationMin

integer

The minimum level to search. Requires also levelMax

integer

The maximum level to search. Requires also levelMin

integer

The minimum length to search. Requires also lengthMax

integer

The maximum length to search. Requires also lengthMin

integer

The minimum segment to search. Requires also segmentMax

integer

The maximum segment to search. Requires also segmentMin

category
array of strings
category
boolean

Whether the domain name is ASCII

string
enum

The field that you want to sort by

Allowed:
string
enum
Defaults to desc

The direction that you want to sort by

Allowed:
boolean

Whether the domain name is valid according to the specification of the corresponding DID project. We try to set our validation rule as close as possible to the DID projects

integer
≤ 50
Defaults to 20

The page size that you want to retrieve

integer
≤ 2000
Defaults to 0

The page number that you want to retrieve. Maximum is 2000 to avoid deep pagination.

Responses

Updated about 1 year ago

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 year ago