SVRF API Docs and Issues
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
examples Fix bug with previous images (#31) Jan 18, 2019
.gitignore Ignore files (#10) Nov 26, 2018
README.md Update API Rate Limits Nov 30, 2018

README.md

Getting Started

The SVRF API allows you to supercharge your project or app with the first and largest search engine for immersive experiences. We make it simple for any developer to incorporate highly immersive experiences with all kinds of applications: virtual reality, augmented reality, mixed reality, mobile, and web.

The SVRF API is based on REST principles, allowing it to integrate cross-platform. Our endpoints return responses in JSON. We support CORS, allowing you to access immersive experiences indexed by SVRF on your own web domains. We provide a variety of resolutions, projections, and file formats to support most modern clients.

SVRF API Documentation is available at https://developers.svrf.com.

Access and API Keys

To generate a SVRF API Key, create an account on www.svrf.com and go to the Apps section of the User Settings page.

See our terms of service for restrictions on using the SVRF API, libraries, and SDKs.

If you have questions or need support, please create a ticket.

API Highlights

Search Endpoint

The SVRF Search Endpoint brings the power of immersive search found on SVRF.com to your app or project. Our 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 relevant search results are returned first.

Trending Endpoint

The SVRF Trending Endpoint provides your app or project with the hottest immersive content - curated by real humans. The experiences returned mirror the SVRF homepage, from timely cultural content to trending pop-culture references. The trending experiences are updated regularly to ensure users always get fresh updates of immersive content.

API Libraries

You can use SVRF API libraries to encapsulate endpoint requests:

SDKs

You can use the SVRF SDKs to encapsulate endpoint requests and render 3D face filters in your application.

Attribution

Authors and Site Credit

At SVRF, we believe in giving credit where credit is due. Do your best to provide attribution to the authors and site where the content originated. We suggest using the format: by {authors} via {site}

If possible, please provide a way for users to discover and visit the page the content originally came from (url).

Powered By SVRF

As per section 5 A of the terms of service, we require all apps that use the SVRF API to conspicuously display "Powered By SVRF" attribution marks where the API is utilized.

Rate Limits

The SVRF API has a generous rate limit to ensure the best experience for your users. We rate limit by IP address with a maximum of 100 requests per 10 seconds. If you exceed the rate limit, requests from the requesting IP address will be blocked for 60 seconds.