v3

latestOpenAPI 3.1.0raw.githubusercontent.com2026-04-08543999.8 KB

Portfolio

List portfolio domains

List domains in the authenticated user's portfolio with filtering, sorting, and pagination. By default, only ICANN (DNS) domains are returned. Returns 50 domains per page by default. If hasMore is true in the pagination response, increment the page parameter to fetch additional results.

post/mcp/v1/actions/ud_portfolio_list

Request body

pagenumber

Page number, 1-indexed (default: 1)

pageSizenumber

Number of domains per page, 1-100 (default: 50)

searchTermstring

Optional search term to filter domains by name

status'all' | 'for-sale' | 'unlisted'

Filter by listing status: "all" (default), "for-sale", or "unlisted"

registryType'dns' | 'web3'

Filter by registry type: "dns" (ICANN/Web2 domains, default) or "web3" (blockchain domains only)

expiringWithinDaysnumber

Filter domains expiring within the specified number of days (1-365)

expiredboolean

Filter for domains that have already expired

minLengthnumber

Filter domains with label length >= this value

maxLengthnumber

Filter domains with label length <= this value

autoRenewal'true' | 'false'

Filter by auto-renewal status

tagFiltersstring[]

Filter domains by tag names (e.g., ["personal", "business"])

Sort by: "name", "length", "purchasedAt", "expiresAt", "listingPrice", "offers", "leads", or "watchlistCount"

orderDirection'asc' | 'desc'

Sort direction: "asc" (ascending, default) or "desc" (descending)

Example request

{
  "page": 1,
  "pageSize": 50,
  "expiringWithinDays": 30
}

Response

Portfolio domains list

truncatedboolean

Whether results were truncated due to size limits

truncationMessagestring