HS Mail API

Simple and Powerful API Integration

Your API Key

Login Required

Please login to generate your API key.

Authentication

Include your API key in every request using one of these methods:

Method 1: Header (Recommended)

X-API-Key: your_api_key_here

Method 2: Query Parameter

?api_key=your_api_key_here

API Endpoints

GET

https://hsmail.shop/api/v1/profile

Full URL (with API Key):

https://hsmail.shop/api/v1/profile?api_key=YOUR_API_KEY

Get your account profile and balance.

Method: GET | Authentication: Required (API Key via header or query parameter)

@php
$apiKey = 'YOUR_API_KEY';
$url = 'https://hsmail.shop/api/v1/profile?api_key=' . $apiKey;

$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Accept: application/json',
    'X-API-Key: ' . $apiKey
]);
$response = curl_exec($ch);
curl_close($ch);

$result = json_decode($response, true);
print_r($result);

import requests

api_key = 'YOUR_API_KEY'
url = 'https://hsmail.shop/api/v1/profile'

response = requests.get(url, headers={'X-API-Key': api_key})
print(response.json())

const apiKey = 'YOUR_API_KEY';
const url = 'https://hsmail.shop/api/v1/profile?api_key=' + apiKey;

fetch(url, {
    headers: {
        'X-API-Key': apiKey,
        'Accept': 'application/json'
    }
})
.then(r => r.json())
.then(data => console.log(data));

GET

https://hsmail.shop/api/v1/products

Full URL (with API Key):

https://hsmail.shop/api/v1/products?api_key=YOUR_API_KEY

Get all active products with categories, prices, and stock.

Method: GET | Authentication: Required (API Key via header or query parameter)

@php
$apiKey = 'YOUR_API_KEY';
$url = 'https://hsmail.shop/api/v1/products?api_key=' . $apiKey;

$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Accept: application/json',
    'X-API-Key: ' . $apiKey
]);
$response = curl_exec($ch);
curl_close($ch);

$result = json_decode($response, true);
print_r($result);

import requests

api_key = 'YOUR_API_KEY'
url = 'https://hsmail.shop/api/v1/products'

# Method 1: Using header (Recommended)
headers = {
    'X-API-Key': api_key,
    'Accept': 'application/json'
}
response = requests.get(url, headers=headers)

# Method 2: Using query parameter
# response = requests.get(url, params={'api_key': api_key})

print(response.json())

const apiKey = 'YOUR_API_KEY';
const url = 'https://hsmail.shop/api/v1/products';

// Method 1: Using header (Recommended)
fetch(url, {
    headers: {
        'X-API-Key': apiKey,
        'Accept': 'application/json'
    }
})
.then(r => r.json())
.then(data => console.log(data));

// Method 2: Using query parameter
// fetch(url + '?api_key=' + apiKey)
//     .then(r => r.json())
//     .then(data => console.log(data));

GET

https://hsmail.shop/api/v1/product/1

Full URL (with API Key):

https://hsmail.shop/api/v1/product/1?api_key=YOUR_API_KEY

Get details of a specific product. Replace 1 with product ID.

Method: GET | Authentication: Required (API Key via header or query parameter)

Parameter	Type	Required	Description
`id`	integer	Required	Product ID

@php
$apiKey = 'YOUR_API_KEY';
$productId = 1;
$url = 'https://hsmail.shop/api/v1/product/' . $productId . '?api_key=' . $apiKey;

$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Accept: application/json',
    'X-API-Key: ' . $apiKey
]);
$response = curl_exec($ch);
curl_close($ch);

$result = json_decode($response, true);
print_r($result);

import requests

api_key = 'YOUR_API_KEY'
product_id = 1
url = f'https://hsmail.shop/api/v1/product/{product_id}'

response = requests.get(url, headers={'X-API-Key': api_key})
print(response.json())

const apiKey = 'YOUR_API_KEY';
const productId = 1;
const url = `https://hsmail.shop/api/v1/product/${productId}`;

fetch(url, {
    headers: {
        'X-API-Key': apiKey,
        'Accept': 'application/json'
    }
})
.then(r => r.json())
.then(data => console.log(data));

GET

https://hsmail.shop/api/v1/calculate-price?product_id=1&quantity=10

Full URL (with API Key):

https://hsmail.shop/api/v1/calculate-price?product_id=1&quantity=10&api_key=YOUR_API_KEY

Calculate final price with discounts and coupons.

Method: GET | Authentication: Required (API Key via header or query parameter)

Parameter	Type	Required	Description
`product_id`	integer	Required	Product ID
`quantity`	integer	Required	Quantity
`coupon_code`	string	Optional	Coupon code

@php
$apiKey = 'YOUR_API_KEY';
$url = 'https://hsmail.shop/api/v1/calculate-price?product_id=1&quantity=10&api_key=' . $apiKey;

$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Accept: application/json',
    'X-API-Key: ' . $apiKey
]);
$response = curl_exec($ch);
curl_close($ch);

$result = json_decode($response, true);
print_r($result);

import requests

api_key = 'YOUR_API_KEY'
url = 'https://hsmail.shop/api/v1/calculate-price'
params = {
    'product_id': 1,
    'quantity': 10,
    'api_key': api_key
}

response = requests.get(url, params=params, headers={'X-API-Key': api_key})
print(response.json())

const apiKey = 'YOUR_API_KEY';
const url = 'https://hsmail.shop/api/v1/calculate-price?product_id=1&quantity=10&api_key=' + apiKey;

fetch(url, {
    headers: {
        'X-API-Key': apiKey,
        'Accept': 'application/json'
    }
})
.then(r => r.json())
.then(data => console.log(data));

GET

https://hsmail.shop/api/v1/place-order?product_id=1&quantity=5

Full URL (with API Key):

https://hsmail.shop/api/v1/place-order?product_id=1&quantity=5&api_key=YOUR_API_KEY

Place an order (requires sufficient balance).

Method: GET | Authentication: Required (API Key via header or query parameter)

Parameter	Type	Required	Description
`product_id`	integer	Required	Product ID
`quantity`	integer	Required	Quantity
`coupon_code`	string	Optional	Coupon code

@php
$apiKey = 'YOUR_API_KEY';
$url = 'https://hsmail.shop/api/v1/place-order?product_id=1&quantity=5&api_key=' . $apiKey;

$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Accept: application/json',
    'X-API-Key: ' . $apiKey
]);
$response = curl_exec($ch);
curl_close($ch);

$result = json_decode($response, true);
print_r($result);

import requests

api_key = 'YOUR_API_KEY'
url = 'https://hsmail.shop/api/v1/place-order'
params = {
    'product_id': 1,
    'quantity': 5,
    'api_key': api_key
}

response = requests.get(url, params=params, headers={'X-API-Key': api_key})
print(response.json())

const apiKey = 'YOUR_API_KEY';
const url = 'https://hsmail.shop/api/v1/place-order?product_id=1&quantity=5&api_key=' + apiKey;

fetch(url, {
    headers: {
        'X-API-Key': apiKey,
        'Accept': 'application/json'
    }
})
.then(r => r.json())
.then(data => console.log(data));

GET

https://hsmail.shop/api/v1/orders

Full URL (with API Key):

https://hsmail.shop/api/v1/orders?api_key=YOUR_API_KEY

Get your order history (last 50 orders).

Method: GET | Authentication: Required (API Key via header or query parameter)

@php
$apiKey = 'YOUR_API_KEY';
$url = 'https://hsmail.shop/api/v1/orders?api_key=' . $apiKey;

$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Accept: application/json',
    'X-API-Key: ' . $apiKey
]);
$response = curl_exec($ch);
curl_close($ch);

$result = json_decode($response, true);
print_r($result);

import requests

api_key = 'YOUR_API_KEY'
url = 'https://hsmail.shop/api/v1/orders'

response = requests.get(url, headers={'X-API-Key': api_key})
print(response.json())

const apiKey = 'YOUR_API_KEY';
const url = 'https://hsmail.shop/api/v1/orders?api_key=' + apiKey;

fetch(url, {
    headers: {
        'X-API-Key': apiKey,
        'Accept': 'application/json'
    }
})
.then(r => r.json())
.then(data => console.log(data));

GET

https://hsmail.shop/api/v1/stats

Full URL (with API Key):

https://hsmail.shop/api/v1/stats?api_key=YOUR_API_KEY

Get your API usage statistics.

Method: GET | Authentication: Required (API Key via header or query parameter)

@php
$apiKey = 'YOUR_API_KEY';
$url = 'https://hsmail.shop/api/v1/stats?api_key=' . $apiKey;

$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Accept: application/json',
    'X-API-Key: ' . $apiKey
]);
$response = curl_exec($ch);
curl_close($ch);

$result = json_decode($response, true);
print_r($result);

import requests

api_key = 'YOUR_API_KEY'
url = 'https://hsmail.shop/api/v1/stats'

response = requests.get(url, headers={'X-API-Key': api_key})
print(response.json())

const apiKey = 'YOUR_API_KEY';
const url = 'https://hsmail.shop/api/v1/stats?api_key=' + apiKey;

fetch(url, {
    headers: {
        'X-API-Key': apiKey,
        'Accept': 'application/json'
    }
})
.then(r => r.json())
.then(data => console.log(data));

Mailbox API

Read mailboxes (Gmail, Hotmail/Outlook, Business Mail) without requiring your main API Key.

GET

https://hsmail.shop/api/v1/public/mailbox/gmail?email=user@gmail.com|token

Full URL Format:

https://hsmail.shop/api/v1/public/mailbox/gmail?email=user@gmail.com|token

What is this for?
This endpoint allows you to check the status of a Gmail account and extract verification codes (e.g., for Instagram, Facebook, Netflix) from its emails. It uses internal tokens to access the mailbox securely.

Method: GET | Authentication: Not required

Parameter	Type	Required	Description
`email`	string	Required	Format: `email\|token`. The Gmail address and its access token separated by a pipe.

Enter Email|Token:

@php
$email = 'user@gmail.com|token';
$url = 'https://hsmail.shop/api/v1/public/mailbox/gmail?email=' . urlencode($email);

$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);

$result = json_decode($response, true);
print_r($result);

import requests

url = 'https://hsmail.shop/api/v1/public/mailbox/gmail'
params = {'email': 'user@gmail.com'}

response = requests.get(url, params=params)
print(response.json())

const email = 'user@gmail.com|token';
const url = 'https://hsmail.shop/api/v1/public/mailbox/gmail?email=' + encodeURIComponent(email);

fetch(url)
.then(r => r.json())
.then(data => console.log(data));

GET

https://hsmail.shop/api/v1/public/mailbox/hotmail?accounts[]=user@outlook.com|pass|token|client||recovery@gmail.com&mode=oauth

Full URL Format:

https://hsmail.shop/api/v1/public/mailbox/hotmail?accounts[]=user@outlook.com|pass|token|client_id||recovery@gmail.com&mode=oauth

What is this for?
Check Microsoft Outlook or Hotmail accounts for emails. It supports both OAuth2 tokens and direct Graph API access. You can check multiple accounts at once.

Method: GET | Authentication: Not required

Parameter	Type	Required	Description
`accounts[]`	array	Required	List of accounts. Format: `email\|pass\|token\|client_id\|\|recovery_email`
`mode`	string	Optional	`oauth` (default) or `graph`

Format: email|password|refresh_token|client_id|recovery_email
Example: user@outlook.com|password123|token|client_id||recovery@gmail.com

Enter Accounts (One per line):

GET

https://hsmail.shop/api/v1/public/mailbox/business-email?token=YOUR_TOKEN

Full URL Format:

https://hsmail.shop/api/v1/public/mailbox/business-email?token=YOUR_TOKEN

What is this for?
Connect to a Business Email server using a specific access token to retrieve messages.

Method: GET | Authentication: Not required

Parameter	Type	Required	Description
`token`	string	Required	The access token string.

Enter Token:

GET

https://hsmail.shop/api/v1/public/facebook/live?uid=USER_ID

Full URL Format:

https://hsmail.shop/api/v1/public/facebook/live?uid=USER_ID

What is this for?
Check if a specific Facebook User ID (UID) is currently live or active. Useful for verifying Facebook account status.

Method: GET | Authentication: Not required

Parameter	Type	Required	Description
`uid`	string	Required	The Facebook User ID to check.

Enter UID:

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://hsmail.shop/api/v1/public/facebook/live?uid=1000...',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
));

$response = curl_exec($curl);
curl_close($curl);

$result = json_decode($response, true);
if ($result['status'] === 'live') {
    echo "User is Live!";
}

import requests

url = "https://hsmail.shop/api/v1/public/facebook/live?uid=1000..."

response = requests.get(url)
data = response.json()

if data.get('status') == 'live':
    print("User is Live!")
else:
    print("User is Offline or Invalid")

fetch('https://hsmail.shop/api/v1/public/facebook/live?uid=1000...')
  .then(response => response.json())
  .then(data => {
    if (data.status === 'live') {
      console.log('User is Live!');
    } else {
      console.log('User is Offline');
    }
  })
  .catch(error => console.error('Error:', error));

POST

https://hsmail.shop/api/refresh-token

Refresh Microsoft/Outlook OAuth2 tokens by exchanging a refresh token for a new access token. This endpoint connects directly to Microsoft's Identity Platform.

Parameter	Type	Required	Description
`client_id`	string	Required	Your Application Client ID (from Azure Portal).
`refresh_token`	string	Required	The expired or valid refresh token.
`client_secret`	string	Optional	Client Secret (required for Web Apps, optional for Public Clients).

Live Console

Client ID:

Refresh Token:

Client Secret (Optional):

Code Examples

$curl = curl_init();

$postData = array(
    'client_id' => 'YOUR_CLIENT_ID',
    'refresh_token' => 'YOUR_REFRESH_TOKEN',
    'client_secret' => 'YOUR_CLIENT_SECRET' // Optional
);

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://hsmail.shop/api/refresh-token',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => json_encode($postData),
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);
curl_close($curl);
echo $response;

import requests
import json

url = "https://hsmail.shop/api/refresh-token"

payload = json.dumps({
  "client_id": "YOUR_CLIENT_ID",
  "refresh_token": "YOUR_REFRESH_TOKEN",
  "client_secret": "YOUR_CLIENT_SECRET"
})
headers = {
  'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

const myHeaders = new Headers();
myHeaders.append("Content-Type", "application/json");

const raw = JSON.stringify({
  "client_id": "YOUR_CLIENT_ID",
  "refresh_token": "YOUR_REFRESH_TOKEN",
  "client_secret": "YOUR_CLIENT_SECRET"
});

const requestOptions = {
  method: "POST",
  headers: myHeaders,
  body: raw,
  redirect: "follow"
};

fetch("https://hsmail.shop/api/refresh-token", requestOptions)
  .then((response) => response.text())
  .then((result) => console.log(result))
  .catch((error) => console.error(error));

2FA Generator API

Generate 2FA TOTP codes programmatically.

GET

https://hsmail.shop/api/2fa-generate

Generate a current TOTP code from a secret key.

Parameter	Type	Required	Description
`key`	String	Yes	The 2FA Secret Key (Base32 encoded)

curl -X GET "https://hsmail.shop/api/2fa-generate?key=JBSWY3DPEHPK3PXP"

fetch('https://hsmail.shop/api/2fa-generate?key=JBSWY3DPEHPK3PXP')
  .then(response => response.json())
  .then(data => console.log(data));

$response = file_get_contents('https://hsmail.shop/api/2fa-generate?key=JBSWY3DPEHPK3PXP');
$data = json_decode($response, true);

Error Handling

All API errors follow this standardized format:

{
  "success": false,
  "error": "Error message description"
}
        

Common HTTP Status Codes:

Code	Meaning	Description
`200`	OK	Request successful
`400`	Bad Request	Invalid parameters
`401`	Unauthorized	Invalid or missing API key
`404`	Not Found	Resource not found
`500`	Server Error	Internal server error

HS Mail

HS Mail API

Your API Key

API V2 - Faster & More Secure

Authentication

Method 1: Header (Recommended)

Method 2: Query Parameter

API Endpoints

Mailbox API

Live Console

Code Examples

2FA Generator API

Error Handling

Common HTTP Status Codes:

Live Chat Support

👋 Welcome!

Live Support

আপনার মতামত

আপনার অভিজ্ঞতা কেমন ছিল? 💭

HS Mail

HS Mail API

Your API Key

API V2 - Faster & More Secure

Authentication

Method 1: Header (Recommended)

Method 2: Query Parameter

API Endpoints

Mailbox API

Live Console

Code Examples

2FA Generator API

Error Handling

Common HTTP Status Codes:

Live Chat Support

👋 Welcome!

Live Support

আপনার মতামত

আপনার অভিজ্ঞতা কেমন ছিল? 💭

চ্যাট শেষ করবেন? 👋