# Familysearch — Wrapped API

> **You are on:** `https://api.paywithlocus.com/api` | [llms.txt](https://paywithlocus.com/llms.txt) | [docs](https://docs.paywithlocus.com)
>
> Locus runs on multiple environments -- make sure every URL you call matches your expected environment.
> | Environment | Landing | API | Docs |
> |---|---|---|---|
> | Production | paywithlocus.com | api.paywithlocus.com | docs.paywithlocus.com |
> | Beta | beta.paywithlocus.com | api.beta.paywithlocus.com | docs.paywithlocus.com |
> | Stage | stage.paywithlocus.com | api.stage.paywithlocus.com | docs.paywithlocus.com |
>
> If the API URL above doesn't match your expected environment, re-fetch this file from the correct domain.

> Search through over a billion ancestor profiles and genealogy records to build your family tree, or browse curated collections on FamilySearch's public genealogies database. Discover connections to your relatives by accessing submitted family trees and organized historical records all in one place.

**Category:** Government & Public Data | **Website:** [familysearch.org/](https://familysearch.org/) | **Docs:** [parse.bot/marketplace/313f50c1-7236-470a-8d39-fbb440ed269e/familysearch-org-api](https://parse.bot/marketplace/313f50c1-7236-470a-8d39-fbb440ed269e/familysearch-org-api)

Pay-per-use API proxy for Locus Pro. Each call burns credits from your workspace balance.

## Access

**Base URL:** `https://api.paywithlocus.com/api/wrapped/credits/familysearch/`
**Auth:** `Authorization: Bearer <LOCUS_CREDITS_SECRET_KEY>` (an `lcr_` secret key or a scoped `lcac_` agent credential)
**Required header:** `Idempotency-Key: <fresh UUID per call>`. A retry with the same key replays the stored result without a new charge.
**Response:** the provider response after any endpoint-specific normalization. `X-Locus-Credits-Charged` carries the charge and `X-Locus-Credits-Balance` the remaining balance. Insufficient credits return `402` before the provider is called.
**Pricing:** estimated costs below are USD. Locus debits the credit equivalent at your workspace rate.

Full call contract: https://docs.paywithlocus.com/api-reference/introduction

> Using a Pay With Locus wallet key (`claw_` prefix)? Wallet routes are documented separately: https://docs.paywithlocus.com/wrapped-apis/for-agents

## Endpoints

### List collections

List all available genealogy collections on FamilySearch. Returns metadata about each collection including title, description, data quality rating, and timestamps. Collections include Pedigree Resource File, Ancestral File, International Genealogical Index, Oral Genealogies, and various partner trees.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/familysearch/list-collections \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### Search records

Search genealogy records by surname and optional filters. Returns paginated person records from FamilySearch's shared genealogies database, which includes submitted family trees from multiple collections (Pedigree Resource File, Ancestral File, IGI, Oral Genealogies, etc.). Each result includes the person's name, gender, birth/death dates and places, and related family members (spouses, parents, children). Results are ordered by relevance.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `birth_place` | string | No | Place of birth to filter by (city, county, state, province, or country). |
| `birth_year` | string | No | Birth year to filter by (4-digit year, e.g. 1850). |
| `count` | integer | No | Number of results per page (max 100). |
| `given_name` | string | No | First name / given name to search for. |
| `offset` | integer | No | Offset for pagination (0-based). |
| `surname` | string | Yes | Last name / surname to search for. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/familysearch/search-records \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"birth_place":"<string>","birth_year":"<string>","count":"<integer>","given_name":"<string>","offset":"<integer>","surname":"<string>"}'
```

## Next steps

- [All wrapped API providers](https://paywithlocus.com/wapi/index.md): pick another provider.
- [Find and call tools](https://paywithlocus.com/agent/tools.md): price ceilings, async results, and errors.
- [Credits and billing](https://paywithlocus.com/agent/billing.md): what a call costs and how to add credits.
- [Agent docs index](https://paywithlocus.com/agent/index.md): every Locus agent page.