# Nzsl — 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 and explore over 5000 New Zealand Sign Language signs with English and Māori translations, video demonstrations, and example sentences. Access detailed sign information, alphabet and number references, classifier pages, and get a sign of the day to expand your NZSL vocabulary.

**Category:** Education | **Website:** [nzsl.nz/](https://nzsl.nz/) | **Docs:** [parse.bot/marketplace/2cef0dd3-212e-4356-8484-758f07b0743b/nzsl-nz-api](https://parse.bot/marketplace/2cef0dd3-212e-4356-8484-758f07b0743b/nzsl-nz-api)

Pay-per-use API proxy. Each call is automatically billed to your wallet in USDC.

## Access

**Base URL:** `https://api.paywithlocus.com/api/wrapped/parse-nzsl-nz-api-2cef0dd3/`
**Auth:** `Authorization: Bearer <LOCUS_API_KEY>`

## Endpoints

### get_all_signs

Retrieve all signs paginated in alphabetical order. Equivalent to an empty search with no filters applied. Returns ~25 signs per page.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `page` | integer | No | Page number for pagination. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-nzsl-nz-api-2cef0dd3/get_all_signs \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"page":"<integer>"}'
```

### get_alphabet_page

Retrieve the NZSL fingerspelling alphabet reference page content, including letter images and demonstration videos. Contains 29 alphabet items (some letters have open/closed variants) and multiple demonstration video URLs.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-nzsl-nz-api-2cef0dd3/get_alphabet_page \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### get_classifiers_page

Retrieve the NZSL classifiers reference page content, organized by classifier type categories. Each category contains items with a label and image_url showing the classifier handshape.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-nzsl-nz-api-2cef0dd3/get_classifiers_page \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### get_numbers_page

Retrieve the NZSL numbers reference page content, organized by category (Cardinal Numbers, Ordinal Numbers, Age). Each category contains items with a label, sign_id, and image_url.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-nzsl-nz-api-2cef0dd3/get_numbers_page \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### get_search_autocomplete

Get autocomplete suggestions for a search term. Returns a list of matching sign glosses as strings. Works best with complete words or common terms.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `term` | string | Yes | Search term for autocomplete suggestions (e.g. 'cat', 'water', 'house'). |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-nzsl-nz-api-2cef0dd3/get_search_autocomplete \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"term":"<string>"}'
```

### get_sign_detail

Retrieve full detail for a specific sign by its numeric ID, including videos, drawings, examples, handshapes, and locations. The sign_id is obtained from search_signs or get_all_signs results.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `sign_id` | string | Yes | Numeric sign ID (e.g. '1301', '5243'). Obtained from search_signs results. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-nzsl-nz-api-2cef0dd3/get_sign_detail \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"sign_id":"<string>"}'
```

### get_sign_of_the_day

Retrieve the Sign of the Day featured on the homepage. Changes daily. Returns the sign name, ID, video URL, and drawing URL.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-nzsl-nz-api-2cef0dd3/get_sign_of_the_day \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### list_topics

Get the full list of topic categories available for filtering signs. Returns all 45 topic tags. The tag values can be passed directly to the search_signs topic parameter.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-nzsl-nz-api-2cef0dd3/list_topics \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### search_signs

Search for signs by keyword (English or Māori) with optional filters. Returns paginated results. When no query or filters are provided, returns all signs ordered alphabetically. Supports filtering by topic, handshape, body location, location group, and usage. Each page returns up to ~25 results.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `handshape` | string | No | Handshape ID filter (e.g. '1.1.1'). |
| `location` | string | No | Body location ID filter. |
| `location_group` | string | No | Location group ID filter. |
| `page` | integer | No | Page number for pagination. |
| `query` | string | No | Search keyword in English or Māori (e.g. 'hello', 'water'). |
| `topic` | string | No | Topic category filter. Use the tag value from list_topics (e.g. 'Animals', 'Actions and activities'). |
| `usage` | string | No | Usage filter (e.g. 'archaic', 'informal'). |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-nzsl-nz-api-2cef0dd3/search_signs \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"handshape":"<string>","location":"<string>","location_group":"<string>","page":"<integer>","query":"<string>","topic":"<string>","usage":"<string>"}'
```