Search Endpoint – /vr/search

The Svrf Search Endpoint brings the power of immersive search found on Svrf.com to your app or project. Svrf's search engine enables your users to instantly find the immersive experience they're seeking. Content is sorted by the Svrf rating system, ensuring that the highest quality content and most prevalent search results are returned.

Query Parameters

Parameter	Type	Description
q	`string`	Url-encoded search query.
size	`integer`	The number of results to return per-page, from 1 to 100 (default: 10).
pageNum	`integer`	Pagination control to fetch the next page of results, if applicable.
isFaceFilter	`boolean`	Search only for face filters.
hasBlendShapes	`boolean`	Search only for Media that has blend shapes.
requiresBlendShapes	`boolean`	Search only for Media that requires blend shapes.

Response

Successful Response

Successfully fetched the Media.

Key	Type	Description
success	`boolean`	If the request was successful.
pageNum	`integer`	The current page number.
nextPageNum	`integer`	The next page to query to see more results, whether or not the next page actually exists.
tookMs	`integer`	The number of milliseconds the request took.
totalNum	`integer`	The number of total results for query.
media	`[object]`	The search results in an array of Media. See Media schema.

Error Response

Key	Type	Description
success	`boolean`	If the request was successful.
message	`string`	Error message.

Examples

cURL
curl --request GET \
  --url 'https://api.svrf.com/v1/vr/search?q=YOUR-SEARCH-QUERY&size=10&isFaceFilter=true' \
  --header 'accept: application/json' \
  --header 'x-app-token: YOUR-APP-TOKEN'

Node.js
var request = require("request");
var options = {
  method: 'GET',
  url: 'https://api.svrf.com/v1/vr/search',
  qs: {q: 'YOUR-SEARCH-QUERY', size: '10', isFaceFilter: 'true'},
  headers: {accept: 'application/json', 'x-app-token': 'YOUR-APP-TOKEN'}
};
request(options, function (error, response, body) {
  if (error) throw new Error(error);
  console.log(body);
});

Svrf API Docs