hide
Prologue
Getting started
Overview
Introduction
The ghostealth-API is REST-ing. So the API was developed around REST and has reliable, resource-oriented URLs and uses HTTP response- and individual response-codes to report about errors. Furthermore the API supports cross-origin resource sharing and allows you in this way to interact securely with each endpoint from a client-side web application. Each request will return a JSON-formatted response.
How to getting started quickly?
To use the given proxy-endpoints you have to go through three small steps: sign up; subscribe to a plan; create an API-Key; make a request.
Definitions
By requesting our proxy-endpoints you will get different responses. Some of the responses include special characters or misleading words. In this case, the definitions will help to understand.
Response- and errorcodes
Every request ends in a response. Some positive, other negative. To understand the returning response-code we will give you an short overview.
How to get an API-Key?
An API-Key is important to authenticate and identify every request you make. The mentioned guide below explains in detail how you can get an API-Key for using our proxy-endpoints.
Optionals
Most endpoints can be modified by optionals. The mentioned guide below will explain all details about optionals.
Rate-Limit
The usage of our proxy-endpoints is free. But of course, there are some limitations in calling the endpoints. The mentioned guide below will explain it more in detail.
Overview of endpoints
- Name
- Explanation
- Get all continents
- Returns all continents. Important for filtering.
- Get all countries
- Returns all countries. Important for filtering.
- Get all subscriptions
- Returns all of your subscriptions. For them you are able to fetch proxies.
- Get proxies
- Returns the proxies related to a given ID of subscription.
Examples
hide
No example available
We are using cookies
We use cookies to improve your experience and for marketing. Learn more in our cookie policy.