{ "openapi": "3.0.3", "info": { "description": "All Atom public HTTP APIs: marketplace (seller, partnership, appraisal, trademark, smart search) and registrar.", "version": "1.0.0", "title": "Atom APIs", "contact": { "email": "service@atom.com" }, "termsOfService": "https://www.atom.com/terms" }, "servers": [ { "url": "https://www.atom.com", "description": "Production" } ], "tags": [ { "name": "Seller Apis", "description": "All the apis to manage your domain marketplace" }, { "name": "Parnership Apis", "description": "All the apis to manage your domain marketplace" }, { "name": "Smart Search Apis", "description": "All the apis to manage your domain marketplace" }, { "name": "Appraisal Apis", "description": "APIs for domain appraisal functionality using separate API tokens" }, { "name": "Trademark Apis", "description": "APIs for trademark search and analysis functionality" }, { "name": "Domains", "description": "List, inspect, register, and renew domains" }, { "name": "Availability", "description": "Check whether Atom can register a domain and the price Atom would charge" }, { "name": "Transfers", "description": "Transfer domains into Atom (POST /domains/transfer). Transfer-out (unlock + EPP code) is dashboard-only and is not exposed on this API. GET/PUT /domains/{domain_name}/lock reports and sets the registrar lock, including ICANN 60-day lock expiry." }, { "name": "DNS", "description": "DNS records and DNSSEC (requires Atom nameservers)" }, { "name": "Nameservers", "description": "Get and set nameservers" }, { "name": "Locking & Privacy", "description": "Registrar lock, ICANN 60-day lock, WHOIS privacy, auto-renew" }, { "name": "URL Forwards", "description": "HTTP redirects for a domain" }, { "name": "Contacts", "description": "List, search, get, create, and update registrant / admin / billing / tech contact handles" } ], "externalDocs": { "description": "Atom API docs", "url": "https://www.atom.com/api-docs" }, "paths": { "/api/marketplace/domains": { "get": { "tags": [ "Seller Apis" ], "summary": "GetDomainList (Premium, Standard, Geo, All)", "description": "Get a list of all domains listed under your account. Pass the type parameter if you want to filter by type of listing (e.g. Premium, Standard, Geo)", "operationId": "domainsList", "parameters": [ { "name": "api_token", "in": "query", "required": true, "description": "API Key to get the details", "schema": { "type": "string", "default": "" } }, { "name": "user_id", "in": "query", "required": true, "description": "UserId of the API Token", "schema": { "type": "string", "default": "" } }, { "name": "type", "in": "query", "description": "Domain Type (standard, premium or geo)", "schema": { "type": "string", "enum": [ "premium", "standard", "geo" ] } }, { "name": "page", "in": "query", "description": "Page number", "schema": { "type": "integer" } }, { "name": "limit", "in": "query", "description": "Number of domains to return", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DomainApiResponse" } } } } } } }, "/api/marketplace/categories": { "get": { "tags": [ "Seller Apis" ], "summary": "Domain Categories", "description": "List the categories for domains", "operationId": "domainCategories", "parameters": [ { "name": "api_token", "in": "query", "required": true, "description": "API Key to get the details", "schema": { "type": "string", "default": "" } }, { "name": "user_id", "in": "query", "required": true, "description": "UserId of the API Token", "schema": { "type": "string", "default": "" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DomainApiResponse" } } } } } } }, "/api/marketplace/domains/search": { "get": { "tags": [ "Seller Apis" ], "summary": "SearchDomains (By category or keyword)", "description": "Search Domains based on the keyword or category", "operationId": "searchDomains", "parameters": [ { "name": "api_token", "in": "query", "required": true, "description": "API Key to get the details", "schema": { "type": "string", "default": "" } }, { "name": "user_id", "in": "query", "required": true, "description": "UserId of the API Token", "schema": { "type": "string", "default": "" } }, { "name": "category", "in": "query", "required": false, "description": "Search by category", "schema": { "type": "string" } }, { "name": "keyword", "in": "query", "required": false, "description": "Search by Keyword", "schema": { "type": "string" } }, { "name": "name_type", "in": "query", "required": false, "description": "Search by Type of Name", "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DomainApiResponse" } } } } } } }, "/api/marketplace/domain-details": { "get": { "tags": [ "Seller Apis" ], "summary": "Get Domain Details", "description": "Get details for a specific domain listing", "operationId": "domainDetails", "parameters": [ { "name": "api_token", "in": "query", "required": true, "description": "API Key to get the details", "schema": { "type": "string", "default": "" } }, { "name": "user_id", "in": "query", "required": true, "description": "UserId of the API Token", "schema": { "type": "string", "default": "" } }, { "name": "domain_name", "in": "query", "required": true, "description": "Domain Name", "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DomainApiResponse" } } } } } } }, "/api/marketplace/add-domain": { "get": { "tags": [ "Seller Apis" ], "summary": "Add Domain to Marketplace", "description": "Add a new domain to Atom. For premium listing, a coin will be deducted from your account and the domain will be submitted for review. For a Standard or Geo listing, the domain landing page will immediately go live", "operationId": "addDomain", "parameters": [ { "name": "api_token", "in": "query", "required": true, "description": "API Key to get the details", "schema": { "type": "string", "default": "" } }, { "name": "user_id", "in": "query", "required": true, "description": "UserId of the API Token", "schema": { "type": "string", "default": "" } }, { "name": "domain_type", "in": "query", "description": "Domain Type (premium, geo or standard)", "schema": { "type": "string", "enum": [ "premium", "standard" ] } }, { "name": "domain_name", "in": "query", "required": true, "description": "Domain Name", "schema": { "type": "string" } }, { "name": "price", "in": "query", "required": true, "description": "Domain Price", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DomainApiResponse" } } } } } } }, "/api/marketplace/remove-domain": { "get": { "tags": [ "Seller Apis" ], "summary": "Remove Domain from Marketplace", "description": "Remove a Standard listing from your account. This method only supports Standard listings. For removing Premium Listings, please contact Atom team to give a 7 day removal notice", "operationId": "removeDomain", "parameters": [ { "name": "api_token", "in": "query", "required": true, "description": "API Key to get the details", "schema": { "type": "string", "default": "" } }, { "name": "user_id", "in": "query", "required": true, "description": "UserId of the API Token", "schema": { "type": "string", "default": "" } }, { "name": "domain_name", "in": "query", "required": true, "description": "Domain Name", "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DomainApiResponse" } } } } } } }, "/api/marketplace/update-selling-price": { "get": { "tags": [ "Seller Apis" ], "summary": "Update selling price of the domain", "description": "Update the selling price of a domain. There are no restrictions for Standard Listings. For Premium Listings, the selling price must be within the allowed range as per your Membership Tier (e.g. Silver, Gold, Platinum)", "operationId": "updateSellingPrice", "parameters": [ { "name": "api_token", "in": "query", "required": true, "description": "API Key to get the details", "schema": { "type": "string", "default": "" } }, { "name": "user_id", "in": "query", "required": true, "description": "UserId of the API Token", "schema": { "type": "string", "default": "" } }, { "name": "domain_name", "in": "query", "required": true, "description": "Domain Name", "schema": { "type": "string" } }, { "name": "selling_price", "in": "query", "required": true, "description": "Selling Price", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DomainApiResponse" } } } } } } }, "/api/marketplace/primary-categories": { "get": { "tags": [ "Seller Apis" ], "summary": "Primary Categories for Domains", "description": "Primary categories (industry) list", "operationId": "primaryCategories", "parameters": [ { "name": "api_token", "in": "query", "required": true, "description": "API Key to get the details", "schema": { "type": "string", "default": "" } }, { "name": "user_id", "in": "query", "required": true, "description": "UserId of the API Token", "schema": { "type": "string", "default": "" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DomainApiResponse" } } } } } } }, "/api/marketplace/assign-primary-category": { "get": { "tags": [ "Seller Apis" ], "summary": "Assign Primary Category for Domain", "description": "Assign a primary category (industry) to a Domain. If the domain already has a primary category, it will be replaced with the new category", "operationId": "assignPrimaryCategory", "parameters": [ { "name": "api_token", "in": "query", "required": true, "description": "API Key to get the details", "schema": { "type": "string", "default": "" } }, { "name": "user_id", "in": "query", "required": true, "description": "UserId of the API Token", "schema": { "type": "string", "default": "" } }, { "name": "domain_name", "in": "query", "required": true, "description": "Domain Name", "schema": { "type": "string" } }, { "name": "category_name", "in": "query", "required": true, "description": "Category Name", "schema": { "enum": [ "categories" ] } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DomainApiResponse" } } } } } } }, "/api/marketplace/update-description": { "post": { "tags": [ "Seller Apis" ], "summary": "Add or update a description for Domain", "description": "Add or update a description for Domain", "operationId": "updateDescription", "parameters": [ { "name": "api_token", "in": "query", "required": true, "description": "API Key to get the details", "schema": { "type": "string", "default": "" } }, { "name": "user_id", "in": "query", "required": true, "description": "UserId of the API Token", "schema": { "type": "string", "default": "" } }, { "name": "domain_name", "in": "query", "required": true, "description": "Domain Name", "schema": { "type": "string" } }, { "name": "domain_description", "in": "query", "required": true, "description": "Domain Description", "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DomainApiResponse" } } } } } } }, "/api/marketplace/all-sales": { "get": { "tags": [ "Seller Apis" ], "summary": "All Sales Data", "description": "Get a list of all your domain sales on Atom platform", "operationId": "allSales", "parameters": [ { "name": "api_token", "in": "query", "required": true, "description": "API Key to get the details", "schema": { "type": "string", "default": "" } }, { "name": "user_id", "in": "query", "required": true, "description": "UserId of the API Token", "schema": { "type": "string", "default": "" } }, { "name": "domain_type", "in": "query", "description": "Domain Type (Premium or Standard)", "schema": { "type": "string", "enum": [ "premium", "standard" ] } }, { "name": "page", "in": "query", "description": "Page number", "schema": { "type": "integer" } }, { "name": "limit", "in": "query", "description": "Number of domains to return", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DomainApiResponse" } } } } } } }, "/api/marketplace/syndication-authorized-domains": { "get": { "tags": [ "Seller Apis" ], "summary": "Syndication Authorized Domains", "description": "Get a list of domains authorized for listing on external platforms", "operationId": "syndicationAuthorizedDomains", "parameters": [ { "name": "api_token", "in": "query", "required": true, "description": "API Key to get the details", "schema": { "type": "string", "default": "" } }, { "name": "user_id", "in": "query", "required": true, "description": "UserId of the API Token", "schema": { "type": "string", "default": "" } }, { "name": "page", "in": "query", "description": "Page number", "schema": { "type": "integer" } }, { "name": "limit", "in": "query", "description": "Number of domains to return", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DomainApiResponse" } } } } } } }, "/api/marketplace/boost-domain": { "get": { "tags": [ "Seller Apis" ], "summary": "Boost Domain", "description": "Boost your Premium domains (Standard Boost or Super Boost). Coins will be deducted from your account balance", "operationId": "boostDomain", "parameters": [ { "name": "api_token", "in": "query", "required": true, "description": "API Key to get the details", "schema": { "type": "string", "default": "" } }, { "name": "user_id", "in": "query", "required": true, "description": "UserId of the API Token", "schema": { "type": "string", "default": "" } }, { "name": "domain_name", "in": "query", "required": true, "description": "Domain Name", "schema": { "type": "string" } }, { "name": "boosting_type", "in": "query", "required": true, "description": "Boosting Type (Standard or Super)", "schema": { "type": "string", "enum": [ "standard", "Super" ] } }, { "name": "source_of_deduction", "in": "query", "required": true, "description": "Source of Deduction ('points', 'coins', 'loyalty_benefit')", "schema": { "type": "string", "enum": [ "points", "coins", "loyalty_benefit" ] } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DomainApiResponse" } } } } } } }, "/api/marketplace/domain-analytics": { "get": { "tags": [ "Seller Apis" ], "summary": "Domain Analytics", "description": "Get analytics related to your domains (e.g. Views and Shortlists)", "operationId": "domainAnalytics", "parameters": [ { "name": "api_token", "in": "query", "required": true, "description": "API Key to get the details", "schema": { "type": "string", "default": "" } }, { "name": "user_id", "in": "query", "required": true, "description": "UserId of the API Token", "schema": { "type": "string", "default": "" } }, { "name": "domain_name", "in": "query", "required": true, "description": "Domain Name", "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DomainApiResponse" } } } } } } }, "/api/marketplace/add-discount": { "get": { "tags": [ "Seller Apis" ], "summary": "Add Discount", "description": "Apply a discount to your domain. The discount will automatically reset every Monday", "operationId": "addDiscount", "parameters": [ { "name": "api_token", "in": "query", "required": true, "description": "API Key to get the details", "schema": { "type": "string", "default": "" } }, { "name": "user_id", "in": "query", "required": true, "description": "UserId of the API Token", "schema": { "type": "string", "default": "" } }, { "name": "domain_name", "in": "query", "required": true, "description": "Domain Name", "schema": { "type": "string" } }, { "name": "discount", "in": "query", "required": true, "description": "Discount", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DomainApiResponse" } } } } } } }, "/api/marketplace/verify-dns": { "get": { "tags": [ "Seller Apis" ], "summary": "Verify DNS", "description": "Verify DNS of the given domain", "operationId": "verifyDNS", "parameters": [ { "name": "api_token", "in": "query", "required": true, "description": "API Key to get the details", "schema": { "type": "string", "default": "" } }, { "name": "user_id", "in": "query", "required": true, "description": "UserId of the API Token", "schema": { "type": "string", "default": "" } }, { "name": "domain_name", "in": "query", "required": true, "description": "Domain Name", "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DomainApiResponse" } } } } } } }, "/api/marketplace/upload-grade-domains": { "post": { "tags": [ "Seller Apis" ], "summary": "Upload Domains For Grading", "description": "Upload Domains For Grading", "operationId": "uploadGradeDomains", "parameters": [ { "name": "api_token", "in": "query", "required": true, "description": "API Key to get the details", "schema": { "type": "string", "default": "" } }, { "name": "user_id", "in": "query", "required": true, "description": "UserId of the API Token", "schema": { "type": "string", "default": "" } }, { "name": "domains_data", "in": "query", "required": true, "description": "List of Domains, comma seperated", "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GradeDomainUploadResponse" } } } } } } }, "/api/marketplace/get-grade-domain-result": { "get": { "tags": [ "Seller Apis" ], "summary": "Grade Domains Result", "description": "Grade Domains Result", "operationId": "getGradeDomainResult", "parameters": [ { "name": "api_token", "in": "query", "required": true, "description": "API Key to get the details", "schema": { "type": "string", "default": "" } }, { "name": "user_id", "in": "query", "required": true, "description": "UserId of the API Token", "schema": { "type": "string", "default": "" } }, { "name": "page", "in": "query", "required": false, "description": "Page", "schema": { "type": "string" } }, { "name": "size", "in": "query", "required": false, "description": "Size", "schema": { "type": "string" } }, { "name": "brand_fit_only", "in": "query", "required": false, "description": "Brand Fit Only", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GradeDomainResponse" } } } } } } }, "/api/marketplace/partnership-search": { "get": { "tags": [ "Parnership Apis" ], "summary": "Get Available Domains", "description": "Search premium partner-eligible domains (Approved or Plus, NS-verified, $500+). Optional category, TLD, and price facet filters.", "operationId": "SearchDomains", "parameters": [ { "name": "api_token", "in": "query", "required": true, "description": "API Key to get the details", "schema": { "type": "string", "default": "" } }, { "name": "user_id", "in": "query", "required": true, "description": "UserId of the API Token", "schema": { "type": "string", "default": "" } }, { "name": "query", "in": "query", "required": false, "description": "Search Query to Pass", "schema": { "type": "string", "default": "" } }, { "name": "page", "in": "query", "description": "Page number", "schema": { "type": "integer" } }, { "name": "page_size", "in": "query", "description": "Page size (max 100)", "schema": { "type": "integer" } }, { "name": "category", "in": "query", "required": false, "description": "Optional category facet filter. Comma-separated parent category names or ids (e.g. Technology,Health).", "schema": { "type": "string" } }, { "name": "tlds", "in": "query", "required": false, "description": "Optional TLD facet filter. Comma-separated extensions (e.g. com,io,ai or .com,.io,.ai).", "schema": { "type": "string" } }, { "name": "price", "in": "query", "required": false, "description": "Optional price facet filter. Marketplace price-range labels: Below $2000, From $2K to $5K, From $5K to $10K, From $10K to $50K, Greater Than $50K. Also accepts a numeric range such as 2000-5000.", "schema": { "type": "string" } }, { "name": "min_price", "in": "query", "required": false, "description": "Optional minimum selling price in USD.", "schema": { "type": "integer" } }, { "name": "max_price", "in": "query", "required": false, "description": "Optional maximum selling price in USD.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/searchResponse" } } } } } } }, "/api/marketplace/new-listings": { "get": { "tags": [ "Parnership Apis" ], "summary": "Get New Listings by Date", "description": "Return marketplace domains approved on a given date. Use listing_type=Curated for premium Approved listings only, or All for Approved and Seller Approved.", "operationId": "newListings", "parameters": [ { "name": "api_token", "in": "query", "required": true, "description": "API Key to get the details", "schema": { "type": "string", "default": "" } }, { "name": "user_id", "in": "query", "required": true, "description": "UserId of the API Token", "schema": { "type": "string", "default": "" } }, { "name": "date", "in": "query", "required": true, "description": "Approval date in YYYY-MM-DD format", "schema": { "type": "string" } }, { "name": "listing_type", "in": "query", "required": false, "description": "Curated (Approved only) or All (Approved + Seller Approved)", "schema": { "type": "string", "enum": [ "Curated", "All" ], "default": "All" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewListingsResponse" } } } } } } }, "/api/marketplace/orders": { "get": { "tags": [ "Parnership Apis" ], "summary": "List Partner Orders", "description": "List marketplace orders created through the partnership API for the authenticated partner.", "operationId": "partnerOrderList", "parameters": [ { "name": "api_token", "in": "query", "required": true, "description": "API Key to get the details", "schema": { "type": "string", "default": "" } }, { "name": "user_id", "in": "query", "required": true, "description": "UserId of the API Token", "schema": { "type": "string", "default": "" } }, { "name": "page", "in": "query", "description": "Page number", "schema": { "type": "integer", "default": 1 } }, { "name": "limit", "in": "query", "description": "Results per page (max 100)", "schema": { "type": "integer", "default": 20 } }, { "name": "domain_name", "in": "query", "description": "Optional domain name filter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerOrderListResponse" } } } } } } }, "/api/marketplace/order-details": { "get": { "tags": [ "Parnership Apis" ], "summary": "Get Partner Order Details", "description": "Get a single partnership order, including transfer and payout details.", "operationId": "partnerOrderDetails", "parameters": [ { "name": "api_token", "in": "query", "required": true, "description": "API Key to get the details", "schema": { "type": "string", "default": "" } }, { "name": "user_id", "in": "query", "required": true, "description": "UserId of the API Token", "schema": { "type": "string", "default": "" } }, { "name": "order_id", "in": "query", "required": true, "description": "Marketplace order ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerOrderDetailsResponse" } } } } } } }, "/api/marketplace/domain-data": { "get": { "tags": [ "Parnership Apis" ], "summary": "Get Domain Data", "description": "Get Domain Details with the Domain Name", "operationId": "ParnershipDomainDetails", "parameters": [ { "name": "api_token", "in": "query", "required": true, "description": "API Key to get the details", "schema": { "type": "string", "default": "" } }, { "name": "user_id", "in": "query", "required": true, "description": "UserId of the API Token", "schema": { "type": "string", "default": "" } }, { "name": "domain_name", "in": "query", "required": true, "description": "Domain Name or Domain ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DomainApiResponse" } } } } } } }, "/api/marketplace/hold-domain": { "post": { "tags": [ "Parnership Apis" ], "summary": "Hold Domain Request", "description": "Hold Domain Request", "operationId": "HoldDomainRequest", "parameters": [ { "name": "api_token", "in": "query", "required": true, "description": "API Key to get the details", "schema": { "type": "string", "default": "" } }, { "name": "user_id", "in": "query", "required": true, "description": "UserId of the API Token", "schema": { "type": "string", "default": "" } }, { "name": "domain_id", "in": "query", "required": true, "description": "Domain ID to pass", "schema": { "type": "integer", "default": "" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HoldDomainResponse" } } } } } } }, "/api/marketplace/confirm-order": { "post": { "tags": [ "Parnership Apis" ], "summary": "Confirm Order on the Hold Domains", "description": "Confirm Order on the Hold Domains", "operationId": "ConfirmOrder", "parameters": [ { "name": "api_token", "in": "query", "required": true, "description": "API Key to get the details", "schema": { "type": "string", "default": "" } }, { "name": "user_id", "in": "query", "required": true, "description": "UserId of the API Token", "schema": { "type": "string", "default": "" } }, { "name": "domain_id", "in": "query", "required": true, "description": "Domain ID to pass", "schema": { "type": "integer", "default": "" } }, { "name": "payment_amount", "in": "query", "required": false, "description": "Custom Amount other than selling_price", "schema": { "type": "integer", "default": "" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfirmOrderResponse" } } } } } } }, "/api/marketplace/unhold-domain": { "post": { "tags": [ "Parnership Apis" ], "summary": "UnHold Domain Request", "description": "UnHold Domain Request", "operationId": "UnHoldDomainRequest", "parameters": [ { "name": "api_token", "in": "query", "required": true, "description": "API Key to get the details", "schema": { "type": "string", "default": "" } }, { "name": "user_id", "in": "query", "required": true, "description": "UserId of the API Token", "schema": { "type": "string", "default": "" } }, { "name": "domain_id", "in": "query", "required": true, "description": "Domain ID to pass", "schema": { "type": "integer", "default": "" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnHoldDomainResponse" } } } } } } }, "/api/marketplace/submit-transfer-code": { "post": { "tags": [ "Parnership Apis" ], "summary": "Submit Transfer Code", "description": "Submit Transfer Code", "operationId": "SubmitTransferCode", "parameters": [ { "name": "api_token", "in": "query", "required": true, "description": "API Key to get the details", "schema": { "type": "string", "default": "" } }, { "name": "user_id", "in": "query", "required": true, "description": "UserId of the API Token", "schema": { "type": "string", "default": "" } }, { "name": "domain_id", "in": "query", "required": true, "description": "Domain ID to pass", "schema": { "type": "integer", "default": "" } }, { "name": "code", "in": "query", "required": true, "description": "Auth Code", "schema": { "type": "string", "default": "" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitTransferCodeResponse" } } } } } } }, "/api/marketplace/get-transfer-auth-code": { "post": { "tags": [ "Parnership Apis" ], "summary": "Get Transfer Auth Code", "description": "Get Transfer Auth Code", "operationId": "GetTransferAuthCode", "parameters": [ { "name": "api_token", "in": "query", "required": true, "description": "API Key to get the details", "schema": { "type": "string", "default": "" } }, { "name": "user_id", "in": "query", "required": true, "description": "UserId of the API Token", "schema": { "type": "string", "default": "" } }, { "name": "domain_id", "in": "query", "required": true, "description": "Domain ID to pass", "schema": { "type": "integer", "default": "" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitTransferCodeResponse" } } } } } } }, "/api/marketplace/started-transfer": { "post": { "tags": [ "Parnership Apis" ], "summary": "Started Transfer", "description": "Started Transfer", "operationId": "Started Transfer", "parameters": [ { "name": "api_token", "in": "query", "required": true, "description": "API Key to get the details", "schema": { "type": "string", "default": "" } }, { "name": "user_id", "in": "query", "required": true, "description": "UserId of the API Token", "schema": { "type": "string", "default": "" } }, { "name": "domain_id", "in": "query", "required": true, "description": "Domain ID to pass", "schema": { "type": "integer", "default": "" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitTransferCodeResponse" } } } } } } }, "/api/marketplace/semantic-search": { "get": { "tags": [ "Parnership Apis" ], "summary": "AI-Powered Semantic Domain Search", "description": "Search for domain names using AI-powered semantic search with embeddings and Pinecone. This API creates embeddings for natural language queries and finds semantically similar domains.", "operationId": "SemanticSearch", "parameters": [ { "name": "api_token", "in": "query", "required": true, "description": "API Key to get the details", "schema": { "type": "string", "default": "" } }, { "name": "user_id", "in": "query", "required": true, "description": "UserId of the API Token", "schema": { "type": "string", "default": "" } }, { "name": "query", "in": "query", "required": true, "description": "Natural language search query (e.g., 'tech startup names', 'healthcare companies')", "schema": { "type": "string", "example": "tech startup names" } }, { "name": "filters", "in": "query", "required": false, "description": "Optional filters to apply to the search (JSON string)", "schema": { "type": "string", "example": "{\"extensions\":[\".com\",\".io\"],\"min_price\":1000,\"type_of_name\":[\"One Word\"]}" } }, { "name": "page", "in": "query", "required": false, "description": "Page number for pagination (default: 1)", "schema": { "type": "integer", "default": 1, "example": 1, "minimum": 1 } }, { "name": "page_size", "in": "query", "required": false, "description": "Number of results per page (default: 20, max: 100)", "schema": { "type": "integer", "default": 20, "example": 20, "minimum": 1, "maximum": 100 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "query": { "type": "string", "example": "tech startup names" }, "page": { "type": "integer", "example": 1 }, "page_size": { "type": "integer", "example": 20 }, "total": { "type": "integer", "example": 45 }, "total_pages": { "type": "integer", "example": 3 }, "processing_time_ms": { "type": "number", "example": 1250 }, "domains": { "type": "array", "items": { "type": "object", "properties": { "domain_name": { "type": "string", "example": "innovatech" }, "tld": { "type": "string", "example": "com" }, "full_domain": { "type": "string", "example": "innovatech.com" }, "selling_price": { "type": "number", "example": 2500 }, "primary_category": { "type": "string", "example": "Technology" }, "status": { "type": "string", "example": "Approved" }, "description": { "type": "string", "example": "Perfect for innovative technology companies" }, "created_at": { "type": "string", "format": "date-time", "example": "2023-06-15T10:30:00Z" }, "owner_name": { "type": "string", "example": "Private" }, "semantic_score": { "type": "number", "description": "Semantic similarity score from Pinecone", "example": 0.85 }, "rerank_score": { "type": "number", "description": "Reranked score after applying quality factors", "example": 0.92 }, "metadata": { "type": "object", "properties": { "base_quality_score": { "type": "number", "example": 0.8 }, "overall_rank": { "type": "number", "example": 4.2 }, "dictionary_rank": { "type": "number", "example": 0.9 }, "tm_conflicts": { "type": "integer", "example": 12 }, "type_of_name": { "type": "string", "example": "Two Word" }, "length": { "type": "string", "example": "Medium" } } } } } } } } } } }, "400": { "description": "Bad request - Query is required", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Query is required" } } } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Daily rate limit exceeded. You have used 50 of 50 daily semantic search requests." } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Semantic search error: Failed to generate embedding for query" } } } } } } } } }, "/api/marketplace/smart-domain-search": { "get": { "tags": [ "Smart Search Apis" ], "summary": "SmartDomainSearch", "description": "SmartDomainSearch", "operationId": "SmartDomainSearch", "parameters": [ { "name": "api_token", "in": "query", "required": true, "description": "API Key to get the details", "schema": { "type": "string", "default": "" } }, { "name": "user_id", "in": "query", "required": true, "description": "UserId of the API Token", "schema": { "type": "string", "default": "" } }, { "name": "keyword", "in": "query", "required": true, "description": "Describe your business (Ex: Beauty Brand)", "schema": { "type": "string", "default": "" } } ], "responses": { "200": { "description": "success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SmartDomainSearchResponse" } } } } } } }, "/api/marketplace/domain-appraisal": { "get": { "tags": [ "Appraisal Apis" ], "summary": "Get Domain Appraisal", "description": "Get an AI-powered appraisal for a domain including estimated price, domain score, key signals, and root words. Accepts either dedicated Appraisal API token OR Seller API token with atom_seller=1 permission.", "operationId": "domainAppraisal", "parameters": [ { "name": "api_token", "in": "query", "required": true, "description": "API Key (Appraisal API token OR Seller API token with atom_seller=1 permission)", "schema": { "type": "string", "default": "" } }, { "name": "user_id", "in": "query", "required": true, "description": "UserId of the API Token", "schema": { "type": "string", "default": "" } }, { "name": "domain_name", "in": "query", "required": true, "description": "Domain Name to appraise", "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DomainAppraisalResponse" } } } }, "403": { "description": "Invalid API token or insufficient permissions", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Wrong API Token" } } } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Daily rate limit exceeded. You have used 10 of 10 daily appraisal requests." }, "daily_limit": { "type": "integer", "example": 10 }, "used_today": { "type": "integer", "example": 10 } } } } } } } } }, "/api/marketplace/trademark-search": { "get": { "tags": [ "Trademark Apis" ], "summary": "Search Trademarks", "description": "Search for trademarks in the USPTO database based on keyword and various filters. Requires dedicated Trademark API token.", "operationId": "trademarkSearch", "parameters": [ { "name": "api_token", "in": "query", "required": true, "description": "Trademark API token (dedicated for trademark functionality)", "schema": { "type": "string", "default": "" } }, { "name": "user_id", "in": "query", "required": true, "description": "UserId of the API Token", "schema": { "type": "string", "default": "" } }, { "name": "keyword", "in": "query", "required": true, "description": "Keyword to search for in trademark names", "schema": { "type": "string" } }, { "name": "search_type", "in": "query", "required": false, "description": "Type of search to perform", "schema": { "type": "string", "enum": [ "exact", "phrase", "broad" ], "default": "phrase" } }, { "name": "filing_status", "in": "query", "required": false, "description": "Filter by trademark filing status", "schema": { "type": "string", "enum": [ "active", "pending", "dead", "all" ], "default": "all" } }, { "name": "class", "in": "query", "required": false, "description": "International class filter (e.g., '009' for computer software)", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "Page number for pagination", "schema": { "type": "integer", "default": 1 } }, { "name": "page_size", "in": "query", "required": false, "description": "Number of results per page (max 100)", "schema": { "type": "integer", "default": 20 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrademarkSearchResponse" } } } }, "403": { "description": "Invalid API token or insufficient permissions", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Wrong API Token" } } } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Daily rate limit exceeded. You have used 10 of 10 daily trademark search requests." }, "daily_limit": { "type": "integer", "example": 10 }, "used_today": { "type": "integer", "example": 10 } } } } } } } } }, "/api/registrar/v1/domains": { "get": { "tags": [ "Domains" ], "summary": "List domains", "description": "Paginated list of domains in the authenticated Atom registrar account. Each row includes transfer_locked, icann_transfer_lock, icann_transfer_lock_expires_at, and can_transfer_out.", "operationId": "listRegistrarDomains", "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1, "minimum": 1 } }, { "name": "size", "in": "query", "schema": { "type": "integer", "default": 20, "minimum": 1, "maximum": 100 } }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Filter by domain name" }, { "name": "extension", "in": "query", "schema": { "type": "string", "example": "com" }, "description": "Filter by TLD" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/RegistrarDomain" } }, "pagination": { "$ref": "#/components/schemas/Pagination" } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing or invalid Bearer token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden for this domain", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Domain not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/registrar/v1/tld-pricing": { "get": { "tags": [ "Availability" ], "summary": "Get TLD pricing", "description": "Atom register, renew, and transfer prices for every supported TLD (USD). Use this for catalog-level quotes. For a specific label (including premium registry pricing), call GET /domains/check/{domain_name} and read data.domain_price.", "operationId": "getTldPricing", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "currency": { "type": "string", "example": "USD" }, "pricing": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/TldPrice" } } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing or invalid Bearer token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden for this domain", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Domain not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/registrar/v1/domains/check/{domain_name}": { "get": { "tags": [ "Availability" ], "summary": "Check domain availability and Atom price", "description": "Returns whether Atom can register the domain and, when available, data.domain_price — the amount Atom would charge (unit_price, renewal_price, ICANN fee, VAT, total). Premium labels are reflected in is_premium and unit_price. If status is unavailable, Atom cannot register it; inbound transfer pricing for that TLD is on GET /tld-pricing (pricing.{tld}.transfer). Optional years query (1–10) quotes a multi-year registration; .ai defaults to 2.", "operationId": "checkDomain", "parameters": [ { "name": "domain_name", "in": "path", "required": true, "description": "Fully qualified domain name", "schema": { "type": "string", "example": "example.com" } }, { "name": "years", "in": "query", "required": false, "description": "Registration length to quote (1–10). Defaults to 1, or 2 for .ai.", "schema": { "type": "integer", "minimum": 1, "maximum": 10 } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "domain": { "type": "string" }, "availability": { "type": "integer", "description": "1 available, 0 unavailable, -1 unknown" }, "status": { "type": "string", "enum": [ "available", "unavailable", "unknown" ] }, "domain_price": { "$ref": "#/components/schemas/DomainPrice" } } } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing or invalid Bearer token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden for this domain", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Domain not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/registrar/v1/domains/check-bulk": { "post": { "tags": [ "Availability" ], "summary": "Bulk domain availability", "description": "Check up to 50 domains per request. Available domains include domain_price (what Atom would charge to register each one).", "operationId": "checkDomainBulk", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "domains" ], "properties": { "domains": { "type": "array", "maxItems": 50, "items": { "type": "string", "example": "example.com" } } } } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object" } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing or invalid Bearer token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden for this domain", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Domain not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/registrar/v1/domains/register": { "post": { "tags": [ "Domains" ], "summary": "Register a domain", "description": "Register a domain for 1–10 years (.ai requires an even length). Requires account balance or a saved payment method. After a successful registration you may set nameservers, WHOIS privacy, auto-renew, contact handles, and DNS records in this same request; they are applied immediately. DNS records require Atom nameservers (omit nameservers, or set type atom/parking).", "operationId": "registerDomain", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "domain_name" ], "properties": { "domain_name": { "type": "string", "example": "example.com" }, "registration_length": { "type": "integer", "minimum": 1, "maximum": 10, "default": 1 }, "nameservers": { "description": "Set nameservers in the same request. Pass an array of hostnames (treated as custom) or {type, nameservers}. type: atom (ns1/ns2.atom.com), parking (ns1/ns2.atomregistrar.com), or custom. DNS records only apply when the domain stays on Atom nameservers (atom or parking).", "oneOf": [ { "type": "array", "items": { "type": "string" }, "example": [ "ns1.custom-dns.com", "ns2.custom-dns.com" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "atom", "parking", "custom" ] }, "nameservers": { "type": "array", "items": { "type": "string" } } } } ] }, "privacy_protect": { "type": "boolean", "description": "WHOIS privacy / RDDS redaction. Alias: whois_privacy. Not available for .io." }, "whois_privacy": { "type": "boolean", "description": "Alias for privacy_protect" }, "auto_renew": { "type": "boolean", "description": "Enable or disable auto-renew." }, "contacts": { "type": "object", "description": "Existing contact handles owned by this account (from GET /contacts). Any combination of roles.", "properties": { "registrant": { "type": "string" }, "admin": { "type": "string" }, "billing": { "type": "string" }, "tech": { "type": "string" } } }, "dns_records": { "type": "array", "description": "DNS records to create after the domain is on Atom nameservers. Max 50. Same fields as POST /domains/{domain_name}/records. Skipped if nameservers are custom.", "maxItems": 50, "items": { "$ref": "#/components/schemas/DnsRecordInput" } } } } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Domain already registered to this account", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing or invalid Bearer token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden for this domain", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Domain not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/registrar/v1/domains/transfer": { "post": { "tags": [ "Transfers", "Domains" ], "summary": "Transfer a domain into Atom", "description": "Initiate an inbound transfer. Required: domain_name and authcode (EPP code from the losing registrar). Optional nameservers, privacy_protect, auto_renew, contacts, and dns_records may be sent in the same request. Contacts and WHOIS privacy are submitted with the transfer; nameservers, auto-renew, and DNS records are applied when the transfer completes (typically 5–7 days). This is transfer-in only. Transfer-out of Atom is not available via API — use the Atom dashboard.", "operationId": "transferDomain", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "domain_name", "authcode" ], "properties": { "domain_name": { "type": "string", "example": "example.com" }, "authcode": { "type": "string", "description": "EPP / auth code from the losing registrar" }, "nameservers": { "description": "Set nameservers in the same request. Pass an array of hostnames (treated as custom) or {type, nameservers}. type: atom (ns1/ns2.atom.com), parking (ns1/ns2.atomregistrar.com), or custom. DNS records only apply when the domain stays on Atom nameservers (atom or parking).", "oneOf": [ { "type": "array", "items": { "type": "string" }, "example": [ "ns1.custom-dns.com", "ns2.custom-dns.com" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "atom", "parking", "custom" ] }, "nameservers": { "type": "array", "items": { "type": "string" } } } } ] }, "privacy_protect": { "type": "boolean", "description": "WHOIS privacy / RDDS redaction. Alias: whois_privacy. Not available for .io." }, "whois_privacy": { "type": "boolean", "description": "Alias for privacy_protect" }, "auto_renew": { "type": "boolean", "description": "Enable or disable auto-renew." }, "contacts": { "type": "object", "description": "Existing contact handles owned by this account (from GET /contacts). Any combination of roles.", "properties": { "registrant": { "type": "string" }, "admin": { "type": "string" }, "billing": { "type": "string" }, "tech": { "type": "string" } } }, "dns_records": { "type": "array", "description": "DNS records to create after the domain is on Atom nameservers. Max 50. Same fields as POST /domains/{domain_name}/records. Skipped if nameservers are custom.", "maxItems": 50, "items": { "$ref": "#/components/schemas/DnsRecordInput" } } } } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing or invalid Bearer token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden for this domain", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Domain not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/registrar/v1/domains/transfer-bulk": { "post": { "tags": [ "Transfers", "Domains" ], "summary": "Bulk transfer domains into Atom", "description": "Transfer up to 10 domains per request. Each item requires domain_name and authcode. This is inbound only.", "operationId": "transferDomainBulk", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "domains" ], "properties": { "domains": { "type": "array", "maxItems": 10, "items": { "type": "object", "required": [ "domain_name", "authcode" ], "properties": { "domain_name": { "type": "string" }, "authcode": { "type": "string" } } } } } } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing or invalid Bearer token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden for this domain", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Domain not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/registrar/v1/domains/{domain_name}": { "get": { "tags": [ "Domains" ], "summary": "Get domain details", "description": "Full record for a domain in this account, including nameservers, contacts, transfer_locked, icann_transfer_lock, icann_transfer_lock_expires_at, and can_transfer_out. Use the ICANN expiry date to tell a customer when the 60-day transfer restriction lifts. Transfer-out is dashboard-only.", "operationId": "getRegistrarDomain", "parameters": [ { "name": "domain_name", "in": "path", "required": true, "description": "Fully qualified domain name", "schema": { "type": "string", "example": "example.com" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/RegistrarDomain" } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing or invalid Bearer token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden for this domain", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Domain not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/registrar/v1/domains/{domain_name}/renew": { "post": { "tags": [ "Domains" ], "summary": "Renew a domain", "description": "Renew a domain already registered at Atom for 1–10 years (.ai must be even). Charges account balance or a saved card. Returns the new expiry date and price_breakdown. This is the domain renewal endpoint.", "operationId": "renewDomain", "parameters": [ { "name": "domain_name", "in": "path", "required": true, "description": "Fully qualified domain name", "schema": { "type": "string", "example": "example.com" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "renewal_length": { "type": "integer", "minimum": 1, "maximum": 10, "default": 1, "description": ".ai must be even years" } } } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing or invalid Bearer token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden for this domain", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Domain not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/registrar/v1/domains/{domain_name}/lock": { "get": { "tags": [ "Transfers", "Locking & Privacy" ], "summary": "Get transfer lock (registrar + ICANN 60-day)", "description": "Returns the customer-controlled registrar lock (locked / transfer_locked) and the automatic ICANN 60-day transfer restriction (icann_transfer_lock, icann_transfer_lock_expires_at). Use icann_transfer_lock_expires_at to tell a customer when the 60-day lock expires. can_transfer_out is true only when both are off; transferring out is done in the Atom dashboard, not via this API.", "operationId": "getRegistrarLock", "parameters": [ { "name": "domain_name", "in": "path", "required": true, "description": "Fully qualified domain name", "schema": { "type": "string", "example": "example.com" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "locked": { "type": "boolean", "description": "Customer-controlled registrar lock" }, "status": { "type": "string", "enum": [ "locked", "unlocked" ] }, "transfer_locked": { "type": "boolean" }, "icann_transfer_lock": { "type": "boolean" }, "icann_transfer_lock_expires_at": { "type": "string", "nullable": true }, "can_transfer_out": { "type": "boolean" } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing or invalid Bearer token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden for this domain", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Domain not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "Transfers", "Locking & Privacy" ], "summary": "Set registrar transfer lock", "description": "Lock a domain (CLIENT_TRANSFER_PROHIBITED). Unlocking and retrieving an EPP code are transfer-out actions and are only available in the Atom dashboard. This does not lift the ICANN 60-day lock.", "operationId": "saveRegistrarLock", "parameters": [ { "name": "domain_name", "in": "path", "required": true, "description": "Fully qualified domain name", "schema": { "type": "string", "example": "example.com" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "locked" ], "properties": { "locked": { "type": "boolean", "description": "Must be true. Unlocking via API is not supported." } } } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing or invalid Bearer token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden for this domain", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Domain not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/registrar/v1/domains/{domain_name}/nameservers": { "get": { "tags": [ "Nameservers" ], "summary": "Get nameservers", "operationId": "getNameservers", "parameters": [ { "name": "domain_name", "in": "path", "required": true, "description": "Fully qualified domain name", "schema": { "type": "string", "example": "example.com" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing or invalid Bearer token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden for this domain", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Domain not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "Nameservers" ], "summary": "Update nameservers", "description": "Set type to atom (Atom marketplace NS), parking (Atom default NS), or custom. Custom requires a nameservers array. DNS record APIs only work when the domain is on atom or parking nameservers.", "operationId": "updateNameservers", "parameters": [ { "name": "domain_name", "in": "path", "required": true, "description": "Fully qualified domain name", "schema": { "type": "string", "example": "example.com" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "atom", "parking", "custom" ], "default": "custom" }, "nameservers": { "type": "array", "items": { "type": "string" }, "example": [ "ns1.custom-dns.com", "ns2.custom-dns.com" ] } } } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing or invalid Bearer token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden for this domain", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Domain not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/registrar/v1/domains/{domain_name}/privacy": { "put": { "tags": [ "Locking & Privacy" ], "summary": "Set WHOIS privacy", "description": "Enable or disable WHOIS / RDDS privacy for a domain you hold at Atom. Not available for .io. Can also be set at register or transfer time via privacy_protect.", "operationId": "updatePrivacy", "parameters": [ { "name": "domain_name", "in": "path", "required": true, "description": "Fully qualified domain name", "schema": { "type": "string", "example": "example.com" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "enabled" ], "properties": { "enabled": { "type": "boolean" } } } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing or invalid Bearer token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden for this domain", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Domain not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/registrar/v1/domains/{domain_name}/auto-renew": { "put": { "tags": [ "Locking & Privacy" ], "summary": "Set auto-renew", "description": "Enable or disable auto-renewal for a domain you hold at Atom. Can also be set at register or transfer time via auto_renew.", "operationId": "updateAutoRenew", "parameters": [ { "name": "domain_name", "in": "path", "required": true, "description": "Fully qualified domain name", "schema": { "type": "string", "example": "example.com" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "enabled": { "type": "boolean" } } } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing or invalid Bearer token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden for this domain", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Domain not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/registrar/v1/domains/{domain_name}/url-forwards": { "get": { "tags": [ "URL Forwards" ], "summary": "List URL forwards", "operationId": "getUrlForwards", "parameters": [ { "name": "domain_name", "in": "path", "required": true, "description": "Fully qualified domain name", "schema": { "type": "string", "example": "example.com" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing or invalid Bearer token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden for this domain", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Domain not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "URL Forwards" ], "summary": "Create URL forward", "operationId": "createUrlForward", "parameters": [ { "name": "domain_name", "in": "path", "required": true, "description": "Fully qualified domain name", "schema": { "type": "string", "example": "example.com" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "destination" ], "properties": { "source": { "type": "string", "example": "www.example.com" }, "destination": { "type": "string", "example": "https://example.net" }, "type": { "type": "string", "enum": [ "temporary", "permanent" ], "default": "temporary" } } } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing or invalid Bearer token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden for this domain", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Domain not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/registrar/v1/domains/{domain_name}/url-forwards/{forward_id}": { "delete": { "tags": [ "URL Forwards" ], "summary": "Delete URL forward", "operationId": "deleteUrlForward", "parameters": [ { "name": "domain_name", "in": "path", "required": true, "description": "Fully qualified domain name", "schema": { "type": "string", "example": "example.com" } }, { "name": "forward_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing or invalid Bearer token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden for this domain", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Domain not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/registrar/v1/domains/{domain_name}/records": { "get": { "tags": [ "DNS" ], "summary": "List DNS records", "operationId": "listDnsRecords", "parameters": [ { "name": "domain_name", "in": "path", "required": true, "description": "Fully qualified domain name", "schema": { "type": "string", "example": "example.com" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DnsRecord" } } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing or invalid Bearer token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden for this domain", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Domain not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "DNS" ], "summary": "Create DNS record", "operationId": "createDnsRecord", "parameters": [ { "name": "domain_name", "in": "path", "required": true, "description": "Fully qualified domain name", "schema": { "type": "string", "example": "example.com" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "content" ], "properties": { "type": { "type": "string", "enum": [ "A", "AAAA", "CNAME", "MX", "TXT", "NS", "SRV", "CAA", "PTR" ] }, "name": { "type": "string", "example": "www" }, "content": { "type": "string", "example": "192.168.1.1" }, "ttl": { "type": "integer", "default": 3600 }, "comment": { "type": "string" }, "priority": { "type": "integer", "description": "Required for MX; also used for SRV" }, "service": { "type": "string", "description": "SRV only" }, "protocol": { "type": "string", "description": "SRV only" }, "weight": { "type": "integer", "description": "SRV only" }, "port": { "type": "integer", "description": "SRV only" }, "target": { "type": "string", "description": "SRV only" }, "flags": { "type": "integer", "description": "CAA only" }, "tag": { "type": "string", "description": "CAA only" }, "value": { "type": "string", "description": "CAA only" } } } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing or invalid Bearer token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden for this domain", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Domain not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/registrar/v1/domains/{domain_name}/records/{record_id}": { "put": { "tags": [ "DNS" ], "summary": "Update DNS record", "operationId": "updateDnsRecord", "parameters": [ { "name": "domain_name", "in": "path", "required": true, "description": "Fully qualified domain name", "schema": { "type": "string", "example": "example.com" } }, { "name": "record_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "content": { "type": "string" }, "ttl": { "type": "integer" }, "comment": { "type": "string" } } } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing or invalid Bearer token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden for this domain", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Domain not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "DNS" ], "summary": "Delete DNS record", "operationId": "deleteDnsRecord", "parameters": [ { "name": "domain_name", "in": "path", "required": true, "description": "Fully qualified domain name", "schema": { "type": "string", "example": "example.com" } }, { "name": "record_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing or invalid Bearer token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden for this domain", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Domain not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/registrar/v1/domains/{domain_name}/dns/bulk-delete": { "delete": { "tags": [ "DNS" ], "summary": "Bulk delete DNS records", "operationId": "bulkDeleteDnsRecords", "parameters": [ { "name": "domain_name", "in": "path", "required": true, "description": "Fully qualified domain name", "schema": { "type": "string", "example": "example.com" } }, { "name": "type", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Record type to delete (A, MX, …)" }, { "name": "subdomain", "in": "query", "schema": { "type": "string" }, "description": "Optional hostname; use @ for apex" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing or invalid Bearer token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden for this domain", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Domain not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/registrar/v1/domains/{domain_name}/dnssec": { "get": { "tags": [ "DNS" ], "summary": "Get DNSSEC status", "operationId": "getDnssec", "parameters": [ { "name": "domain_name", "in": "path", "required": true, "description": "Fully qualified domain name", "schema": { "type": "string", "example": "example.com" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing or invalid Bearer token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden for this domain", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Domain not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/registrar/v1/domains/{domain_name}/dnssec/enable": { "post": { "tags": [ "DNS" ], "summary": "Enable DNSSEC", "operationId": "enableDnssec", "parameters": [ { "name": "domain_name", "in": "path", "required": true, "description": "Fully qualified domain name", "schema": { "type": "string", "example": "example.com" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing or invalid Bearer token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden for this domain", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Domain not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/registrar/v1/domains/{domain_name}/dnssec/disable": { "post": { "tags": [ "DNS" ], "summary": "Disable DNSSEC", "operationId": "disableDnssec", "parameters": [ { "name": "domain_name", "in": "path", "required": true, "description": "Fully qualified domain name", "schema": { "type": "string", "example": "example.com" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing or invalid Bearer token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden for this domain", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Domain not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/registrar/v1/contacts": { "get": { "tags": [ "Contacts" ], "summary": "List or search contacts", "description": "Returns every contact handle on the account. Filter with search (matches handle, name, email, label, organization), name, and/or email to find a handle from a person's name or email address.", "operationId": "listContacts", "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Case-insensitive match against handle, name, email, label, or organization" }, { "name": "name", "in": "query", "schema": { "type": "string" }, "description": "Filter by contact name" }, { "name": "email", "in": "query", "schema": { "type": "string" }, "description": "Filter by contact email" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Contact" } }, "total": { "type": "integer" } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing or invalid Bearer token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden for this domain", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Domain not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Contacts" ], "summary": "Create contact", "description": "Create a new contact handle. The returned data.handle is what you pass as registrant/admin/billing/tech on register, transfer, or PUT /domains/{domain_name}/contacts.", "operationId": "createContact", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "email", "phone", "city", "zip", "country" ], "properties": { "name": { "type": "string" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "email": { "type": "string", "format": "email" }, "phone": { "type": "string" }, "address": { "description": "String or array of address lines" }, "address_1": { "type": "string" }, "address_2": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "zip": { "type": "string" }, "country": { "type": "string", "example": "US" }, "fax": { "type": "string" }, "organization": { "type": "string" }, "label": { "type": "string" }, "disclosed_fields": { "type": "array", "items": { "type": "string" } } } } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing or invalid Bearer token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden for this domain", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Domain not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/registrar/v1/contacts/{handle}": { "get": { "tags": [ "Contacts" ], "summary": "Get contact", "description": "Retrieve a single contact by handle. Use GET /contacts?email= or ?name= first if you only have a name or email.", "operationId": "getContact", "parameters": [ { "name": "handle", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/Contact" } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing or invalid Bearer token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden for this domain", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Domain not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "Contacts" ], "summary": "Update contact", "description": "Update an existing contact handle owned by this account.", "operationId": "updateContact", "parameters": [ { "name": "handle", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" }, "address": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "zip": { "type": "string" }, "country": { "type": "string" }, "organization": { "type": "string" }, "label": { "type": "string" } } } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing or invalid Bearer token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden for this domain", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Domain not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/registrar/v1/domains/{domain_name}/contacts": { "get": { "tags": [ "Contacts" ], "summary": "Get domain contact handles", "description": "Returns the current registrant, admin, billing, and tech handles for the domain plus full contact records when the handles belong to this account.", "operationId": "getDomainContacts", "parameters": [ { "name": "domain_name", "in": "path", "required": true, "description": "Fully qualified domain name", "schema": { "type": "string", "example": "example.com" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing or invalid Bearer token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden for this domain", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Domain not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "Contacts" ], "summary": "Assign domain contact handles", "description": "Provide at least one of registrant, admin, billing, or tech (existing contact handles from GET /contacts).", "operationId": "updateDomainContacts", "parameters": [ { "name": "domain_name", "in": "path", "required": true, "description": "Fully qualified domain name", "schema": { "type": "string", "example": "example.com" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "registrant": { "type": "string" }, "admin": { "type": "string" }, "billing": { "type": "string" }, "tech": { "type": "string" } } } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing or invalid Bearer token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden for this domain", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Domain not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "bearerAuth": [] } ] } } }, "components": { "securitySchemes": { "apiToken": { "type": "apiKey", "in": "query", "name": "api_token", "description": "Seller / partner / appraisal / trademark API token from https://www.atom.com/dashboard/seller/api-access" }, "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "API Token", "description": "Registrar API token from https://www.atom.com/dashboard/seller/api-access" } }, "schemas": { "DomainApiResponse": { "type": "object", "properties": { "domain_name": { "type": "string" }, "status": { "type": "string" }, "selling_price": { "type": "integer" }, "primary_category": { "type": "integer" }, "discount_price": { "type": "integer" }, "description": { "type": "string" } } }, "GradeDomainUploadResponse": { "type": "object", "properties": { "message": { "type": "string" } } }, "GradeDomainResponse": { "type": "object", "properties": { "count": { "type": "integer" }, "data": { "type": "object", "properties": { "domain_name": { "type": "string" }, "is_brand_fit": { "type": "string" }, "date_submitted": { "type": "string" }, "status": { "type": "string" }, "premium_fit": { "type": "string" } } } } }, "searchResponse": { "type": "object", "properties": { "id": { "type": "integer", "value": 1 }, "domain_name": { "type": "string", "value": "abc.com" }, "status": { "type": "string", "value": "Approved" }, "full_price": { "type": "integer", "value": 1000 }, "selling_price": { "type": "integer", "value": 700 }, "primary_category": { "type": "string", "value": "Activity & Games - Bike Rentals" }, "description": { "type": "string", "value": "abc.com to represent strength and growth" }, "purchase_url": { "type": "string", "value": "https://atom.com/name/abc/rm/12345" }, "image_url": { "type": "string", "value": "https://www.atom.com/story_images/visual_images/abc.jpg" } } }, "HoldDomainResponse": { "type": "object", "properties": { "success": { "type": "boolean", "value": true }, "message": { "type": "string", "value": "Domain successfully added to Onhold" } } }, "ConfirmOrderResponse": { "type": "object", "properties": { "success": { "type": "boolean", "value": true }, "message": { "type": "string", "value": "Domain changed to status purchased" } } }, "SubmitTransferCodeResponse": { "type": "object", "properties": { "success": { "type": "boolean", "value": true }, "message": { "type": "string", "value": "Transfer Code Success" } } }, "SmartDomainSearchResponse": { "type": "object", "properties": { "premium_domains": { "type": "string", "value": "[{'domain_name': 'BookBlood.com', 'availability': '1', 'selling_price': 100, 'image_url': 'https://public.atom.com/story_images/visual_images/1700332012-bookblood 1-01.jpg?class=listing'}]" }, "generated_domains": { "type": "string", "value": "{['Prose Pulse': [{'domain_name': 'ProsePulse.org', 'availability': '0'}, {'domain_name': 'Prose Pulse.io', 'availability': '0'}]]}" } } }, "DomainAppraisalResponse": { "type": "object", "properties": { "domain_name": { "type": "string" }, "atom_appraisal": { "type": "integer" }, "domain_score": { "type": "integer" }, "key_signals": { "type": "array", "items": { "type": "string" }, "description": "Array of domain characteristics and signals" }, "root_words": { "type": "array", "items": { "type": "string" }, "description": "Array of detected root words from the domain" }, "tld_taken_count": { "type": "integer" }, "tm_conflicts": { "type": "integer", "description": "Number of trademark conflicts found for this domain" }, "external_message": { "type": "string", "description": "Additional message, only returned when appraisal is not available" } } }, "NewListingsResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "total_records": { "type": "integer" }, "date": { "type": "string", "format": "date" }, "listing_type_filter": { "type": "string", "enum": [ "Curated", "All" ] }, "data": { "type": "array", "items": { "type": "object", "properties": { "domain_name": { "type": "string" }, "selling_price": { "type": "string", "description": "Price as string, 'Make Offer' if applicable" }, "listing_type": { "type": "string", "enum": [ "Curated", "Standard" ] }, "word1": { "type": "string" }, "word2": { "type": "string" }, "word3": { "type": "string" }, "type_of_name": { "type": "string" } } } } } }, "PartnerOrderListResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "total_records": { "type": "integer" }, "total_pages": { "type": "integer" }, "page": { "type": "integer" }, "limit": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerOrder" } } } }, "PartnerOrderDetailsResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/PartnerOrder" } } }, "PartnerOrder": { "type": "object", "properties": { "order_id": { "type": "integer" }, "order_status": { "type": "string" }, "transfer_status": { "type": "string" }, "transfer_option": { "type": "string" }, "domain_name": { "type": "string" }, "sale_price": { "type": "number" }, "expected_net_payout": { "type": "number" }, "actual_net_payout": { "type": "number" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "domain": { "type": "object" } } }, "ErrorResponse": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string" }, "message": { "type": "string" } } }, "TrademarkSearchResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "keyword": { "type": "string" }, "search_type": { "type": "string" }, "filing_status": { "type": "string" }, "class": { "type": "string" }, "page": { "type": "integer" }, "page_size": { "type": "integer" }, "total_results": { "type": "integer" }, "data": { "type": "array", "items": { "type": "object", "properties": { "trademark_name": { "type": "string" }, "serial_number": { "type": "string" }, "description": { "type": "string" }, "status_category": { "type": "string" }, "status_subcategory": { "type": "string" }, "status_code": { "type": "string" }, "international_classes": { "type": "string" }, "owners": { "type": "string" }, "owners_full_details": { "type": "string" }, "filing_date": { "type": "string" }, "mark_drawing_code": { "type": "string" }, "standard_characters_claimed": { "type": "string" }, "trademark_in": { "type": "string" }, "service_mark_in": { "type": "string" }, "collective_service_mark_in": { "type": "string" }, "collective_membership_mark_in": { "type": "string" }, "certification_mark_in": { "type": "string" }, "intent_to_use_in": { "type": "string" }, "intent_to_use_current_in": { "type": "string" }, "attorney_name": { "type": "string" }, "attorney_correspondence": { "type": "string" }, "attorney_doc_number": { "type": "string" }, "registration_date": { "type": "string" }, "status_date": { "type": "string" }, "case_file_events_statements": { "type": "string" }, "created_at": { "type": "string" }, "logo_path": { "type": "string" } } } }, "usage": { "type": "object", "properties": { "used_today": { "type": "integer" }, "daily_limit": { "type": "integer" }, "cumulative_count": { "type": "integer" }, "user_level": { "type": "string" } } } } }, "DomainPrice": { "type": "object", "description": "What Atom charges to register this specific domain, including premium pricing when applicable. unit_price is per year; total includes VAT.", "properties": { "unit_price": { "type": "number", "description": "Registration price per year in USD (includes ICANN fee in the charged total separately)" }, "renewal_price": { "type": "number", "description": "Renewal price per year in USD" }, "icann_fee": { "type": "number" }, "is_premium": { "type": "boolean", "description": "True when the registry prices this label as premium" }, "registration_length": { "type": "integer", "description": "Years used for this quote" }, "subtotal": { "type": "number" }, "vat_rate": { "type": "number" }, "vat_amount": { "type": "number" }, "total": { "type": "number", "description": "Amount Atom would charge for this registration (subtotal + VAT)" } } }, "RegistrarDomain": { "type": "object", "properties": { "domain_name": { "type": "string", "example": "example.com" }, "status": { "type": "string" }, "extension": { "type": "string", "example": "com" }, "created_date": { "type": "string" }, "updated_date": { "type": "string" }, "expiry_date": { "type": "string" }, "auto_renew": { "type": "boolean" }, "privacy_protect": { "type": "boolean" }, "transfer_locked": { "type": "boolean", "description": "Customer-controlled registrar lock (CLIENT_TRANSFER_PROHIBITED). When true the domain cannot be transferred out until unlocked." }, "icann_transfer_lock": { "type": "boolean", "description": "ICANN-required 60-day transfer restriction after a new registration or inbound transfer. Independent of transfer_locked." }, "icann_transfer_lock_expires_at": { "type": "string", "nullable": true, "description": "When the ICANN 60-day lock expires (YYYY-MM-DD HH:MM:SS). Null when the lock is not active." }, "can_transfer_out": { "type": "boolean", "description": "True only when both the registrar lock and the ICANN 60-day lock are off. Informational: transfer-out itself is performed in the Atom dashboard, not via this API." }, "dnssec_enabled": { "type": "boolean" }, "nameservers": { "type": "array", "items": { "type": "string" } }, "registrant_handle": { "type": "string" }, "admin_handle": { "type": "string", "nullable": true }, "tech_handle": { "type": "string", "nullable": true }, "billing_handle": { "type": "string", "nullable": true } } }, "Contact": { "type": "object", "properties": { "handle": { "type": "string" }, "type": { "type": "string", "enum": [ "registrant_user", "contact_handle" ] }, "label": { "type": "string", "nullable": true }, "name": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" }, "fax": { "type": "string", "nullable": true }, "organization": { "type": "string", "nullable": true }, "address": { "type": "array", "items": { "type": "string" } }, "city": { "type": "string" }, "state": { "type": "string", "nullable": true }, "zip": { "type": "string" }, "country": { "type": "string", "example": "US" }, "disclosed_fields": { "type": "array", "items": { "type": "string" } }, "verified": { "type": "boolean" } } }, "DnsRecord": { "type": "object", "properties": { "id": { "type": "integer" }, "type": { "type": "string", "example": "A" }, "name": { "type": "string" }, "content": { "type": "string" }, "ttl": { "type": "integer", "example": 3600 }, "comment": { "type": "string" } } }, "DnsRecordInput": { "type": "object", "required": [ "type", "content" ], "properties": { "type": { "type": "string", "enum": [ "A", "AAAA", "CNAME", "MX", "TXT", "NS", "SRV", "CAA", "PTR" ] }, "name": { "type": "string", "example": "www" }, "content": { "type": "string", "example": "192.168.1.1" }, "ttl": { "type": "integer", "default": 3600 }, "comment": { "type": "string" }, "priority": { "type": "integer", "description": "MX and SRV" }, "service": { "type": "string", "description": "SRV only" }, "protocol": { "type": "string", "description": "SRV only" }, "weight": { "type": "integer", "description": "SRV only" }, "port": { "type": "integer", "description": "SRV only" }, "target": { "type": "string", "description": "SRV only" }, "flags": { "type": "integer", "description": "CAA only" }, "tag": { "type": "string", "description": "CAA only" }, "value": { "type": "string", "description": "CAA only" } } }, "Pagination": { "type": "object", "properties": { "current_page": { "type": "integer" }, "total_pages": { "type": "integer" }, "per_page": { "type": "integer" }, "total_records": { "type": "integer" } } }, "TldPrice": { "type": "object", "properties": { "register": { "type": "number" }, "renew": { "type": "number" }, "transfer": { "type": "number" }, "icann_fee": { "type": "number" }, "renewal_length": { "type": "integer" } } } } } }