NAV
shell python php

User

Balance request

Request example

curl "https://5sim.net/v1/user/profile" \
  -H "Authorization: Bearer $token" \
  -H "Accept: application/json"
import requests

token = 'Your token'

headers = {
    'Authorization': 'Bearer ' + token,
    'Accept': 'application/json',
}

response = requests.get('https://5sim.net/v1/user/profile', headers=headers)
<?php

$token = 'Your token';
$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, 'https://5sim.net/v1/user/profile');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');


$headers = array();
$headers[] = 'Authorization: Bearer ' . $token;
$headers[] = 'Accept: application/json';
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$result = curl_exec($ch);
if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
}
curl_close($ch);

Response example

{
  "id":1,
  "email":"[email protected]",
  "vendor":"demo",
  "default_forwarding_number":"78009005040",
  "balance":100,
  "rating":96,
  "default_country": {
    "name":"russia","iso":"ru","prefix":"+7"
  },
  "default_operator": {
    "name":""
  },
  "frozen_balance":0
}

GET - https://5sim.net/v1/user/profile

Provides profile data: email, balance and rating.

Headers

Response

Name Type Desc
id number User id
email string User email
balance number Balance
rating number Rating
default_country array Default country
default_country.name string Country name
default_country.iso string ISO country code
default_country.prefix string Mobile prefix
default_operator array Default operator
default_operator.name string Operator name
frozen_balance number Frozen balance
default_forwarding_number string Forwarding number
vendor string Vendor name

Orders history

Request example

curl "https://5sim.net/v1/user/orders?category=hosting&limit=15&offset=0&order=id&reverse=true" \
  -H "Authorization: Bearer $token" \
  -H "Accept: application/json"
import requests

token = 'Your token'
category = 'hosting'
limit = 15
offset = 0
order = 'id'
reverse = True

headers = {
    'Authorization': 'Bearer ' + token,
    'Accept': 'application/json',
}

params = (
    ('category', category),
    ('limit', limit),
    ('offset', offset),
    ('order', order),
    ('reverse', reverse),
)

response = requests.get('https://5sim.net/v1/user/orders', headers=headers, params=params)
<?php

$token = 'Your token';
$ch = curl_init();
$category = 'hosting';
$limit = 15;
$offset = 0;
$order = 'id';
$reverse = true;

curl_setopt($ch, CURLOPT_URL, 'https://5sim.net/v1/user/orders?category=' . $category . '&limit=' . $limit . '&offset=' . $offset . '&order=' . $order . '&reverse=' . $reverse);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');


$headers = array();
$headers[] = 'Authorization: Bearer ' . $token;
$headers[] = 'Accept: application/json';
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$result = curl_exec($ch);
if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
}
curl_close($ch);

Response example

{
  "Data": [
    {
      "id":53533933,
      "phone":"+79085895281",
      "operator":"tele2",
      "product":"aliexpress",
      "price":2,
      "status":"BANNED",
      "expires":"2020-06-28T16:32:43.307041Z",
      "sms":[],
      "created_at":"2020-06-28T16:17:43.307041Z",
      "country":"russia"
    }
  ],
  "ProductNames":[],
  "Statuses":[],
  "Total":3
}

GET - https://5sim.net/v1/user/orders?category=$category

Provides orders history by choosen category.

Headers

Request Parameters

Name Type Required Desc
category query string Yes Category can be 'hosting' or 'activation'
limit query string No Pagination limit
offset query string No Pagination offset
order query string No Pagination order, should be field name
reverse query string No Is reversed history, true / false

Response

Name Type Desc
Data array Orders list
ProductNames array Products list
Statuses array Statuses list
Total number Orders count

Payments history

Request example

curl "https://5sim.net/v1/user/payments?limit=15&offset=0&order=id&reverse=true" \
  -H "Authorization: Bearer $token" \
  -H "Accept: application/json"
import requests

token = 'Your token'
limit = 15
offset = 0
order = 'id'
reverse = True

headers = {
    'Authorization': 'Bearer ' + token,
    'Accept': 'application/json',
}

params = (
    ('limit', limit),
    ('offset', offset),
    ('order', order),
    ('reverse', reverse),
)

response = requests.get('https://5sim.net/v1/user/payments', headers=headers, params=params)
<?php

$token = 'Your token';
$ch = curl_init();
$limit = 15;
$offset = 0;
$order = 'id';
$reverse = true;

curl_setopt($ch, CURLOPT_URL, 'https://5sim.net/v1/user/payments?limit=' . $limit . '&offset=' . $offset . '&order=' . $order . '&reverse=' . $reverse);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');


$headers = array();
$headers[] = 'Authorization: Bearer ' . $token;
$headers[] = 'Accept: application/json';
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$result = curl_exec($ch);
if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
}
curl_close($ch);

Response example

{
  "Data": [
    {
      "ID":30011934,
      "TypeName":"charge",
      "ProviderName":"admin",
      "Amount":100,
      "Balance":100,
      "CreatedAt":"2020-06-24T15:37:08.149895Z"
    }
  ],
  "PaymentTypes": [{"Name":"charge"}],
  "PaymentProviders":[{"Name":"admin"}],
  "Total":1
}

GET - https://5sim.net/v1/user/payments

Provides payments history.

Headers

Request Parameters

Name Type Required Desc
limit query string No Pagination limit
offset query string No Pagination offset
order query string No Pagination order, should be field name
reverse query string No Is reversed history, true / false

Response

Name Type Desc
Data array Payments list
PaymentProviders array Names of payments systems
PaymentTypes array Payments types
Total number Payments count

Products and prices

Products request

Request example

curl "https://5sim.net/v1/guest/products/$country/$operator" \
  -H "Accept: application/json"
import requests

country = 'russia'
operator = 'any'

headers = {
    'Accept': 'application/json',
}

response = requests.get('https://5sim.net/v1/guest/products/' + country + '/' + operator, headers=headers)
<?php

$ch = curl_init();
$country = 'russia';
$operator= 'any';

curl_setopt($ch, CURLOPT_URL, 'https://5sim.net/v1/guest/products/' . $country . '/' . $operator);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');


$headers = array();
$headers[] = 'Accept: application/json';
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$result = curl_exec($ch);
if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
}
curl_close($ch);

Response example

{
  "1day":{"Category":"hosting","Qty":14,"Price":80},
  "vkontakte":{"Category":"activation","Qty":133,"Price":21}
}

GET - https://5sim.net/v1/guest/products/$country/$operator

To receive the name, the price, quantity of all products, available to buy.

Headers

Request Parameters

Name Type Required Desc
country query string Yes The country, "any" - any country
operator query string Yes The operator, "any" - any operator

Response

Name Type Desc
Category string activation/hosting
Qty number Available quantity
Price number Price

Prices request

Request example

curl "https://5sim.net/v1/guest/prices" \
  -H "Accept: application/json"
import requests

headers = {
    'Accept': 'application/json',
}

response = requests.get('https://5sim.net/v1/guest/prices', headers=headers)
<?php

$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, 'https://5sim.net/v1/guest/prices');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');


$headers = array();
$headers[] = 'Accept: application/json';
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$result = curl_exec($ch);
if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
}
curl_close($ch);

Response example

{
  "russia":{
    "1688":{
      "beeline":{
        "cost":4,
        "count":1260
      },
      "lycamobile":{
        "cost":4,
        "count":935
      },
      "matrix":{
        "cost":4,
        "count":0
      }
    }
  }
}

GET - https://5sim.net/v1/guest/prices

Returns product prices

Headers

Response

Prices by country

Request example

curl "https://5sim.net/v1/guest/prices?country=$country" \
  -H "Accept: application/json"
import requests

country = 'russia'

headers = {
    'Accept': 'application/json',
}

params = (
    ('country', country),
)

response = requests.get('https://5sim.net/v1/guest/prices', headers=headers, params=params)
<?php

$ch = curl_init();
$country = 'russia';

curl_setopt($ch, CURLOPT_URL, 'https://5sim.net/v1/guest/prices?country=' . $country);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');


$headers = array();
$headers[] = 'Accept: application/json';
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$result = curl_exec($ch);
if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
}
curl_close($ch);

Response example

{
  "russia":{
    "1688":{
      "beeline":{
        "cost":4,
        "count":1260
      },
      "lycamobile":{
        "cost":4,
        "count":935
      },
      "matrix":{
        "cost":4,
        "count":0
      }
    }
  }
}

GET - https://5sim.net/v1/guest/prices?country=$country

Returns product prices by country

Headers

Request Parameters

Name Type Required Desc
country query string Yes Country name

Response

Prices by product

Request example

curl "https://5sim.net/v1/guest/prices?product=$product" \
  -H "Accept: application/json"
import requests

product = 'telegram'

headers = {
    'Accept': 'application/json',
}

params = (
    ('product', product),
)

response = requests.get('https://5sim.net/v1/guest/prices', headers=headers, params=params)
<?php

$ch = curl_init();
$product = 'telegram';

curl_setopt($ch, CURLOPT_URL, 'https://5sim.net/v1/guest/prices?product=' . $product);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');

$headers = array();
$headers[] = 'Accept: application/json';
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$result = curl_exec($ch);
if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
}
curl_close($ch);

Response example

{
  "telegram":{
    "afghanistan":{
      "virtual18":{
        "cost":4,
        "count":1260
      },
      "virtual23":{
        "cost":4,
        "count":935
      },
      "virtual4":{
        "cost":4,
        "count":0
      }
    }
  }
}

GET - https://5sim.net/v1/guest/prices?product=$product

Returns product prices for a specific product

Headers

Request Parameters

Name Type Required Desc
product query string Yes Product Name

Response

Prices by country and product

Response example

{
  "russia":{
    "telegram":{
      "beeline":{
        "cost":8,
        "count":0
      },
      "matrix":{
        "cost":8,
        "count":0
      },
      "megafon":{
        "cost":8,
        "count":0
      },
      "mts":{
        "cost":8,
        "count":0
      },
      "rostelecom":{
        "cost":8,
        "count":0
      },
      "tele2":{
        "cost":8,
        "count":0
      },
      "virtual15":{
        "cost":8,
        "count":0
      },
      "yota":{
        "cost":8,
        "count":0
      }
    }
  }
}

GET - https://5sim.net/v1/guest/prices?country=$country&product=$product

Returns product prices by country and specific product

Headers

Request Parameters

Name Type Required Desc
country query string Yes Country name
product query string Yes Product Name

Response

Purchase

Buy activation number

Request example

curl "https://5sim.net/v1/user/buy/activation/$country/$operator/$product" \
  -H "Authorization: Bearer $token" \
  -H "Accept: application/json"
import requests

token = 'Your token'
country = 'russia'
operator = 'any'
product = 'amazon'

headers = {
    'Authorization': 'Bearer ' + token,
    'Accept': 'application/json',
}

response = requests.get('https://5sim.net/v1/user/buy/activation/' + country + '/' + operator + '/' + product, headers=headers)
<?php

$token = 'Your token';
$ch = curl_init();
$country = 'russia';
$operator = 'any';
$product = 'amazon';

curl_setopt($ch, CURLOPT_URL, 'https://5sim.net/v1/user/buy/activation/' . country . '/' . operator . '/' . product);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');


$headers = array();
$headers[] = 'Authorization: Bearer ' . $token;
$headers[] = 'Accept: application/json';
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$result = curl_exec($ch);
if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
}
curl_close($ch);

Response example

{
  "id":11631253,
  "phone":"+79000381454",
  "operator":"beeline",
  "product":"vkontakte",
  "price":21,
  "status":"PENDING",
  "expires":"2018-10-13T08:28:38.809469028Z",
  "sms":null,
  "created_at":"2018-10-13T08:13:38.809469028Z",
  "forwarding":false,
  "forwarding_number":"",
  "country":"russia"
}

GET - https://5sim.net/v1/user/buy/activation/$country/$operator/$product

GET - https://5sim.net/v1/user/buy/activation/$country/$operator/$product?forwarding=$forwarding&number=$number&reuse=$reuse&voice=$voice&ref=$ref

Headers

URL Parameters

Name Type Required Desc
country query string Yes The country, "any" - any country
operator query string Yes The operator, "any" - any operator
product query string Yes Product name

Query Parameters

Name Type Required Desc
forwarding query string No Whether or not to enable forwarding
number query string No Number for which the call will be forwarded, only the Russian numbers, 11 digits, without the + sign
reuse query string No If equal to "1" buy with the ability to reuse the number, if available
voice query string No If equal to "1" buy with the ability to receive a call from the robot, if available
ref query string No Your referral key if you have it, if you are developer of the software, you can read terms here

Response

Name Type Desc
id number Order id
phone string Phone number
operator string Operator's name
product string Product name
price number Price
status string Order's status
expires date string When the order expires
sms sms array SMS list
created_at date string When the order was created
forwarding boolean Whether or not to enable forwarding
forwarding_number string Call forwarding number
country string Name of country of number

Request limits

Buy hosting number

Request example

curl "https://5sim.net/v1/user/buy/hosting/$country/$operator/$product" \
  -H "Authorization: Bearer $token" \
  -H "Accept: application/json"
import requests

token = 'Your token'
country = 'russia'
operator = 'any'
product = 'amazon'

headers = {
    'Authorization': 'Bearer ' + token,
    'Accept': 'application/json',
}

response = requests.get('https://5sim.net/v1/user/buy/hosting/' + country + '/' + operator + '/' + product, headers=headers)
<?php

$token = 'Your token';
$ch = curl_init();
$country = 'russia';
$operator = 'any';
$product = 'amazon';

curl_setopt($ch, CURLOPT_URL, 'https://5sim.net/v1/user/buy/hosting/' . country . '/' . operator . '/' . product);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');


$headers = array();
$headers[] = 'Authorization: Bearer ' . $token;
$headers[] = 'Accept: application/json';
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$result = curl_exec($ch);
if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
}
curl_close($ch);

Response example

{
  "id": 1,
  "phone": "+79008001122",
  "product": "1day",
  "price": 1,
  "status": "PENDING",
  "expires": "1970-12-01T03:00:00.000000Z",
  "sms": [
      {
        "id":3027531,
        "created_at":"1970-12-01T17:23:25.106597Z",
        "date":"1970-12-01T17:23:15Z",
        "sender":"Facebook",
        "text":"Use 415127 as your login code",
        "code":"415127"
      }
    ],
  "created_at": "1970-12-01T00:00:00.000000Z"
}

GET - https://5sim.net/v1/user/buy/hosting/$country/$operator/$product

Headers

Request Parameters

Name Type Required Desc
country query string Yes The country, "any" - any country
operator query string Yes The operator, "any" - any operator
product query string Yes Product name, {3hours, 1day}

Response

Name Type Desc
id number Order ID
phone string Phone number
product string Product
price number Price
status string Status
expires date string Expire date
sms sms array SMS list
created_at date string When the order was created

Re-buy number

Request example

curl "https://5sim.net/v1/user/reuse/$product/$number" \
  -H "Authorization: Bearer $token" \
  -H "Accept: application/json"
import requests

token = 'Your token'
product = 'amazon'
number = '79006665544'

headers = {
    'Authorization': 'Bearer ' + token,
    'Accept': 'application/json',
}

response = requests.get('https://5sim.net/v1/user/reuse/' + product + '/' + number, headers=headers)
<?php

$token = 'Your token';
$ch = curl_init();
$product = 'amazon';
$number = '79006665544';

curl_setopt($ch, CURLOPT_URL, 'https://5sim.net/v1/user/reuse/' . product . '/' . number);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');


$headers = array();
$headers[] = 'Authorization: Bearer ' . $token;
$headers[] = 'Accept: application/json';
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$result = curl_exec($ch);
if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
}
curl_close($ch);

GET - https://5sim.net/v1/user/reuse/$product/$number

Headers

Request Parameters

Name Type Required Desc
product query string Yes Product name
number query string Yes Phone number, 4-15 digits (without the + sign)

Response

Order management

Check order (Get SMS)

Request example

curl "https://5sim.net/v1/user/check/$id" \
  -H "Authorization: Bearer $token" \
  -H "Accept: application/json"
import requests

token = 'Your token'
id = 1

headers = {
    'Authorization': 'Bearer ' + token,
    'Accept': 'application/json',
}

response = requests.get('https://5sim.net/v1/user/check/' + id, headers=headers)
<?php

$token = 'Your token';
$ch = curl_init();
$id = 1;

curl_setopt($ch, CURLOPT_URL, 'https://5sim.net/v1/user/check/' . $id);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');


$headers = array();
$headers[] = 'Authorization: Bearer ' . $token;
$headers[] = 'Accept: application/json';
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$result = curl_exec($ch);
if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
}
curl_close($ch);

Response example

{
  "id": 11631253,
  "created_at": "2018-10-13T08:13:38.809469028Z",
  "phone": "+79000381454",
  "product": "vkontakte",
  "price": 21,
  "status": "RECEIVED",
  "expires": "2018-10-13T08:28:38.809469028Z",
  "sms": [
      {
        "id":3027531,
        "created_at":"2018-10-13T08:20:38.809469028Z",
        "date":"2018-10-13T08:19:38Z",
        "sender":"VKcom",
        "text":"VK: 09363 - use this code to reclaim your suspended profile.",
        "code":"09363"
      }
  ],
  "forwarding": false,
  "forwarding_number": "",
  "country":"russia"
}

GET - https://5sim.net/v1/user/check/$id

Headers

Request Parameters

Name Type Required Desc
id query string Yes Order id

Response

Name Type Desc
id number Order ID
created_at date string When the order was created
phone string Phone number
product string Product
price number Price
status string Status
expires date string Expire date
sms sms array SMS list
forwarding boolean Whether or not to enable forwarding
forwarding_number string Call forwarding number
country string Name of country of number

Finish order

Request example

curl "https://5sim.net/v1/user/finish/$id" \
  -H "Authorization: Bearer $token" \
  -H "Accept: application/json"
import requests

token = 'Your token'
id = 1

headers = {
    'Authorization': 'Bearer ' + token,
    'Accept': 'application/json',
}

response = requests.get('https://5sim.net/v1/user/finish/' + id, headers=headers)
<?php

$token = 'Your token';
$ch = curl_init();
$id = 1;

curl_setopt($ch, CURLOPT_URL, 'https://5sim.net/v1/user/finish/' . $id);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');


$headers = array();
$headers[] = 'Authorization: Bearer ' . $token;
$headers[] = 'Accept: application/json';
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$result = curl_exec($ch);
if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
}
curl_close($ch);

Response example

{
  "id": 11631253,
  "created_at": "2018-10-13T08:13:38.809469028Z",
  "phone": "+79000381454",
  "product": "vkontakte",
  "price": 21,
  "status": "FINISHED",
  "expires": "2018-10-13T08:28:38.809469028Z",
  "sms": [
      {
        "id":3027531,
        "created_at":"2018-10-13T08:20:38.809469028Z",
        "date":"2018-10-13T08:19:38Z",
        "sender":"VKcom",
        "text":"VK: 09363 - use this code to reclaim your suspended profile.",
        "code":"09363"
      }
  ],
  "forwarding": false,
  "forwarding_number": "",
  "country":"russia"
}

GET - https://5sim.net/v1/user/finish/$id

Headers

Request Parameters

Name Type Required Desc
id query string Yes Order id

Response

Name Type Desc
id number Order ID
created_at date string When the order was created
phone string Phone number
product string Product
price number Price
status string Status
expires date string Expire date
sms sms array SMS list
forwarding boolean Whether or not to enable forwarding
forwarding_number string Call forwarding number
country string Name of country of number

Cancel order

Request example

curl "https://5sim.net/v1/user/cancel/$id" \
  -H "Authorization: Bearer $token" \
  -H "Accept: application/json"
import requests

token = 'Your token'
id = 1

headers = {
    'Authorization': 'Bearer ' + token,
    'Accept': 'application/json',
}

response = requests.get('https://5sim.net/v1/user/cancel/' + id, headers=headers)
<?php

$token = 'Your token';
$ch = curl_init();
$id = 1;

curl_setopt($ch, CURLOPT_URL, 'https://5sim.net/v1/user/cancel/' . $id);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');


$headers = array();
$headers[] = 'Authorization: Bearer ' . $token;
$headers[] = 'Accept: application/json';
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$result = curl_exec($ch);
if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
}
curl_close($ch);

Response example

{
  "id": 11631253,
  "created_at": "2018-10-13T08:13:38.809469028Z",
  "phone": "+79000381454",
  "product": "vkontakte",
  "price": 21,
  "status": "CANCELED",
  "expires": "2018-10-13T08:28:38.809469028Z",
  "sms": [
      {
        "id":3027531,
        "created_at":"2018-10-13T08:20:38.809469028Z",
        "date":"2018-10-13T08:19:38Z",
        "sender":"VKcom",
        "text":"VK: 09363 - use this code to reclaim your suspended profile.",
        "code":"09363"
      }
  ],
  "forwarding": false,
  "forwarding_number": "",
  "country":"russia"
}

GET - https://5sim.net/v1/user/cancel/$id

Headers

Request Parameters

Name Type Required Desc
id query string Yes Order id

Response

Name Type Desc
id number Order ID
created_at date string When the order was created
phone string Phone number
product string Product
price number Price
status string Status
expires date string Expire date
sms sms array SMS list
forwarding boolean Whether or not to enable forwarding
forwarding_number string Call forwarding number
country string Name of country of number

Ban order

Request example

curl "https://5sim.net/v1/user/ban/$id" \
  -H "Authorization: Bearer $token" \
  -H "Accept: application/json"
import requests
token = 'Your token'
id = 1

headers = {
    'Authorization': 'Bearer ' + token,
    'Accept': 'application/json',
}

response = requests.get('https://5sim.net/v1/user/ban/' + id, headers=headers)
<?php

$token = 'Your token';
$ch = curl_init();
$id = 1;

curl_setopt($ch, CURLOPT_URL, 'https://5sim.net/v1/user/ban/' . $id);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');


$headers = array();
$headers[] = 'Authorization: Bearer ' . $token;
$headers[] = 'Accept: application/json';
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$result = curl_exec($ch);
if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
}
curl_close($ch);

Response example

{
  "id": 11631253,
  "created_at": "2018-10-13T08:13:38.809469028Z",
  "phone": "+79000381454",
  "product": "vkontakte",
  "price": 21,
  "status": "BANNED",
  "expires": "2018-10-13T08:28:38.809469028Z",
  "sms": [
      {
        "id":3027531,
        "created_at":"2018-10-13T08:20:38.809469028Z",
        "date":"2018-10-13T08:19:38Z",
        "sender":"VKcom",
        "text":"VK: 09363 - use this code to reclaim your suspended profile.",
        "code":"09363"
      }
  ],
  "forwarding": false,
  "forwarding_number": "",
  "country":"russia"
}

GET - https://5sim.net/v1/user/ban/$id

Headers

Request Parameters

Name Type Required Desc
id query string Yes Order id

Response

Name Type Desc
id number Order ID
created_at date string When the order was created
phone string Phone number
product string Product
price number Price
status string Status
expires date string Expire date
sms sms array SMS list
forwarding boolean Whether or not to enable forwarding
forwarding_number string Call forwarding number
country string Name of country of number

SMS inbox list

Request example

curl "https://5sim.net/v1/user/sms/inbox/$id" \
  -H "Authorization: Bearer $token" \
  -H "Accept: application/json"
import requests

token = 'Your token'
_id = 1

headers = {
    'Authorization': 'Bearer ' + token,
    'Accept': 'application/json',
}

response = requests.get('https://5sim.net/v1/user/sms/inbox/' + _id, headers=headers)
<?php

$token = 'Your token';
$ch = curl_init();
$id = 1;

curl_setopt($ch, CURLOPT_URL, 'https://5sim.net/v1/user/sms/inbox/' . $id);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');


$headers = array();
$headers[] = 'Authorization: Bearer ' . $token;
$headers[] = 'Accept: application/json';
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$result = curl_exec($ch);
if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
}
curl_close($ch);

Response example

{
  "Data": [
    {
      "ID":844928,
      "created_at":"2017-09-05T15:48:33.763297Z",
      "date":"2017-09-05T15:48:27Z",
      "sender":"+79998887060",
      "text":"12345",
      "code":"",
      "is_wave":false,
      "wave_uuid":""
    }
  ],
  "Total":1
}

GET - https://5sim.net/v1/user/sms/inbox/$id

Get SMS inbox list by order's id.

Headers

Request Parameters

Name Type Required Desc
id query string Yes Order id

Response

Name Type Desc
Data array SMS list
Total number SMS count

Crypto

BTC and LTC rates

Request example

curl "https://5sim.net/v1/user/payment/crypto/rates?currency=$currency" \
  -H "Authorization: Bearer $token" \
  -H "Accept: application/json"
import requests

token = 'Your token'
currency = 'RUB'

headers = {
    'Authorization': 'Bearer ' + token,
    'Accept': 'application/json',
}

params = (
    ('currency', currency),
)

response = requests.get('https://5sim.net/v1/user/payment/crypto/rates', headers=headers, params=params)
<?php

$token = 'Your token';
$ch = curl_init();
$currency = 'RUB';

curl_setopt($ch, CURLOPT_URL, 'https://5sim.net/v1/user/payment/crypto/rates?currency=' . $currency);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');


$headers = array();
$headers[] = 'Authorization: Bearer ' . $token;
$headers[] = 'Accept: application/json';
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$result = curl_exec($ch);
if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
}
curl_close($ch);

Response example

{
  "BTC":"639279.58",
  "LTC":"2905.33"
}

GET - https://5sim.net/v1/user/payment/crypto/rates?currency=$currency

Return rates of crypto by pointed currency.

Headers

Request Parameters

Name Type Required Desc
currency query string Yes returns the value of the crypto in RUB

Response

Name Type Desc
BTC string BTC rate in RUB
LTC string LTC rate in RUB

Address payment

Request example

curl "https://5sim.net/v1/user/payment/crypto/getaddress?currency=$currency" \
  -H "Authorization: Bearer $token" \
  -H "Accept: application/json"
import requests

token = 'Your token'
currency = 'BTC'

headers = {
    'Authorization': 'Bearer ' + token,
    'Accept': 'application/json',
}

params = (
    ('currency', currency),
)

response = requests.get('https://5sim.net/v1/user/payment/crypto/getaddress', headers=headers, params=params)
<?php

$token = 'Your token';
$ch = curl_init();
$currency = 'BTC';

curl_setopt($ch, CURLOPT_URL, 'https://5sim.net/v1/user/payment/crypto/getaddress?currency=' . $currency);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');


$headers = array();
$headers[] = 'Authorization: Bearer ' . $token;
$headers[] = 'Accept: application/json';
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$result = curl_exec($ch);
if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
}
curl_close($ch);

Response example

{
  "address": "32QaB2W5XuzJqFPG9QRpgeMfUrUggXTTEm"
}

GET - https://5sim.net/v1/user/payment/crypto/getaddress?currency=$currency

Return address to crypto payment.

Headers

Request Parameters

Name Type Required Desc
currency query string Yes Crypto currency, BTC or LTC

Ответ

Name Type Desc
address string Address to payment

Notifications

Get notifications

Request example

curl "https://5sim.net/v1/guest/flash/$lang" \
  -H "Authorization: Bearer $token" \
  -H "Accept: application/json"
import requests

token = 'Your token'
lang = 'en'

headers = {
    'Authorization': 'Bearer ' + token,
    'Accept': 'application/json',
}

response = requests.get('https://5sim.net/v1/guest/flash/' + lang, headers=headers)
<?php

$token = 'Your token';
$ch = curl_init();
$lang = 'en';

curl_setopt($ch, CURLOPT_URL, 'https://5sim.net/v1/guest/flash/' . lang);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');


$headers = array();
$headers[] = 'Authorization: Bearer ' . $token;
$headers[] = 'Accept: application/json';
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$result = curl_exec($ch);
if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
}
curl_close($ch);

Response example

{
  "text":"...notification text..."
}

GET - https://5sim.net/v1/guest/flash/$lang

Headers

Request Parameters

Name Type Required Desc
lang query string Yes Language of notification, ru/en

Response

Name Type Desc
text string Notification text

Vendors

Vendor statistic

Request example

curl "https://5sim.net/v1/user/vendor" \
  -H "Authorization: Bearer $token" \
  -H "Accept: application/json"
import requests

token = 'Your token'

headers = {
    'Authorization': 'Bearer ' + token,
    'Accept': 'application/json',
}

response = requests.get('https://5sim.net/v1/user/vendor', headers=headers)
<?php

$token = 'Your token';
$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, 'https://5sim.net/v1/user/vendor');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');


$headers = array();
$headers[] = 'Authorization: Bearer ' . $token;
$headers[] = 'Accept: application/json';
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$result = curl_exec($ch);
if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
}
curl_close($ch);

Response example

{
  "id":1,
  "email":"[email protected]",
  "vendor":"demo",
  "default_forwarding_number":"78009005040",
  "balance":100,
  "rating":96,
  "default_country": {
    "name":"russia","iso":"ru","prefix":"+7"
  },
  "default_operator": {
    "name":""
  },
  "frozen_balance":0
}

GET - https://5sim.net/v1/user/vendor

Headers

Response

Name Type Desc
id number Vendor ID
email string Vendor email
balance number Balance
rating number Rating
default_country array Default country
default_country.name string Country name
default_country.iso string ISO country code
default_country.prefix string Mobile prefix
default_operator array Default operator
default_operator.name string Operator name
frozen_balance number Frozen balance
default_forwarding_number string Forwarding number
vendor string Vendor name

Wallets reserve

Request example

curl "https://5sim.net/v1/vendor/wallets" \
  -H "Authorization: Bearer $token" \
  -H "Accept: application/json"
import requests

token = 'Your token'

headers = {
    'Authorization': 'Bearer ' + token,
    'Accept': 'application/json',
}

response = requests.get('https://5sim.net/v1/vendor/wallets', headers=headers)
<?php

$token = 'Your token';
$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, 'https://5sim.net/v1/vendor/wallets');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');


$headers = array();
$headers[] = 'Authorization: Bearer ' . $token;
$headers[] = 'Accept: application/json';
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$result = curl_exec($ch);
if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
}
curl_close($ch);

Response example

{
  "fkwallet":43339.55,
  "payeer":2117.32,
  "unitpay":97.6
}

GET - https://5sim.net/v1/vendor/wallets

Available reserves currency for partner.

Headers

Response

Name Type Desc
fkwallet number
payeer number
unitpay number

Vendor orders history

Request example

curl "https://5sim.net/v1/vendor/orders?category=activation&limit=15&offset=0&order=id&reverse=true" \
  -H "Authorization: Bearer $token" \
  -H "Accept: application/json"
import requests

token = 'Your token'
category = 'activation'
limit = 15
offset = 0
order = 'id'
reverse = True

headers = {
    'Authorization': 'Bearer ' + token,
    'Accept': 'application/json',
}

params = (
    ('category', category),
    ('limit', limit),
    ('offset', offset),
    ('order', order),
    ('reverse', reverse),
)

response = requests.get('https://5sim.net/v1/vendor/orders', headers=headers, params=params)
<?php

$token = 'Your token';
$ch = curl_init();
$category = 'activation';
$limit = 15;
$offset = 0;
$order = 'id';
$reverse = true;

curl_setopt($ch, CURLOPT_URL, 'https://5sim.net/v1/vendor/orders?category=' . $category . '&limit=' . $limit . '&offset=' . $offset . '&order=' . $id . '&reverse=' . $reverse);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');


$headers = array();
$headers[] = 'Authorization: Bearer ' . $token;
$headers[] = 'Accept: application/json';
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$result = curl_exec($ch);
if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
}
curl_close($ch);

Response example

{
  "Data": [],
  "ProductNames":[],
  "Statuses":[],
  "Total":3
}

GET - https://5sim.net/v1/vendor/orders?category=$category

Provides vendor's orders history by chosen category.

Headers

Request Parameters

Name Type Required Desc
category query string Yes Category can be 'hosting' or 'activation'
limit query string No Pagination limit
offset query string No Pagination offset
order query string No Pagination order, should be field name
reverse query string No Is reversed history, true / false

Response

Name Type Desc
Data array Orders list
ProductNames array Products list
Statuses array Statuses list
Total number Orders count

Vendor payments history

Request example

curl "https://5sim.net/v1/vendor/payments?limit=15&offset=0&order=id&reverse=true" \
  -H "Authorization: Bearer $token" \
  -H "Accept: application/json"
import requests

token = 'Your token'
limit = 15
offset = 0
order = 'id'
reverse = True

headers = {
    'Authorization': 'Bearer ' + token,
    'Accept': 'application/json',
}

params = (
    ('limit', limit),
    ('offset', offset),
    ('order', order),
    ('reverse', reverse),
)

response = requests.get('https://5sim.net/v1/vendor/payments', headers=headers, params=params)
<?php

$token = 'Your token';
$ch = curl_init();
$limit = 15;
$offset = 0;
$order = 'id';
$reverse = true;

curl_setopt($ch, CURLOPT_URL, 'https://5sim.net/v1/vendor/payments?&limit=' . $limit . '&offset=' . $offset . '&order=' . $id . '&reverse=' . $reverse);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');


$headers = array();
$headers[] = 'Authorization: Bearer ' . $token;
$headers[] = 'Accept: application/json';
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$result = curl_exec($ch);
if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
}
curl_close($ch);

Response example

{
  "Data": [],
  "PaymentProviders":null,
  "PaymentStatuses":null,
  "PaymentTypes":null,
  "Total":3
}

GET - https://5sim.net/v1/vendor/payments

Provides vendor's payments history.

Headers

Request Parameters

Name Type Required Desc
limit query string No Pagination limit
offset query string No Pagination offset
order query string No Pagination order, should be field name
reverse query string No Is reversed history, true / false

Response

Name Type Desc
Data array Payments list
PaymentProviders array Names of payments systems
PaymentStatuses array Payments statuses
PaymentTypes array Payments types
Total number Payments count

Create payouts

Request example

curl -X POST'https://5sim.net/v1/vendor/withdraw'
  -d '{"receiver":"1","method":"qiwi","amount":"1","fee":"unitpay"}'
  -H 'Authorization: Bearer $token'
  -H 'Content-Type: application/json'
import requests

token = 'Your token'

headers = {
    'Authorization': 'Bearer ' + token,
    'Content-type': 'application/json',
}

data = '{"receiver":"123456","method":"qiwi","amount":"10","fee":"unitpay"}'

response = requests.post('https://5sim.net/v1/vendor/withdraw', headers=headers, data=data)
<?php

$token = 'Your token';

$receiver = '1';
$method = 'qiwi';
$amount = '1';
$fee = 'unitpay';

$data = array(
    'receiver' => $receiver,
    'method' => $method,
    'amount' => $amount,
    'fee' => $fee,
);

$ch = curl_init();

curl_setopt_array($ch, array(
    CURLOPT_URL => 'https://5sim.net/v1/vendor/withdraw',
    CURLOPT_POST => TRUE,
    CURLOPT_RETURNTRANSFER => TRUE,
    CURLOPT_HTTPHEADER => array(
        'Authorization: Bearer ' . $token,
        'Content-Type: application/json'),
    CURLOPT_POSTFIELDS => json_encode($data),
));

$result = curl_exec($ch);
if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
}
curl_close($ch);

POST - https://5sim.net/v1/vendor/withdraw

Create payouts for a partner.

Headers

Request Parameters

Name Type Required Desc
receiver string Yes Receiver
method string Yes Output method visa / qiwi / yandex
amount string Yes Amount
fee string Yes Payment system fkwallet / payeer / unitpay

Response

Countries list

Get countries list

Response example

{
  "afghanistan":{
    "iso":{
      "af":1
    },
    "prefix":{
      "+93":1
    },
    "text_en":"Afghanistan",
    "text_ru":"Афганистан",
    "virtual18":{
      "activation":1
    },
    "virtual21":{
      "activation":1
    },
    "virtual23":{
      "activation":1
    },
    "virtual4":{
      "activation":1
    }
  }
}

GET - https://5sim.net/v1/guest/countries

Returns a list of countries with available operators for purchase.

Headers

Response

Name Type Desc
iso array ISO country code
text_en string Country name in English
text_ru string Country name in Russian

Countries list

Order statuses

Products list

Activation:

Hosting:

Operators list

Structure of sms

Response example

{
    "sms": [
        {
            "created_at":"1970-12-01T17:23:25.106597Z",
            "date":"1970-12-01T17:23:15Z",
            "sender":"Facebook",
            "text":"Use 415127 as your login code",
            "code":"415127"
        }
    ]
}
Name Type Desc
created_at date string When SMS was created
date date string When SMS received
sender string Sender name
text string Text of SMS
code string Received activation code

Limits

Rating

Description of the rating system.

The user's current rating is displayed in the account settings, the "General" tab.

The initial rating for new users is 96 points.

The maximum possible rating is 96 points.

The rating is formed from the following parameters:

Actions Rating (points)
Account replenishment +8
Completed Purchase Before Code Elapsed Time +0.5
Automatically Completed Purchase After Time Allowed To Get Code +0.4
Timeout -0.15
Canceled purchase -0.1
The number was sent to the ban -0.1

If the rating drops to zero, then you will not be able to place an order on the site within 24 hours. After 24 hours, the rating will return to the initial value - 96 points.