> ## Documentation Index
> Fetch the complete documentation index at: https://docs.vicem.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Domain Information

> Retrieves detailed domain information (nameservers, transfer lock, IRTP status, ID protection, etc.). If the registrar does not support this function, nameservers and lock status are fetched separately.



## OpenAPI

````yaml api-reference/openapi.json get /domains/{domain}/information
openapi: 3.1.0
info:
  title: Domains Reseller API
  description: >-
    Domain name management API for resellers. Manage domains, renewals, billing,
    and other domain-related operations.
  version: 2.4.1
servers:
  - url: https://vicem.com/modules/addons/DomainsReseller/api/index.php
    description: Production server
security: []
paths:
  /domains/{domain}/information:
    get:
      tags:
        - Domains
      summary: Get Domain Information
      description: >-
        Retrieves detailed domain information (nameservers, transfer lock, IRTP
        status, ID protection, etc.). If the registrar does not support this
        function, nameservers and lock status are fetched separately.
      operationId: getDomainInformation
      parameters:
        - $ref: '#/components/parameters/UsernameHeader'
        - $ref: '#/components/parameters/TokenHeader'
        - name: domain
          in: path
          required: true
          description: Domain name (e.g. example.com)
          schema:
            type: string
            example: example.com
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              required:
                - domain
              properties:
                domain:
                  type: string
                  description: Domain name
                  example: example.com
      responses:
        '200':
          description: Success - Returns domain information
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DomainInformation'
        '400':
          description: Parameter validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Authentication error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Domain not found or registrar error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: Domain not found in reseller account
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  parameters:
    UsernameHeader:
      name: username
      in: header
      required: true
      description: Reseller email address registered in WHMCS
      schema:
        type: string
        format: email
        example: reseller@example.com
    TokenHeader:
      name: token
      in: header
      required: true
      description: >-
        HMAC-SHA256 authentication token.


        PHP formula: `base64_encode(hash_hmac('sha256', $apiKey, $email . ':' .
        gmdate('y-m-d H')))`


        **Important**: `hash_hmac` **without** the 3rd parameter `true` (returns
        hex, not binary), then `base64_encode` of the hex result. The token is
        88 characters long.


        An optional `timestamp` header (Unix timestamp, 60-second tolerance) can
        be sent to synchronize time.
      schema:
        type: string
        example: YTk4YjRmNjI...
  schemas:
    DomainInformation:
      type: object
      properties:
        domain:
          type: string
          description: Domain name
        nameservers:
          type: array
          items:
            type: string
          description: List of nameservers
        transferLock:
          type: boolean
          description: Whether transfer lock is active
        expiryDate:
          type: string
          format: date-time
          description: Expiry date
        registrationStatus:
          type: string
          description: Registration status
        restorable:
          type: boolean
          description: Whether the domain can be restored
          nullable: true
        renewBeforeExpiration:
          type: boolean
          description: Whether renewal before expiration is allowed
          nullable: true
        idProtectionStatus:
          type: boolean
          description: Whether ID protection is active
          nullable: true
        dnsManagementStatus:
          type: boolean
          description: Whether DNS management is active
          nullable: true
        emailForwardingStatus:
          type: boolean
          description: Whether email forwarding is active
          nullable: true
        transferLockExpiryDate:
          type: string
          format: date-time
          description: Transfer lock expiry date
          nullable: true
        irtpOptOutStatus:
          type: boolean
          description: IRTP opt-out status
          nullable: true
        irtpTransferLock:
          type: boolean
          description: Whether IRTP transfer lock is active
          nullable: true
        irtpTransferLockExpiryDate:
          type: string
          format: date-time
          description: IRTP transfer lock expiry date
          nullable: true
        domainContactChangePending:
          type: boolean
          description: Whether a contact change is pending
          nullable: true
        domainContactChangeExpiryDate:
          type: string
          format: date-time
          description: Contact change expiry date
          nullable: true
        willDomainSuspend:
          type: boolean
          description: Whether suspension is pending
          nullable: true
        isIrtpEnabled:
          type: boolean
          description: Whether IRTP is enabled
          nullable: true
        irtpVerificationTriggerFields:
          type: array
          items:
            type: string
          description: Fields that trigger IRTP verification
        registrantEmailAddress:
          type: string
          description: Registrant email address
          nullable: true
    Error:
      type: object
      properties:
        error:
          type: string
          description: Error message
      example:
        error: Invalid API Token provided

````