Albacross Company API

openapi: 3.2.0
info:
  title: Reveal API docs Company API
  description: 'Reveal API allows you to get detailed information about a company based on one of its IPv4 or IPv6 addresses.


    Information may contain details like: a company name, address, URL, number of employees and many more.

    All of it is presented in a JSON format - a readable, self-explanatory and widely adopted industry standard.


    Our automated algorithms and multiple data sources continuously work on improving the quality of our data

    by making sure that available information is as detailed and as up-to-date as possible.

    At the same time every day, we''re increasing the range of covered addresses out of the existing IP address pool.


    If, however, you are not able to find a company for a given IP or another error occurs (not likely, but possible),

    our API will provide you with a detailed, standardised error message and an appropriate HTTP return status code.'
  version: '1.0'
servers:
- url: https://reveal.api.albacross.com
  description: Production data
- url: https://reveal.api.albakaos.com
  description: Staging data
security:
- ApiKeyAuth: []
tags:
- name: Company
paths:
  /company/{ip}:
    get:
      summary: Retrieve company based on its IPv4 or IPv6 address
      parameters:
      - name: ip
        in: path
        description: Company IPv4 (e.g. 23.45.67.89) or IPv6 (e.g. 2001:db8::1) address
        required: true
        schema:
          type: string
      responses:
        200:
          description: Company details
          content:
            application/json:
              schema:
                $ref: swagger-ui/common_components.yml#/components/schemas/Company
        204:
          description: Company not found for given IP
        400:
          description: Wrong IP format
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessageWrongFormat'
        401:
          description: Invalid API Key
          content:
            application/json:
              schema:
                $ref: swagger-ui/common_components.yml#/components/schemas/ErrorMessage
        429:
          description: '''Requests quota''/''Identfied quota'' has been exceeded - please contact Albacross'
          content:
            application/json:
              schema:
                $ref: swagger-ui/common_components.yml#/components/schemas/ErrorMessage
        500:
          description: Unknown error has appeared - please contact Albacross
          content:
            application/json:
              schema:
                $ref: swagger-ui/common_components.yml#/components/schemas/ErrorMessage
      tags:
      - Company
      operationId: getCompanyByIp
      x-operation-id-source: derived
components:
  schemas:
    ErrorMessageWrongFormat:
      description: 'Wrong IP format - provide an IPv4 or IPv6 address. Ex: 23.45.67.89 or 2001:db8::1'
      type: object
      properties:
        message:
          type: string
      required:
      - message
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
externalDocs:
  url: /public/postman_collection.json
  description: Download preconfigured Postman collection
x-provenance:
  method: harvested
  publisher: Albacross
  source: https://reveal.api.albacross.com/public/albacross_reveal_api.yml
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)