Skip to main content

Search

GET /v1/search

Search the catalog by query string.

AspectDetail
HeaderX-API-Key
Queryq - search string, minimum length 2
Querylimit - integer 1–50, default 20

Response:

  • matches - array of ServiceResponse objects
  • query - normalized query echo
  • total - number of matches returned in this response

Error: If q is shorter than 2 characters, the API returns 422 with query_too_short.

curl "https://api.scrift.app/v1/search?q=github&limit=10" \
-H "X-API-Key: YOUR_API_KEY"

See interactive API reference for schemas and try-it-out.