api-ninjas-com Domain API

openapi: 3.2.0
info:
  title: Ninjas Domain API
  description: 'Combined OpenAPI specification for every API Ninjas endpoint. Requests go to https://api.api-ninjas.com with an `X-Api-Key` header; get a free key at https://api-ninjas.com/register. Human-readable docs: https://api-ninjas.com/api. Index for LLMs: https://api-ninjas.com/llms.txt.'
  version: 1.0.0
  contact:
    name: API Ninjas
    url: https://api-ninjas.com
  license:
    name: Proprietary
servers:
- url: https://api.api-ninjas.com
  description: API Ninjas Production
security:
- ApiKeyAuth: []
tags:
- name: Domain
  description: The Domain API checks domain availability and retrieves basic registration information for any given domain. For detailed domain registration information from the WHOIS protocol, check out our Whois API instead.
paths:
  /v1/domain:
    get:
      tags:
      - Domain
      summary: Checks domain availability and retrieves basic registration information
      description: Checks whether a domain is available and returns basic registration information. Requires a `domain`; top-level domains other than .com need a premium subscription.
      operationId: getDomainInfo
      parameters:
      - name: domain
        in: query
        description: Valid domain to check (e.g. example.com). For top-level domains other than .com, a premium subscription is required.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response with domain information.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DomainResponse'
        '400':
          description: Bad Request - Invalid domain format.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DomainOpenapi_ErrorResponse'
        '401':
          description: Unauthorized - API key missing or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DomainOpenapi_ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DomainOpenapi_ErrorResponse'
      security:
      - ApiKeyAuth: []
components:
  schemas:
    DomainResponse:
      type: object
      properties:
        domain:
          type: string
          description: The domain name queried.
        available:
          type: boolean
          description: Indicates if the domain is available for registration.
        creation_date:
          type: integer
          format: int64
          description: The creation date of the domain in UNIX timestamp format.
        expiration_date:
          type: integer
          format: int64
          description: Unix timestamp of when the domain registration expires.
        age_days:
          type: integer
          description: Age of the domain in days, derived from creation_date.
        registrar:
          type: string
          description: The registrar of the domain.
        updated_date:
          type: integer
          format: int64
          description: Unix timestamp of when the domain record was last updated. Premium only.
        domain_status:
          type: array
          items:
            type: string
          description: Array of EPP status codes as snake_case strings (e.g. client_transfer_prohibited, pending_delete, redemption_period), indicating registrar/registry locks and the domain's lifecycle state. Premium only.
        has_mx:
          type: boolean
          description: Whether the domain has any MX (mail exchange) records, i.e. whether it is configured to receive email. Premium only.
        is_free_email_provider:
          type: boolean
          description: Whether the domain is a known free or webmail provider (e.g. gmail.com, outlook.com). Premium only.
        risky_tld:
          type: boolean
          description: Whether the domain's top-level domain is one disproportionately associated with spam or abuse. Premium only.
        is_disposable_email_domain:
          type: boolean
          description: Whether the domain is a known disposable / temporary email provider. Business tier and above.
        is_custom_domain:
          type: boolean
          description: 'Whether the domain looks like a custom/business email domain: it accepts mail and is not a free, webmail, or disposable provider. Business tier and above.'
        mx_provider:
          type: string
          description: The email provider serving the domain (e.g. Google Workspace, Microsoft 365). Business tier and above.
        is_parked:
          type: boolean
          description: Whether the domain is parked or listed for sale. Business tier and above.
        ip:
          type: string
          description: The IPv4 address the domain currently resolves to. Business tier and above.
        hosting_provider:
          type: string
          description: The network / hosting provider the resolved IP belongs to. Business tier and above.
        country:
          type: string
          description: Two-letter country code where the resolved IP is registered. Business tier and above.
    DomainOpenapi_ErrorResponse:
      type: object
      properties:
        message:
          type: string
          description: Error message describing the failure.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-Api-Key
externalDocs:
  description: API Ninjas documentation
  url: https://api-ninjas.com/api