Skip to main content
API docs by Redocly

Jetty (2.0.0)

Download OpenAPI specification:Download

/domains/owner

query Parameters
limit
integer <int32>

maximum amount of results to get

offset
integer <int32>

amount to offset results by

owner
required
string

address of the domain owner

Responses

Response samples

Content type
application/json
{
  • "domains": [
    ]
}

/ens/search/plain

query Parameters
date_status
string
Enum: "recently_listed" "oldest_listed" "recently_registered" "oldest_registered" "expiring_soonest"

Sorting by date applie to a result domain set. It has a higher priority than OrderTypeEnum.

has_offers_selector
Array of strings
Items Enum: "buy_now" "has_offers"

Filter on active offers existance. Multichoice, params must be comma separated.

limit
integer <int32>

Pagination limit for a result set. If it is not passed, let limit=20. Upper bound is 10000

max_domain_length
integer <int32>

Optional upper bound for a domain length.

max_listing_price
string

Optional upper bound for a domain listing price.

min_domain_length
integer <int32>

Optional lower bound for a domain length.

min_listing_price
string

Optional lower bound for a domain listing price.

name
required
string

Domain name.

name_result
string
Enum: "contains" "starts_with" "contains_not_start"

Filter on name occurrences type in domains: StartsWith, Contains or ContainsNotStart. ContainsNotStart is used for inner BE call to a database during default order search.

name_symbols_type
Array of strings
Items Enum: "letters" "numbers" "emojis"

Allowed symbols in a domain name. Multichoice, params must be comma separated.

Currently supported: Letters and Numbers.

offset
integer <int32>

Pagination offset for a result set. If it is not passed, let offset=0.

order_type
required
string
Enum: "alphabetical" "most_favorited" "highest_last_sale" "price_low_to_high" "price_high_to_low" "default"

Sorting applied to a result domain set.

search_taxa
Array of strings

List of taxonomies (categories). Multichoice, params must be comma separated.

search_terms
Array of strings

List of terms (subcategories). Multichoice, params must be comma separated.

search_type
string
Enum: "marketplace" "registry"

Type of search: Marketplace for registered domains, Registry for unregistered ones.

status_type
string
Enum: "new" "premium" "previously_owned"

Filter on expire status.

New: now() - 141 days <= expire_time < now() - 111 days;

Premium: now() - 111 days <= expire_time < now() - 90 days;

PreviouslyOwned: 0 <= expire_time < now() - 141 days.

Responses

Response samples

Content type
application/json
{
  • "domains": [
    ]
}

/ens/search/similar

query Parameters
limit
integer <int32>

Pagination limit for a result set. If it is not passed, let limit=20. Upper bound is 10000

name
required
string

Domain name.

name_symbols_type
Array of strings
Items Enum: "letters" "numbers" "emojis"

List of symbol types that are allowed to be contained in domain name.

offset
integer <int32>

Pagination offset for a result set. If it is not passed, let offset=0.

search_taxa
Array of strings

List of taxonomies (categories). Multichoice, params must be comma separated.

search_terms
Array of strings

List of terms (subcategories). Multichoice, params must be comma separated.

search_type
string
Enum: "marketplace" "registry"

Type of search: Marketplace for registered domains, Registry for unregistered ones.

status_type
string
Enum: "new" "premium" "previously_owned"

Filter on expire status.

New: now() - 141 days <= expire_time < now() - 111 days;

Premium: now() - 111 days <= expire_time < now() - 90 days;

PreviouslyOwned: 0 <= expire_time < now() - 141 days.

Responses

Response samples

Content type
application/json
{
  • "domains": [
    ]
}

/feed/aggregate

query Parameters
domain_name
string
event_type
required
string
Enum: "sale" "purchase" "offer" "listing" "registration" "premium_registration" "transfer"

Filter on event types

min_timestamp
integer <int64>

Optional lower bound for an event timestamp.

search_taxa
Array of strings

List of taxonomies (categories). Multi-choice, params must be comma separated.

search_terms
Array of strings

List of terms (subcategories). Multi-choice, params must be comma separated.

time_range
required
integer <int32>

Time measure of each aggregation batch

time_unit
required
string
Enum: "hour" "day" "week"

Time unit of each aggregation batch

Responses

Response samples

Content type
application/json
{
  • "aggregations": [
    ]
}

/feed/events

query Parameters
asset
Array of strings

Optional asset name (ETH/USDC/etc).

domain_name
string

Optional filter on domain name pattern

event_types
Array of strings
Items Enum: "sale" "purchase" "offer" "listing" "registration" "premium_registration" "transfer"

Filter on event types

limit
integer <int32>

Pagination limit for a result set. If it is not passed, let limit=20. Upper bound is 10000

max_domain_length
integer <int32>

Optional upper bound for a domain length.

max_price
string

Optional upper bound for a domain price.

max_timestamp
integer <int64>

Optional upper bound for an event timestamp.

min_domain_length
integer <int32>

Optional lower bound for a domain length.

min_price
string

Optional lower bound for a domain price.

min_timestamp
integer <int64>

Optional lower bound for an event timestamp.

offset
integer <int32>

Pagination offset for a result set. If it is not passed, let offset=0.

search_taxa
Array of strings

List of taxonomies (categories). Multi-choice, params must be comma separated.

search_terms
Array of strings

List of terms (subcategories). Multi-choice, params must be comma separated.

sorting
string
Enum: "newest" "oldest" "price_low_to_high" "price_high_to_low"

Order type of feed events. Default one: Newest (chronologically).

Responses

Response samples

Content type
application/json
{
  • "events": [
    ]
}

/floor_price

query Parameters
category
required
string

category to search by

limit
integer <int32>

number of results to limit to

offset
integer <int32>

amount to offset results by

Responses

Response samples

Content type
application/json
{
  • "domains": [
    ]
}

Enables checking if Jetty is online.

Responses

/info/domain/categories

query Parameters
domains
Array of strings

Responses

Response samples

Content type
application/json
{
  • "domains": [
    ]
}

/info/domain/expires

query Parameters
domains
Array of strings

Responses

Response samples

Content type
application/json
{
  • "domains": [
    ]
}

/info/preview_domain

query Parameters
domain
required
string

Responses

Response samples

Content type
application/json
{
  • "registration_cost_usd": 0
}

/notification_toggles

query Parameters
address
required
string

Responses

Response samples

Content type
application/json
{
  • "blog_updates": true,
  • "bulk_registrations": true,
  • "items_in_cart": true,
  • "news_updates": true,
  • "offers": true,
  • "offers_accepted": true,
  • "registrations": true,
  • "sales": true
}

/notification_toggles

Request Body schema: application/json
address
required
string
notification
required
string
Enum: "sales" "offers" "offer_accepted" "registrations" "bulk_registrations" "cart_items" "blog_updates" "news_updates"

Responses

Request samples

Content type
application/json
{
  • "address": "string",
  • "notification": "sales"
}

Response samples

Content type
application/json
{
  • "blog_updates": true,
  • "bulk_registrations": true,
  • "items_in_cart": true,
  • "news_updates": true,
  • "offers": true,
  • "offers_accepted": true,
  • "registrations": true,
  • "sales": true
}

/notifications

query Parameters
address
required
string
notification_time
required
integer <int64>
notifications
required
Array of strings
Items Enum: "item_sold" "bid_activity" "purchase" "outbid" "liked_activity" "followed_activity"

Responses

Response samples

Content type
application/json
{
  • "notifications": [
    ]
}

/roll

query Parameters
status
Array of strings
Items Enum: "buy_now" "registered" "unregistered" "premium_unregistered" "grace"

Filter on domain status.

Buy now: no active listings;

Registered: expire_time > now - 90 days;

Unregistered: now > expire_time + 111 days;

Premium Unregistered: expire_time + 90 days < now < expire_time + 111 days;

Grace: expire_time < now < expire_time + 90 days.

Responses

Response samples

Content type
application/json
{
  • "domains": [
    ]
}

/search/plain

query Parameters
date_status
string
Enum: "recently_listed" "oldest_listed" "recently_registered" "oldest_registered" "expiring_soonest"

Sorting by date applie to a result domain set. It has a higher priority than OrderTypeEnum.

has_offers_selector
Array of strings
Items Enum: "buy_now" "has_offers"

Filter on active offers existance. Multichoice, params must be comma separated.

limit
integer <int32>

Pagination limit for a result set. If it is not passed, let limit=20. Upper bound is 10000

max_domain_length
integer <int32>

Optional upper bound for a domain length.

max_listing_price
string

Optional upper bound for a domain listing price.

min_domain_length
integer <int32>

Optional lower bound for a domain length.

min_listing_price
string

Optional lower bound for a domain listing price.

name
required
string

Domain name.

name_result
string
Enum: "contains" "starts_with" "contains_not_start"

Filter on name occurrences type in domains: StartsWith, Contains or ContainsNotStart. ContainsNotStart is used for inner BE call to a database during default order search.

name_symbols_type
Array of strings
Items Enum: "letters" "numbers" "emojis"

Allowed symbols in a domain name. Multichoice, params must be comma separated.

Currently supported: Letters and Numbers.

offset
integer <int32>

Pagination offset for a result set. If it is not passed, let offset=0.

order_type
required
string
Enum: "alphabetical" "most_favorited" "highest_last_sale" "price_low_to_high" "price_high_to_low" "default"

Sorting applied to a result domain set.

search_taxa
Array of strings

List of taxonomies (categories). Multichoice, params must be comma separated.

search_terms
Array of strings

List of terms (subcategories). Multichoice, params must be comma separated.

search_type
string
Enum: "marketplace" "registry"

Type of search: Marketplace for registered domains, Registry for unregistered ones.

status_type
string
Enum: "new" "premium" "previously_owned"

Filter on expire status.

New: now() - 141 days <= expire_time < now() - 111 days;

Premium: now() - 111 days <= expire_time < now() - 90 days;

PreviouslyOwned: 0 <= expire_time < now() - 141 days.

Responses

Response samples

Content type
application/json
{
  • "domains": [
    ]
}

/search/similar

query Parameters
limit
integer <int32>

Pagination limit for a result set. If it is not passed, let limit=20. Upper bound is 10000

name
required
string

Domain name.

name_symbols_type
Array of strings
Items Enum: "letters" "numbers" "emojis"

List of symbol types that are allowed to be contained in domain name.

offset
integer <int32>

Pagination offset for a result set. If it is not passed, let offset=0.

search_taxa
Array of strings

List of taxonomies (categories). Multichoice, params must be comma separated.

search_terms
Array of strings

List of terms (subcategories). Multichoice, params must be comma separated.

search_type
string
Enum: "marketplace" "registry"

Type of search: Marketplace for registered domains, Registry for unregistered ones.

status_type
string
Enum: "new" "premium" "previously_owned"

Filter on expire status.

New: now() - 141 days <= expire_time < now() - 111 days;

Premium: now() - 111 days <= expire_time < now() - 90 days;

PreviouslyOwned: 0 <= expire_time < now() - 141 days.

Responses

Response samples

Content type
application/json
{
  • "domains": [
    ]
}

/total_stats

Responses

Response samples

Content type
application/json
{
  • "average_sale": "string",
  • "daily_sales": "string",
  • "highest_reg": "string",
  • "highest_reg_domain_name": "string",
  • "highest_sale": "string",
  • "last_reg": "string",
  • "last_reg_domain_name": "string",
  • "last_sale": "string",
  • "last_sale_domain_name": "string",
  • "reg_volume_day": "string",
  • "trending_category": "string",
  • "trending_category_volume": "string",
  • "volume_day": "string",
  • "volume_month": "string",
  • "volume_week": "string"
}

Clears the authed users cart.

Responses

Lists all the elements in the authed users cart.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Inserts/adds the provided domain to the users cart.

Request Body schema: application/json
basket
required
string
Enum: "PURCHASE" "LIST" "OFFER" "REGISTER" "SNIPE" "EXTEND"

cart type

expire_time
integer <int64>

expiration time

has_offers
boolean

active offers on domain

highest_offer
string

highest offer on domain

id
required
string

tokenid of domain

last_price
string

last sale price

last_sale_asset
string

currency use for last sale

likes
integer <int64>

number of likes on domain

listing_price
string

start price of listing

listing_time
integer <int64>

time the domain was listed

name
string

domain name

name_ens
string

ens name of the domain

owner
string

owner of the domain

premium_reg_price
string

premium registration price

taxonomies
Array of strings

domain taxonimies

terms
Array of strings

domain terms

views
integer <int64>

number of views on domain

Responses

Request samples

Content type
application/json
{
  • "basket": "PURCHASE",
  • "expire_time": 0,
  • "has_offers": true,
  • "highest_offer": "string",
  • "id": "string",
  • "last_price": "string",
  • "last_sale_asset": "string",
  • "likes": 0,
  • "listing_price": "string",
  • "listing_time": 0,
  • "name": "string",
  • "name_ens": "string",
  • "owner": "string",
  • "premium_reg_price": "string",
  • "taxonomies": [
    ],
  • "terms": [
    ],
  • "views": 0
}

Removes a specific domain from the authed users cart.

Request Body schema: application/json
basket
required
string
Enum: "PURCHASE" "LIST" "OFFER" "REGISTER" "SNIPE" "EXTEND"

cart type

expire_time
integer <int64>

expiration time

has_offers
boolean

active offers on domain

highest_offer
string

highest offer on domain

id
required
string

tokenid of domain

last_price
string

last sale price

last_sale_asset
string

currency use for last sale

likes
integer <int64>

number of likes on domain

listing_price
string

start price of listing

listing_time
integer <int64>

time the domain was listed

name
string

domain name

name_ens
string

ens name of the domain

owner
string

owner of the domain

premium_reg_price
string

premium registration price

taxonomies
Array of strings

domain taxonimies

terms
Array of strings

domain terms

views
integer <int64>

number of views on domain

Responses

Request samples

Content type
application/json
{
  • "basket": "PURCHASE",
  • "expire_time": 0,
  • "has_offers": true,
  • "highest_offer": "string",
  • "id": "string",
  • "last_price": "string",
  • "last_sale_asset": "string",
  • "likes": 0,
  • "listing_price": "string",
  • "listing_time": 0,
  • "name": "string",
  • "name_ens": "string",
  • "owner": "string",
  • "premium_reg_price": "string",
  • "taxonomies": [
    ],
  • "terms": [
    ],
  • "views": 0
}

/user/like

Responses

Response samples

Content type
application/json
{
  • "domains": [
    ]
}

Likes the passed domain for the authed user.

Request Body schema: application/json
domain_id
required
string

The name of the domain the user is liking or unliking

Responses

Request samples

Content type
application/json
{
  • "domain_id": "string"
}

Un-likes the passed domain for the authed user.

Request Body schema: application/json
domain_id
required
string

The name of the domain the user is liking or unliking

Responses

Request samples

Content type
application/json
{
  • "domain_id": "string"
}