---
title: "Search Letterboxd"
method: GET
path: "/letterboxd/search"
tags: ["Letterboxd"]
---

# Search Letterboxd

`GET /letterboxd/search`

## Request

- Base URL: `https://api.crawlora.net/api/v1`
- URL: `https://api.crawlora.net/api/v1/letterboxd/search`
- Auth: API key in header `x-api-key`

Searches Letterboxd for films, people, lists and tags by `q`, required. `type` can be set to `film` to return films only; `limit` defaults to 10 with a max of 50. Fields vary by result type: films carry `slug` and `year`, people carry `slug` and `role`, lists carry `owner`, and tags carry only a title and URL.

## Query parameters

- `q` string, required
- `type` 'film'
- `limit` integer

## Headers

- `x-api-key` string, required

## Response `200`

OK

- LetterboxdSearchResponseDoc
  - `code` integer
  - `data` LetterboxdSearchResponse
    - `query` string: Search text that was run.
    - `results` LetterboxdSearchResult[]: Search hits, one item per film, person, list or tag.
      - `owner` string: Username of the member who made the list. Present for list hits.
      - `role` string: Role of the person, `actor` or `director`. Present for person hits.
      - `slug` string: Letterboxd slug of the film or person. Present for film and person hits.
      - `title` string: Title of the film or list, name of the person, or the tag.
      - `type` string: Kind of hit: `film`, `person`, `list` or `tag`.
      - `uri` string: Link to the hit's page on Letterboxd.
      - `year` integer: Year the film was released. Present for film hits.
    - `source_url` string: URL the data was read from.
    - `type` string: Result type the search was limited to, `film`. Omitted for a mixed search.
  - `msg` string

## Other responses

- `400`: Bad Request
- `500`: Internal Server Error
- `503`: Service Unavailable

---

[API](https://skmtc.dev/crawlora/apis/crawlora-api.md) · [All operations](https://skmtc.dev/crawlora/apis/crawlora-api/llms.txt) · [OpenAPI document](https://skmtc.dev/crawlora/apis/crawlora-api/revisions/afac9b012a27?raw)
