Skip to content

Latest commit

 

History

History
34 lines (22 loc) · 1.09 KB

index.md

File metadata and controls

34 lines (22 loc) · 1.09 KB
title category pageTitle description
Official API Documentation
HypeProxy.io v3.0
CacheAdvance - Never miss the cache again.
Cache every single thing your app could ever do ahead of time, so your code never even has to run at all.

Understand the basics of the Official HypeProxy.io API. {% .lead %}

Introduction

We're proud to announce the release of our new API v3 – that brings many changes, better stability and security, the V1 API is still working if you need.

Our API follows the REST specifications and use JWT authentication.

curl https://api.hypeproxy.io/v3

Authentication

Our API respects the JWT authentication standards by using the Authorization field in HTTP headers but for convenience, the API key can also be passed through cookies and query parameter ?apikey=.

{% see-also title="API Authentication" href="/docs/authentication" /%}

Health check

We provide a health-check endpoint if you want to know the status of the API.

curl https://api.hypeproxy.io/health

You can also visit our service status page.