{ "openapi": "3.0.3", "info": { "description": "Atom public APIs for marketplace listings, partner search, domain appraisal, trademark search, and smart name generation. Get an API key at https://www.atom.com/dashboard/seller/api-access", "version": "1.0.0", "title": "Atom API", "contact": { "email": "service@atom.com" }, "termsOfService": "https://www.atom.com/terms" }, "servers": [ { "url": "https://www.atom.com/api/marketplace", "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" } ], "externalDocs": { "description": "Atom API docs", "url": "https://www.atom.com/api-docs" }, "paths": { "/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" } } } } } } }, "/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" } } } } } } }, "/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" } } } } } } }, "/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" } } } } } } }, "/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" } } } } } } }, "/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" } } } } } } }, "/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" } } } } } } }, "/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" } } } } } } }, "/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" } } } } } } }, "/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" } } } } } } }, "/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" } } } } } } }, "/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" } } } } } } }, "/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" } } } } } } }, "/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" } } } } } } }, "/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" } } } } } } }, "/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" } } } } } } }, "/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" } } } } } } }, "/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" } } } } } } }, "/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" } } } } } } }, "/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" } } } } } } }, "/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" } } } } } } }, "/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" } } } } } } }, "/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" } } } } } } }, "/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" } } } } } } }, "/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" } } } } } } }, "/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" } } } } } } }, "/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" } } } } } } }, "/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" } } } } } } }, "/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" } } } } } } }, "/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" } } } } } } } } }, "/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" } } } } } } }, "/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 } } } } } } } } }, "/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 } } } } } } } } } }, "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" } }, "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": { "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" } } } } } } } }