Ranked Text Search — fuzzy word matching

Ranked Text Search API

Hosted on ApyHub

What it does

Ranked Text Search gives you fuzzy matching over a list of space-separated words. Send a search term in source and the candidate text in target, and it returns ranked matches with their Levenshtein distance from the source.

Use limit to cap how many results come back and offset to skip ranked entries. If you need broader matching, you can also enable accent-insensitive or unicode-normalized handling in the query.

Ranked Text Search is useful when you need to compare a user query against tokenized text, such as searching short labels, finding near-matches in product titles, or normalizing typos in autocomplete and lookup flows. The response is a data array of objects, each with a match string and its numeric distance.

It is a small, focused utility for ordered fuzzy lookup when you want a ranked list rather than a simple yes-or-no match.

curl -X POST "http://localhost:8080/apyhub/ranked-text-search" \ -H "apy-token: $APY_TOKEN" \ -H "Content-Type: application/json" \ -d '{"source":"ing","target":"finding things bring sing ring"}'

About this endpoint

What it does

Performs a ranked fuzzy search by comparing a source string against a space-separated target string and returns the best matches. The request controls how many ranked results to return, how many to skip, and whether comparisons should ignore accents or use Unicode normalization.

Query Parameter(s)

Attribute	Type	Mandatory	Description
accent-insensitive	Boolean	No	Default: `false`
unicode-normalized	Boolean	No	Default: `false`

Request Body

Parameter	Type	Mandatory	Description
limit	Integer	No	Maximum number of results to return. Minimum: `0`. Default: `0`, where `0` means all results.
offset	Integer	No	Number of ranked results to skip. Minimum: `0`. Default: `0`.
source	String	Yes	The search term.
target	String	Yes	Space-separated words to search within.

Response

Returns a JSON object with a data array field. Each item in data is an object with a match string field and a distance integer field, where distance is the Levenshtein distance from the source.

Parameter	Type	Mandatory	Description
data	Object Array	Yes	Array of ranked matches. Each item contains:<br>`match`: the matched string.<br>`distance`: Levenshtein distance from the source.

Query parameters

Name

Type

Description

accent-insensitiveOPTIONAL

boolean

—

DEFAULT false

unicode-normalizedOPTIONAL

boolean

—

DEFAULT false

Body

Name

Type

Description

bodyREQUIRED

object

—

Ranked Text Search API

What it does

Quickstart

What you'll get back

About this endpoint

What it does

Query Parameter(s)

Request Body

Response

Query parameters

Body

Errors any endpoint can return