# Minerva Documentation

- [Introduction](https://docs.minerva.io/api-reference/introduction.md): Minerva API documentation
- [Data Dictionary](https://docs.minerva.io/api-reference/data-dictionary.md): Complete reference of all fields returned by the Minerva Enrich v2 API
- [Resolve v2](https://docs.minerva.io/api-reference/resolve-v2.md): Enhanced resolve with reverse lookup capabilities and match condition filters
- [Resolve v1](https://docs.minerva.io/api-reference/resolve.md): <Warning>**Do not use Resolve v1.** This endpoint is deprecated and remains available only for backward compatibility. Use [Resolve v2](/api-reference/resolve-v2) for all identity-resolution workflows. Migrate existing v1 integrations to v2 as soon as possible.</Warning>
- [Enrich Input Rules](https://docs.minerva.io/api-reference/enrich-inputs.md): Valid identifiers and record shapes for Enrich v2
- [Enrich v2](https://docs.minerva.io/api-reference/enrich-v2.md): Enhanced enrichment with direct lookups, flexible matching, and selective field returns
- [Enrich v1](https://docs.minerva.io/api-reference/enrich.md): <Warning>**Do not use Enrich v1.** This endpoint is deprecated and remains available only for backward compatibility. Use [Enrich v2](/api-reference/enrich-v2) for all enrichment workflows. Migrate existing v1 integrations to v2 as soon as possible.</Warning>
- [Get LinkedIn Contact Info](https://docs.minerva.io/api-reference/get-li-contact-info.md): Retrieve contact information for LinkedIn profiles
- [Validate Emails](https://docs.minerva.io/api-reference/validate-emails.md): Validate email addresses and check their presence in the Minerva database
- [Infer Record Country](https://docs.minerva.io/api-reference/infer-record-country.md): Infer country location from email addresses and phone numbers
- [Person Search](https://docs.minerva.io/api-reference/person-search.md): Find people using a natural-language audience description and return matching Minerva PIDs with contact-channel coverage stats
- [Get Person Search](https://docs.minerva.io/api-reference/person-search-get.md): Retrieve a previously created person search by id, returning the same payload as the original search
- [Async Person Search](https://docs.minerva.io/api-reference/person-search-async.md): Submit a search, poll for completion, page matching PIDs, and enrich the records you need
- [Async Person Search](https://docs.minerva.io/api-reference/person-search-job-submit.md): Submit a natural-language person search for preview or full asynchronous materialization
- [Async Person Search Status](https://docs.minerva.io/api-reference/person-search-job-status.md): Poll search progress, audience size, and statistics
- [Async Person Search Results](https://docs.minerva.io/api-reference/person-search-job-results.md): Page the matching PIDs from a completed full person search
- [Person Search Usage](https://docs.minerva.io/api-reference/person-search-usage.md): Retrieve your organization's daily person-search delivery limits, current-day consumption, and recent per-day history
- [Contact Append](https://docs.minerva.io/api-reference/person-search-contact-append.md): Queue an asynchronous ABM contact-append job that finds current employees at target companies matching desired job titles
- [Contact Prospect](https://docs.minerva.io/api-reference/person-search-contact-prospect.md): Queue an asynchronous contact-prospect job that finds people in NAICS industries matching desired job titles
- [Contact Job Status](https://docs.minerva.io/api-reference/person-search-contact-job.md): Poll the status of an asynchronous contact-append or contact-prospect job
- [Contact Job Results](https://docs.minerva.io/api-reference/person-search-contact-job-results.md): Retrieve matched contacts using record capacity once per unique record per contract term
- [Endpoint Usage](https://docs.minerva.io/api-reference/usage-endpoints.md): Retrieve org-wide API usage metrics for the endpoints available to your organization
- [Billing Usage](https://docs.minerva.io/api-reference/billing-usage.md): Check remaining record allowance, overage spend and current record export capacity
- [Storage — Boto Credentials](https://docs.minerva.io/api-reference/storage-boto.md): Mint short-lived AWS credentials scoped to your org's storage area for use with boto3 / the AWS SDKs.
- [Segments - Create](https://docs.minerva.io/api-reference/segments-create.md): Create a named segment to organize and track cohorts of people for analysis and signal monitoring
- [Segments - Members](https://docs.minerva.io/api-reference/segments-members.md): Retrieve all members of a segment with pagination support
- [Segments - Add Members](https://docs.minerva.io/api-reference/segments-members-add.md): Add one or more people to an existing segment using their Minerva PIDs
- [Segments - Remove Members](https://docs.minerva.io/api-reference/segments-members-remove.md): Remove one or more people from an existing segment using their Minerva PIDs
- [Segments - Death Signals](https://docs.minerva.io/api-reference/segments-signals-deaths.md): Retrieve death records and obituary information for segment members who have deceased
- [Minerva Data MCP](https://docs.minerva.io/minerva-data-mcp.md): Connect Codex, Claude, and other MCP clients to Minerva
- [Available tools](https://docs.minerva.io/mcp/tools.md): Explore Minerva Data MCP tools and endpoint availability
- [FAQ](https://docs.minerva.io/mcp/faq.md): Billing and organization access for Minerva Data MCP
- [Troubleshooting](https://docs.minerva.io/mcp/troubleshooting.md): Resolve common Minerva Data MCP connection and usage problems
- [Minerva Python SDK](https://docs.minerva.io/sdk/introduction.md): One client for the Minerva Data API. Typed end-to-end. Input validation before any call hits the network.
- [Installation](https://docs.minerva.io/sdk/installation.md): pip install minerva-sdk — plus opt-in extras for pandas DataFrames and pretty terminal tables.
- [Quickstart](https://docs.minerva.io/sdk/quickstart.md): Install, set your API key, run your first enrichment.
- [Authentication](https://docs.minerva.io/sdk/authentication.md): One credential — your API key. Goes on every request as `x-api-key`.
- [Resolve](https://docs.minerva.io/sdk/guides/resolve.md): Match your records to a unique Minerva PID. Lighter and cheaper than enrich when all you need is identity.
- [Enrich](https://docs.minerva.io/sdk/guides/enrich.md): Full person profiles — identity, contact, professional, financial, household, relatives — from a record stub.
- [Person Search](https://docs.minerva.io/sdk/guides/person-search.md): Find people from a natural-language audience description. Returns matching Minerva PIDs plus contact-channel coverage stats.
- [LinkedIn contact info](https://docs.minerva.io/sdk/guides/linkedin.md): Look up ranked contact info for LinkedIn usernames.
- [Email validation](https://docs.minerva.io/sdk/guides/validate-emails.md): Verify email addresses against the Minerva database.
- [Country inference](https://docs.minerva.io/sdk/guides/infer-country.md): Infer each record's country from its contact info (phone country code, email TLD, address signals, etc.).
- [Usage tallies](https://docs.minerva.io/sdk/guides/usage.md): Your per-endpoint API usage — how many calls, when, against your key.
- [Async + bulk batching](https://docs.minerva.io/sdk/guides/async-and-batching.md): Use `AsyncMinerva` for concurrent calls under one client, with `enrich_many` / `resolve_many` for arbitrarily-large record lists.
- [Streaming batcher](https://docs.minerva.io/sdk/guides/streaming-batcher.md): Feed records one at a time. `Batcher` (sync) and `AsyncBatcher` (async) buffer until the size cap is hit, then auto-fire any callable — enrich, resolve, or your own.
- [Workflows — `mc.workflows.*`](https://docs.minerva.io/sdk/guides/workflows.md): Encoded best-practice multi-call recipes. Start with `resolve_then_enrich` — the faster path for going from names/emails to full profiles.
- [Rate limiting (built in)](https://docs.minerva.io/sdk/guides/rate-limiting.md): The SDK self-throttles to your plan's rate so you can fan out concurrent calls without writing your own throttler — and never see a 429 you didn't ask for.
- [Custom & tailored endpoints](https://docs.minerva.io/sdk/guides/custom-endpoints.md): Escape hatch for client-specific endpoints — preview routes, partner integrations, anything not yet wrapped in a typed SDK method.
- [Validation & dry_run](https://docs.minerva.io/sdk/guides/validation-dry-run.md): Validate input locally before any network round-trip — same checks the server runs, available offline.
- [Output formats](https://docs.minerva.io/sdk/guides/output-formats.md): Every list-shaped result → dicts, DataFrame, CSV, or a pretty terminal table.
- [Spreadsheets — Google Sheets & Excel](https://docs.minerva.io/sdk/guides/spreadsheets.md): Run resolve / enrich directly off a Google Sheet or .xlsx workbook, and write results back the same way.
- [Storage — bulk upload & download](https://docs.minerva.io/sdk/guides/storage.md): Move files in and out of your private storage area without writing boto3 by hand. Gated on the [storage] extra.
- [Error handling](https://docs.minerva.io/sdk/guides/error-handling.md): One exception hierarchy. Specific subclasses where you'd actually want to branch on the failure.
- [Liveness](https://docs.minerva.io/sdk/guides/health.md): Probe Minerva API endpoints via `mc.status.health()`. Auto-upgrades to an authenticated metrics view when the client has an API key. Never raises — safe to call in a polling loop.
- [CLI reference](https://docs.minerva.io/sdk/reference/cli.md): python -m minerva — a help screen + cheat-sheet for users who installed the SDK and aren't sure where to start.
- [Exception reference](https://docs.minerva.io/sdk/reference/errors.md): Every exception the SDK raises, what triggers it, and what context it carries.
- [Minerva SFTP](https://docs.minerva.io/sftp/introduction.md): Connect to Minerva, find the right folder, and upload your files with Cyberduck, FileZilla, or a terminal.


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