---
title: "Name"
method: GET
path: "/api/name/{name}"
tags: ["Term"]
---

# Name

`GET /api/name/{name}`

Serves primarily as an autocompleter, returning potential keyword matches for `Ref`s, book titles, authors, topics, and collections available on Sefaria.

## Query parameters

- `limit` integer
- `type` 'ref' | 'Collection' | 'Topic' | 'TocCategory' | 'Term' | 'User'

## Response `200`

Successful response

- NameAPIResponse — Full response of the Name API
  - `lang` 'en' | 'he' — The language of the completion results.
  - `type` 'ref' | 'Topic' | 'AuthorTopic' | 'PersonTopic' | 'User'
  - `completions` string[] — A list of autocompletion responses for the submitted text.
  - `completion_objects` object[] — A list of autocompletion response objects for the submitted text along with some information about them.
    - `title` string
    - `key` string
    - `type` string
    - `is_primary` boolean
    - `order` integer
  - `is_book` boolean — Returns `true` if the submitted text is a book level reference. e.g. (Genesis)
  - `is_node` boolean — Returns true if the submitted text is a `node` in a complex text. (For example, the query `Abarbanel on Torah, Genesis` is a `node` in the `index` of the complex text `Abarbanel on Torah`).
  - `is_section` boolean — Returns `true` if the submitted text is a section `Ref` (e.g. Genesis 4, as opposed to a segment `Ref` such as Genesis 4.1).
  - `is_segment` boolean — Returns `true` if the submitted text is a segment level `Ref` (e.g. Genesis 43:3, as opposed to a section `Ref` such as Genesis 43)
  - `is_range` boolean — Returns `true` if the submitted text is a a ranged `Ref` (one that spans multiple sections or segments.) e.g. `Genesis 4-5`
  - `ref` string — If `type=ref`, this returns the canonical ref for the submitted text.
  - `url` string — If `type=ref`, this returns the URL path to link to the submitted text on [Sefaria.org](sefaria.org)
  - `index` string — If `type=ref`, this returns the canonical name of the `index` of the submitted text.
  - `book` string — If the submitted response is a `Ref`, this returns the book it belongs to.
  - `internalSections` integer[]
  - `internalToSections` integer[]
  - `sections` string[]
  - `toSections` string[]
  - `examples` unknown[]
    - unknown
  - `sectionNames` string[] — Given a reference, this returns the names of the sections and segments at each depth of that text.
  - `heSectionNames` string[] — Given a `Ref`, this returns the names of the sections and segments at each depth of that text in Hebrew.
  - `addressExamples` string[] — Given a partial `Ref`, this will return an array of strings of possible ways that it might be completed.
  - `heAddressExamples` string[] — Given a partial `Ref`, this will return an array of Hebrew strings of possible ways that it might be completed.

---

[API](https://skmtc.net/sefaria/apis/sefaria-api.md) · [All operations](https://skmtc.net/sefaria/apis/sefaria-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/sefaria/sefaria-api/revisions/d29296717011/schema)