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

# Quickstart

> Get an API key, send your first CompanyEnrich API request, and pick the API you want to use.

Three steps take you from an API key to a working request.

**1. Get your API key**

Create a key at [app.companyenrich.com/access-keys](https://app.companyenrich.com/access-keys), then save it in an environment variable:

```bash theme={null}
export COMPANYENRICH_API_KEY="paste-your-key-here"
```

**2. Send your first request**

This request checks that your key works and shows your credit balance. It is free.

```bash cURL theme={null}
curl https://api.companyenrich.com/v2/me \
  -H "Authorization: Bearer $COMPANYENRICH_API_KEY"
```

```javascript JavaScript theme={null}
// npm install @companyenrich/sdk
import { CompanyEnrich } from '@companyenrich/sdk';

const client = new CompanyEnrich(); // reads COMPANYENRICH_API_KEY
console.log(await client.me());
```

```python Python theme={null}
# pip install companyenrich
from companyenrich import CompanyEnrich

client = CompanyEnrich()  # reads COMPANYENRICH_API_KEY
print(client.me())
```

```ruby Ruby theme={null}
# gem install companyenrich
require "companyenrich"

client = CompanyEnrich::Client.new # reads COMPANYENRICH_API_KEY
p client.me
```

```php PHP theme={null}
<?php
// composer require companyenrich/sdk
require 'vendor/autoload.php';

use CompanyEnrich\Client;

$client = new Client(); // reads COMPANYENRICH_API_KEY
print_r($client->me());
```

```bash CLI theme={null}
# npm install -g @companyenrich/cli
companyenrich me
```

You get back your account's credits and what your plan allows:

```json theme={null}
{
  "userId": "8d1f3c52-7b0e-4c1a-9f6d-2e5a4b3c1d90",
  "credits": { "used": 12, "total": 1000 },
  "capabilities": { "previews": true }
}
```

This example is shortened. A `401` response means the key is missing or wrong.

**3. Pick an API**

Each page below starts with a request you can copy and run.

> [card] [Company Enrichment API](https://docs.companyenrich.com/docs/company-enrichment-api.md)
>
> Turn a domain into a full company profile.

> [card] [Company Search API](https://docs.companyenrich.com/docs/company-search-api.md)
>
> Find companies by country, size, industry, and more.

> [card] [Semantic Company Search API](https://docs.companyenrich.com/docs/semantic-company-search-api.md)
>
> Find companies from a plain-language description.

> [card] [Similar Companies API](https://docs.companyenrich.com/docs/similar-companies-api.md)
>
> Find companies like the ones you already know.

> [card] [People Search API](https://docs.companyenrich.com/docs/people-search-api.md)
>
> Find people by job title, seniority, and employer.

> [card] [Reverse Email Lookup API](https://docs.companyenrich.com/docs/reverse-email-lookup-api.md)
>
> Find the person behind a work email address.

> [card] [Company Headcount API](https://docs.companyenrich.com/docs/company-headcount-api.md)
>
> Get employee counts by department, with history.

> [card] [MCP server](https://docs.companyenrich.com/docs/mcp-server.md)
>
> Connect an AI agent to CompanyEnrich data.

## Good to know

* **Base URL.** Every request goes to `https://api.companyenrich.com`. V2 paths start with `/v2`.
* **Authentication.** Send your key in the `Authorization` header as `Bearer` followed by the key. See [Authentication](https://docs.companyenrich.com/authentication.md).
* **Credits.** Most requests cost credits for the data they return. Counting matches and checking your account are free. See [Credits](https://docs.companyenrich.com/docs/credits.md).
* **Rate limits.** See [Rate limits](https://docs.companyenrich.com/docs/rate-limit.md) before you send requests at scale.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.