{
    "openapi": "3.0.3",
    "info": {
        "description": "Manage domain listings on the Atom marketplace: add, price, categorize, discount, boost, and report on your domains.",
        "version": "1.0.0",
        "title": "Atom Seller 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"
        }
    ],
    "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"
                                }
                            }
                        }
                    }
                }
            }
        }
    },
    "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": []
    }
}