API Documentation — Information

GET

Get packages list Info Package -/package/list

This method requires authorization!

You can use your own API key, which can be obtained at control panel.

This method - requires permissions - packages.read

When creating an API token in your control panel, you can choose certain permissions (for example: prevent the token from placing orders).
You can also find a list of permissions in our documentation.

Query method

GEThttp://apilocal.stableproxy.com/v2/package/list

Query parameters

Identifier	Regulations	Example
with-deletedNot necessarily	nullableex-boolean	false
searchNot necessarily	nullablestring	241
per-pageNot necessarily	nullableinteger	82
pageNot necessarily	nullableinteger	33
sort-byNot necessarily	nullablestringapp\_validators\_ex_in_rule	""
sort-orderNot necessarily	nullablestringin:asc, desc	"asc"

Code examples

JavaScript

async function getPackageList() {
   const baseUrl = 'http://apilocal.stableproxy.com/v2';
   const req = await fetch(baseUrl + '/package/list?' + Object.entries({
         "with-deleted": false,
         "search": 241,
         "per-page": 82,
         "page": 33,
         "sort-by": "",
         "sort-order": "asc"
      }).map(([key, value]) => key + "=" + value).join('&'), {
         method: 'GET',
         headers: {
            'Authorization': 'API-Token [YOUR TOKEN]',
            'Content-Type': 'application/json'
         }
      }
   );
   
   const res = await req.json();
}

Examples of answers

Success response

DELETE

Cancel non activate package Info Package -/package/cancel/{id}

This method requires authorization!

You can use your own API key, which can be obtained at control panel.

This method - requires permissions - packages.update

When creating an API token in your control panel, you can choose certain permissions (for example: prevent the token from placing orders).
You can also find a list of permissions in our documentation.

Query method

DELETEhttp://apilocal.stableproxy.com/v2/package/cancel/{id}

Query parameters

Identifier	Regulations	Example
id	1required	33

Code examples

JavaScript

async function deletePackageCancel() {
   const baseUrl = 'http://apilocal.stableproxy.com/v2';
   const req = await fetch(baseUrl + '/package/cancel/{id}'
      .replace("{id}", 33), {
         method: 'DELETE',
         headers: {
            'Authorization': 'API-Token [YOUR TOKEN]',
            'Content-Type': 'application/json'
         }
      }
   );
   
   const res = await req.json();
}

Examples of answers

Success response

GET

Get package information Same as list but fetch only one. -/package/view/{id}

This method requires authorization!

You can use your own API key, which can be obtained at control panel.

This method - requires permissions - packages-orders.update

When creating an API token in your control panel, you can choose certain permissions (for example: prevent the token from placing orders).
You can also find a list of permissions in our documentation.

Query method

GEThttp://apilocal.stableproxy.com/v2/package/view/{id}

Query parameters

Identifier	Regulations	Example
id	1required	3

Code examples

JavaScript

async function getPackageView() {
   const baseUrl = 'http://apilocal.stableproxy.com/v2';
   const req = await fetch(baseUrl + '/package/view/{id}'
      .replace("{id}", 3), {
         method: 'GET',
         headers: {
            'Authorization': 'API-Token [YOUR TOKEN]',
            'Content-Type': 'application/json'
         }
      }
   );
   
   const res = await req.json();
}

Examples of answers

Success response

GET

Statistics -/package/statistics/{id}

This method requires authorization!

You can use your own API key, which can be obtained at control panel.

This method - requires permissions - packages-statistics.read

When creating an API token in your control panel, you can choose certain permissions (for example: prevent the token from placing orders).
You can also find a list of permissions in our documentation.

Query method

GEThttp://apilocal.stableproxy.com/v2/package/statistics/{id}

Code examples

JavaScript

async function getPackageStatistics() {
   const baseUrl = 'http://apilocal.stableproxy.com/v2';
   const req = await fetch(baseUrl + '/package/statistics/{id}'
      .replace("{id}", ""), {
         method: 'GET',
         headers: {
            'Authorization': 'API-Token [YOUR TOKEN]',
            'Content-Type': 'application/json'
         }
      }
   );
   
   const res = await req.json();
}