API Reference

The Viesearch API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

Just getting started?

Use the Resources navigation to select a specific API route to view its documentation.

General Information

You can use the Viesearch API to seamlessly integrate our sub-10ms search index and human-curated directory directly into your application. All requests must be authenticated, unless otherwise specified.

The Viesearch API doesn't support bulk updates. You can work on only one object per request.

https://viesearch.com/api

Authentication

The API key that you use to authenticate requests determines your access level. You can find or generate your unique API key in your Account Settings. Pass the key in the x-api-key HTTP header with every request.

For endpoints that support pagination, the results per page (limit) are fixed to match the standard Viesearch platform views to ensure consistency across all interfaces. Users can navigate through results using the p parameter.