Fuzzy Text Search API - ApyHub

Fuzzy Text Search API

Data Extraction#fuzzy#search
ApyHub
ApyHub
verified icon
25 atoms

About

The Fuzzy Text Search API allows developers to perform flexible, typo-tolerant searches across large text datasets. It identifies keywords even if they're misspelled or include accented characters (diacritics), making it ideal for handling user-input errors. Unlike exact-match searches, the API finds relevant results despite spelling variations, ensuring better user experiences and more accurate data retrieval. Perfect for applications that need robust, fault-tolerant search functionality.
Try the Fuzzy Text Search API now and deliver more accurate, user-friendly search results with minimal setup.

API Playground

API Documentation

fuzzy
POST
https://api.apyhub.com/search/text/fuzzy

Request example

1
curl --location --request POST 'https://api.apyhub.com/search/text/fuzzy' \
2
--header 'Content-Type: application/json' \
3
--header 'apy-token: {{token}}' \
4
--data-raw '{
5
    "source":"taching",
6
    "target":"teaching is the best qualifying compare another profession"
7
}'
Method: POST
Content Type: application/json
Query Parameter(s)
AttributeData TypeDescription
unicode-normalizedbooleanDefaults to false. Set to true, in case accents need to be taken into consideration.
Request Body
AttributeTypeMandatoryDescription
sourceStringNoThe term or phrase you want to search for, which will be compared against the target.
targetStringNoThe target term or text in which the source term will be searched.
Sample Response
Returns an array of terms that match the source. But if source or target is missing or is null or empty string then this returns an empty array.
1
{
2
    "data": [
3
        "teaching"
4
    ]
5
}
Sample with unicode-normalized true
1
curl --location --request POST 'https://api.apyhub.com/search/text/fuzzy?unicode-normalized=true' \
2
--header 'Content-Type: application/json' \
3
--header 'apy-token: {{token}}' \
4
--data-raw '{
5
    "source":"ïñg",
6
    "target":"teaching is the best qualifying compare another profession"
7
}'
1
{
2
    "data": [
3
        "teaching",
4
        "qualifying"
5
    ]
6
}

HTTP Response Codes

The method may return one of the following HTTP status codes:
Status CodeDescription
200The request was successful.
400Invalid input or mandatory params are missing.
401Required authentication information is either missing or not valid for the resource.
500Potential error that might occur, if any unexpected error occurs while processing the request.

Authentication

All API requests to ApyHub services need to be authenticated. Currently we support tokens or basic authentication mechanisms. You can generate and view your existing credentials from your workspace settings (on the left side of the navbar) and go to “API Keys".
Points to note:
  • Credential secrets are generated on the fly and are not stored in plain text, so on generating a credential please save the secrets somewhere safe.
  • Use the apy-token as the header parameter to pass the token.
  • Use the Authorization header to send the basic authentication credentials.

Error codes

1
{
2
  "error": {
3
    "code": 105,
4
    "message": "Invalid URL"
5
  }
6
}
To search for a specific error code, enter the code in the search box below. Alternatively, you can click on the button to view a complete list of all error codes.
Table of contents
AboutAPI PlaygroundAPI DocumentationAuthenticationError codesRelated Utility APIsRelated Articles