Login

Fetch API Health

Check the health status of our API and its various services.
GET
https://api.thecompaniesapi.com/v2
Free

Customers use this feature to check if the API is working properly.

Signup to access all our API features

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

No credit card required

Response schema
healthyboolean

Overall health status of the API.

nodeNamestring

Name of the node responding to the request.

reportobject

Detailed health report for each service.

Code examples
Select your favorite language:
Go

JavaScript

PHP

Python

import createClient from '@thecompaniesapi/sdk'

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

const response = await tca.fetchApiHealth()

const health = response.data // The health of the API

Fetch your team information

Retrieve the team associated with your API token.

Fetch OpenAPI specification

Retrieve our OpenAPI specification to explore our API's endpoints, parameters, and responses.