Skip to main content

Jetty (0.2.1)

Download OpenAPI specification:Download

/feed/activity/domain

query Parameters
domain_name
required
string
limit
integer <int32>

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

offset
integer <int32>

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

Responses

Response samples

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

/feed/activity/user

query Parameters
limit
integer <int32>

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

offset
integer <int32>

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

user
required
string

Responses

Response samples

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

/feed/aggregate

query Parameters
asset
string

Optional asset name (ETH/USDC/etc).

domain_name
string
event_types
Array of strings
Items Enum: "sale" "purchase" "offer" "listing" "registration" "transfer"
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.

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
string
Enum: "hours2" "hours4" "hours12" "days1" "days2" "days6" "days12" "days30"

Responses

Response samples

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

/feed/events

query Parameters
asset
string

Optional asset name (ETH/USDC/etc).

domain_name
string
event_types
Array of strings
Items Enum: "sale" "purchase" "offer" "listing" "registration" "transfer"
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.

Responses

Response samples

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

Enables checking if Jetty is online.

Responses

/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": [
    ]
}

/search/count

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
required
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
{
  • "counter": 0
}

/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
required
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.

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
required
string
Enum: "marketplace" "registry"

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

Responses

Response samples

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

/trending/categories

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/trending/domains

query Parameters
limit
required
integer <int64>
offset
required
integer <int64>
time_span
required
string
Enum: "DAY" "WEEK" "MONTH"

Responses

Response samples

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

/trending/users

query Parameters
favourite_category
string
limit
required
integer <int64>
offset
required
integer <int64>
time_span
required
string
Enum: "DAY" "WEEK" "MONTH"

Responses

Response samples

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

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"
id
required
string

Responses

Request samples

Content type
application/json
{
  • "basket": "PURCHASE",
  • "id": "string"
}

Removes a specific domain from the authed users cart.

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

Responses

Request samples

Content type
application/json
{
  • "basket": "PURCHASE",
  • "id": "string"
}

Inserts the authed user as a follower of the provided user

Request Body schema: application/json
user
required
string

The user that is being followed or unfollowed

Responses

Request samples

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

Removes the authed user from the list of followers of the provided user

Request Body schema: application/json
user
required
string

The user that is being followed or unfollowed

Responses

Request samples

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

Get usernames by name pattern

query Parameters
username
required
string

Responses

Response samples

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

/user/like

Responses

Response samples

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

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"
}

Sets the authed users "last_seen" time to now.

Responses

Create or update (if exists) a user

Request Body schema: application/json
banner
string
bio
string
email
string
instagram
string
picture
string
twitter
string
username
string
weblink
string

Responses

Request samples

Content type
application/json
{
  • "banner": "string",
  • "bio": "string",
  • "email": "string",
  • "instagram": "string",
  • "picture": "string",
  • "twitter": "string",
  • "username": "string",
  • "weblink": "string"
}

Bumps a domains view count if the authed user has never been registered as seeing it before.

Request Body schema: application/json
token_id
required
string

Responses

Request samples

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