Website components

Company name suggestions (free inside a session)

Up to 5 suggestions on the Free plan and 10 on paid plans, best match first. Suggestions are free inside a session (at most 30 a session); the selection that ends the session counts one request. Limited per visitor (120 a minute) and per key.

get/elements/v1/suggest

Request

  • Base URL: https://api.companystack.co.uk
  • URL: https://api.companystack.co.uk/elements/v1/suggest
  • Auth: one of:
    • API key in query parameter key
    • HTTP bearer

Query parameters

qstring required
sessionstring uuid required

A random UUID the component makes when the search box gets focus. Suggestions inside a session are free; the selection that ends it counts one request.

keystring

Your publishable key, from a web page on one of the key's websites. From your own server, send your secret key in Authorization instead (proxy mode).

tokenstring

A short-lived token your server minted with POST /elements/v1/tokens: works only on its website, for its scopes and companies, for at most 15 minutes. Send a key, a token or a secret key, never two.

limitinteger

Response

Suggestions

Changes

No recorded changes to this operation across all 1 revision of this API.