Fetch OpenAPI specification - The Companies API

The OpenAPI Specification is a standard, language-agnostic format for describing RESTful APIs, enabling both humans and machines to understand how to interact with a service.

Signup to access all our API features

Get your 500 free credits and start enriching and searching companies.

No credit card required

Response schema

componentsobject

Reusable components used across the API specification.

externalDocsobject

Additional external documentation.

infoobject

Metadata about the API.

openapistring

The version of the OpenAPI specification.

pathsobject

The available paths and operations for the API.

serversarray

An array of server objects, which provide connectivity information to a target server.

webhooksobject

Incoming webhooks that may be received as part of this API.

Code examples

Select your favorite language:

JavaScript

PHP

Python

import createClient from '@thecompaniesapi/sdk'

const tca = createClient({ apiToken: 'YOUR_API_TOKEN' })

const response = await tca.fetchOpenApi()

const openapi = response.data // The OpenAPI specification