Quickstart — REST API

Make your first company search call and get a real response in under 60 seconds.

Prerequisites

1. A CompanyLens account — sign up free, no credit card required.
2. An API key from your dashboard.
3. curl installed (comes with macOS and most Linux distros).

Step 1: Get your API key

Your key starts with cl_live_. Keep it private — never commit it to source control or expose it in client-side code.

Step 2: Make your first call

Search for companies named "Revolut" in the UK registry:

curl -G https://api.companylens.io/v1/companies/search \
  -H "X-Api-Key: YOUR_API_KEY" \
  --data-urlencode "q=Revolut" \
  --data-urlencode "jurisdiction=gb" \
  --data-urlencode "status=active"

const res = await fetch(
  'https://api.companylens.io/v1/companies/search?' +
  new URLSearchParams({ q: 'Revolut', jurisdiction: 'uk', status: 'active' }),
  { headers: { 'X-Api-Key': 'YOUR_API_KEY' } }
);
const data = await res.json();

import httpx

r = httpx.get(
    'https://api.companylens.io/v1/companies/search',
    params={'q': 'Revolut', 'jurisdiction': 'uk', 'status': 'active'},
    headers={'X-Api-Key': 'YOUR_API_KEY'},
)
data = r.json()

Step 3: Download the Postman collection

The collection has every endpoint pre-configured with your API key variable, real example values, and inline parameter descriptions — the fastest way to explore the full API.

1. Open Postman and select Import, then choose the downloaded file.
2. Set the api_key collection variable to your cl_live_ key.
3. Hit Send on any request — every call is ready to run.

Next steps