Skip to main content
GET
cURL

Authorizations

x-api-key
string
header
required

Your key id, VFN_TEST_… or VFN_LIVE_…. Sent on every request.

x-secret-key
string
header
required

Your secret, VFN_SK_…. Not a real header, and never sent to the API. It is only a form field for Try it, which uses it to sign your request in your browser. In your own code you sign each request with the secret and send x-api-key, x-timestamp and x-signature (see Authentication).

Query Parameters

q
string
required

2 to 60 characters; matches the start of words, tolerates small typos

Required string length: 2 - 60
collar
enum<string>

Ranks this collar first; does not hide the others

Available options:
blue,
grey,
white
domain_id
string
Pattern: ^[a-z0-9_]{3,200}$
sub_domain_id
string
Pattern: ^[a-z0-9_]{3,200}$
limit
integer
default:10

1 to 20, default 10

Required range: 1 <= x <= 20

Response

Matching skills

success
boolean
message
string
data
object