{"openapi":"3.1.0","info":{"title":"Namegarage public domain catalog","version":"1.3.0","termsOfService":"https://namegarage.com/terms/","description":"Anonymous read-only catalog and search. No account, API key, bearer token, or browser cookie is required."},"security":[],"externalDocs":{"description":"Public API documentation and quickstart","url":"https://namegarage.com/docs/"},"servers":[{"url":"https://namegarage.com"}],"tags":[{"name":"Catalog","description":"Read the deployed domain catalog snapshot."},{"name":"Search","description":"Find domains by keyword or by meaning, with optional filters."}],"paths":{"/domains.json":{"get":{"summary":"List public domains for sale","operationId":"listPublicDomains","tags":["Catalog"],"description":"Read the deployed sales catalog snapshot. Prices and availability may change before the next deployment. Use /api/domain or /api/purchase-options for current terms. An offer-only name has no fixed purchase price.","responses":{"200":{"description":"Public sales catalog","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","additionalProperties":false,"required":["brand","base_url","count","traffic_max_stale_days","domains"],"properties":{"brand":{"type":"string"},"base_url":{"type":"string"},"count":{"type":"integer","minimum":0},"priced_at":{"type":"integer"},"traffic_max_stale_days":{"type":"integer","minimum":0},"domains":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["name","sld","tld","path","tier","buy_now","categories","low"],"properties":{"name":{"type":"string"},"sld":{"type":"string"},"tld":{"type":"string"},"display":{"type":"string"},"path":{"type":"string"},"tier":{"type":"string","enum":["","Platinum","Gold","Silver","Bronze","Bargain"]},"buy_now":{"type":["integer","null"]},"regular_price":{"type":["integer","null"]},"promotion":{"type":"object","additionalProperties":false,"required":["price","kind","minimum","ends","next","version"],"properties":{"price":{"type":["integer","null"]},"kind":{"enum":["regular","weekly","price_drop"]},"minimum":{"type":["integer","null"]},"ends":{"type":["string","null"],"format":"date-time"},"next":{"type":["object","null"],"additionalProperties":false,"required":["starts","price"],"properties":{"starts":{"type":"string","format":"date-time"},"price":{"type":"integer"}}},"version":{"type":"string","pattern":"^[a-f0-9]{64}$"}}},"categories":{"type":"array","items":{"type":"string"}},"low":{"type":["integer","null"]},"deal":{"type":"object","description":"A current or scheduled weekly offer. Its price applies only while starts <= now < ends; otherwise use buy_now.","additionalProperties":false,"required":["price","starts","ends"],"properties":{"price":{"type":"integer"},"starts":{"type":"string","format":"date-time"},"ends":{"type":"string","format":"date-time"}}},"visits":{"type":"integer"},"visits_through":{"type":"string","format":"date"}}}}}}}}}}}},"/api/search":{"get":{"summary":"Search the public domains by keyword or by meaning","operationId":"searchPublicDomains","tags":["Search"],"description":"Find names by spelling or project description, with optional price, tier, suffix, and length filters. Results include current prices and links to the public domain pages.","parameters":[{"name":"q","in":"query","required":true,"description":"A domain, keyword, or description of the project the name should fit.","schema":{"type":"string","minLength":2,"maxLength":200}},{"name":"max_price","in":"query","description":"Maximum current price in whole USD.","schema":{"type":"integer","minimum":1}},{"name":"tier","in":"query","description":"Limit matches to this pricing tier.","schema":{"enum":["Bargain","Bronze","Silver","Gold","Platinum"]}},{"name":"tld","in":"query","schema":{"type":"string"},"description":"How the name ends: a TLD (com) or a longer suffix (co.uk), in ASCII (xn--p1ai) or Unicode; a leading dot is ignored."},{"name":"max_length","in":"query","description":"Maximum name length.","schema":{"type":"integer","minimum":1,"maximum":63}},{"name":"limit","in":"query","description":"Maximum number of matches to return.","schema":{"type":"integer","minimum":1,"maximum":50,"default":20}}],"responses":{"200":{"description":"Ranked matches with current prices","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","additionalProperties":false,"required":["query","priced_at","meaning","count","results"],"properties":{"query":{"type":"string"},"priced_at":{"type":"integer"},"meaning":{"enum":["available","unavailable"]},"count":{"type":"integer","minimum":0},"results":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["name","url","tier","price_usd","match","fits"],"properties":{"name":{"type":"string"},"display":{"type":"string"},"url":{"type":"string"},"tier":{"type":["string","null"]},"price_usd":{"type":["integer","null"],"description":"Current price in whole USD, a running deal included; null for an offer-only name, which has no fixed price (make an offer on its page)."},"regular_price_usd":{"type":"integer","description":"The usual price, present only while a discount is running."},"match":{"enum":["exact","keyword","meaning"],"description":"exact: the query is the whole name or its first label; keyword: a match by spelling; meaning: a match by what the name is for."},"fits":{"type":["string","null"],"description":"The published use case or description this name matched; null when the match was by spelling only or the name's copy is withheld."}}}}}}}}},"400":{"description":"A parameter is invalid: {\"error\": \"invalid_parameter\", \"parameter\": <name>}"},"404":{"description":"Not this origin or path"},"429":{"description":"Busy; retry after the Retry-After header"},"503":{"description":"Prices cannot be verified right now (\"prices_unverified\") or search is unavailable; retry after the Retry-After header"}}}},"/api/domain":{"get":{"summary":"Look up a published domain","operationId":"getDomain","tags":["Catalog"],"description":"Look up one complete published domain name in ASCII/punycode or Unicode. Includes the published description and potential uses in domain.description and domain.use_cases. Empty string and empty list mean no copy is published or the copy is withheld. Potential uses are suggestions, not proof of suitability or trademark rights. Returns found:false when it is not in the current public catalog; that does not mean it is unregistered or available elsewhere. Does not reserve the name.","parameters":[{"name":"name","in":"query","required":true,"schema":{"type":"string","minLength":3,"maxLength":200,"description":"Complete domain name, including its suffix; no URL or path."},"description":"Complete domain name, including its suffix; no URL or path."}],"responses":{"200":{"description":"Public catalog operation result; missing lookup names use found:false","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["name","priced_at","found","domain"],"properties":{"name":{"type":"string"},"priced_at":{"type":"integer","minimum":0},"found":{"type":"boolean"},"domain":{"oneOf":[{"type":"object","additionalProperties":false,"required":["name","url","tier","price_usd","match","fits"],"properties":{"name":{"type":"string"},"display":{"type":"string"},"url":{"type":"string"},"tier":{"type":["string","null"]},"price_usd":{"type":["integer","null"],"description":"Current price in whole USD, a running deal included; null for an offer-only name, which has no fixed price (make an offer on its page)."},"regular_price_usd":{"type":"integer","description":"The usual price, present only while a discount is running."},"match":{"enum":["exact","keyword","meaning"],"description":"exact: the query is the whole name or its first label; keyword: a match by spelling; meaning: a match by what the name is for."},"fits":{"type":["string","null"],"description":"The published use case or description this name matched; null when the match was by spelling only or the name's copy is withheld."},"description":{"type":"string"},"use_cases":{"type":"array","items":{"type":"string"}}}},{"type":"null"}]}}}}}},"400":{"description":"Invalid, unknown or duplicate query parameters"},"404":{"description":"Not this origin or path"},"429":{"description":"Busy; retry after the Retry-After header"},"503":{"description":"Prices cannot be verified right now (\"prices_unverified\") or search is unavailable; retry after the Retry-After header"},"405":{"description":"Only GET is supported"}}}},"/api/purchase-options":{"get":{"summary":"Compare outright and lease-to-own options","operationId":"getPurchaseOptions","tags":["Catalog"],"description":"Compare buying one published domain outright with its standard zero-down lease-to-own plans. Returns current whole-USD cash price, lease principal, monthly and final payments, totals, extra cost versus cash, and the domain page URL. A cash-only deal may not discount the lease principal. Null buy_outright and an empty lease_to_own list mean offer-only. Empty lease_to_own means no standard standalone plan is published. Does not reserve a domain or start checkout; visit the returned page to review terms, other payment shapes and any additional checkout fees.","parameters":[{"name":"name","in":"query","required":true,"schema":{"type":"string","minLength":3,"maxLength":200,"description":"Complete domain name, including its suffix; no URL or path."},"description":"Complete domain name, including its suffix; no URL or path."}],"responses":{"200":{"description":"Public catalog operation result; missing lookup names use found:false","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["name","priced_at","found","domain"],"properties":{"name":{"type":"string"},"priced_at":{"type":"integer","minimum":0},"found":{"type":"boolean"},"domain":{"oneOf":[{"type":"object","additionalProperties":false,"required":["name","url","tier","price_usd","match","fits","purchase_options"],"properties":{"name":{"type":"string"},"display":{"type":"string"},"url":{"type":"string"},"tier":{"type":["string","null"]},"price_usd":{"type":["integer","null"],"description":"Current price in whole USD, a running deal included; null for an offer-only name, which has no fixed price (make an offer on its page)."},"regular_price_usd":{"type":"integer","description":"The usual price, present only while a discount is running."},"match":{"enum":["exact","keyword","meaning"],"description":"exact: the query is the whole name or its first label; keyword: a match by spelling; meaning: a match by what the name is for."},"fits":{"type":["string","null"],"description":"The published use case or description this name matched; null when the match was by spelling only or the name's copy is withheld."},"purchase_options":{"type":"object","additionalProperties":false,"required":["currency","buy_outright","lease_base_price_usd","lease_to_own"],"properties":{"currency":{"const":"USD"},"buy_outright":{"oneOf":[{"type":"null"},{"type":"object","required":["total_usd"],"properties":{"total_usd":{"type":"integer","minimum":0}},"additionalProperties":false}]},"lease_base_price_usd":{"type":["integer","null"],"minimum":1},"lease_to_own":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["months","down_payment_usd","first_payment_usd","monthly_payment_usd","final_payment_usd","total_usd","extra_cost_vs_buy_outright_usd"],"properties":{"months":{"type":"integer","minimum":0},"down_payment_usd":{"type":"integer","minimum":0},"first_payment_usd":{"type":"integer","minimum":0},"monthly_payment_usd":{"type":"integer","minimum":0},"final_payment_usd":{"type":"integer","minimum":0},"total_usd":{"type":"integer","minimum":0},"extra_cost_vs_buy_outright_usd":{"type":"integer","minimum":0}}}}}}}},{"type":"null"}]}}}}}},"400":{"description":"Invalid, unknown or duplicate query parameters"},"404":{"description":"Not this origin or path"},"429":{"description":"Busy; retry after the Retry-After header"},"503":{"description":"Prices cannot be verified right now (\"prices_unverified\") or search is unavailable; retry after the Retry-After header"},"405":{"description":"Only GET is supported"}}}},"/api/alternatives":{"get":{"summary":"Find published alternatives","operationId":"suggestAlternatives","tags":["Search"],"description":"Find alternatives to one complete domain name using only the current published Namegarage inventory. Excludes the requested name, including its Unicode/punycode spelling. Uses its first label as the search query unless a project description is supplied. Returns current USD prices, page URLs and match reasons. Does not check registration availability or imply the requested name is unavailable. An empty result means no matching published alternatives; null price_usd means offer-only. Does not reserve names or contact anyone.","parameters":[{"name":"name","in":"query","required":true,"schema":{"type":"string","minLength":3,"maxLength":200,"description":"Complete reference domain name, including its suffix; no URL or path. It need not be in our catalog."},"description":"Complete reference domain name, including its suffix; no URL or path. It need not be in our catalog."},{"name":"query","in":"query","required":false,"schema":{"type":"string","minLength":2,"maxLength":200,"description":"Optional project description or keywords to rank alternatives instead of the reference name\u2019s first label."},"description":"Optional project description or keywords to rank alternatives instead of the reference name\u2019s first label."},{"name":"max_price","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":9007199254740991,"description":"Maximum whole USD cash price; excludes offer-only names."},"description":"Maximum whole USD cash price; excludes offer-only names."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":50,"default":5},"description":"limit"}],"responses":{"200":{"description":"Public catalog operation result; missing lookup names use found:false","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","additionalProperties":false,"required":["query","priced_at","meaning","count","results","name"],"properties":{"query":{"type":"string"},"priced_at":{"type":"integer"},"meaning":{"enum":["available","unavailable"]},"count":{"type":"integer","minimum":0},"results":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["name","url","tier","price_usd","match","fits"],"properties":{"name":{"type":"string"},"display":{"type":"string"},"url":{"type":"string"},"tier":{"type":["string","null"]},"price_usd":{"type":["integer","null"],"description":"Current price in whole USD, a running deal included; null for an offer-only name, which has no fixed price (make an offer on its page)."},"regular_price_usd":{"type":"integer","description":"The usual price, present only while a discount is running."},"match":{"enum":["exact","keyword","meaning"],"description":"exact: the query is the whole name or its first label; keyword: a match by spelling; meaning: a match by what the name is for."},"fits":{"type":["string","null"],"description":"The published use case or description this name matched; null when the match was by spelling only or the name's copy is withheld."}}}},"name":{"type":"string"}}}}}},"400":{"description":"Invalid, unknown or duplicate query parameters"},"404":{"description":"Not this origin or path"},"429":{"description":"Busy; retry after the Retry-After header"},"503":{"description":"Prices cannot be verified right now (\"prices_unverified\") or search is unavailable; retry after the Retry-After header"},"405":{"description":"Only GET is supported"}}}}}}