Do you need help?
  • English

API Documentation

To gain access to our API, contact our support team via Telegram at: @Cloaking_House

Get list of flows

Request URL

Parameter Data type Required Description
api_key String Yes Unique API key for request authentication.
date_ranges String No Date range in format DD.MM.YYYY - DD.MM.YYYY.
status String No Flow status filter: active, pause, deleted.
search String No Search string for flow name or fields.
per_page Number No Number of records per page (10 to 200). Default: 10.
page Number No Page number starting from 1. Default: 1.
Parameter Data type Description
status String Indicates whether the request was successful ("success") or resulted in an error ("error").
msg String Error message or additional information about the request.
code Number Response code, for example 200 for a successful request.
total Number Total number of flows matching the query.
per_page Number Number of records per page.
page Number Current page number.
data Array Array with flow data.
<?php


    function api_request($data = [])
    {
        $ch = curl_init('https://cloaking.house/api/flows');

        curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
        curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
        curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
        curl_setopt($ch, CURLOPT_IPRESOLVE, CURL_IPRESOLVE_V4);
        curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($data));

        $body = curl_exec($ch);
        $info = curl_getinfo($ch);

        curl_close($ch);

        if ( ! empty($info['http_code']) && $info['http_code'] == 200) {
            return json_decode($body, TRUE);
        }
    }


    $body_request = [
        'api_key'       => 'YOUR_API_KEY',
        'date_ranges'   => '01.01.2023 - 31.12.2023',
        'status'        => 'active',
        'search'        => '84b593db13ccd6acf79ec7287d5da586',
        'per_page'      => 10,
        'page'          => 1
    ];


    $api_request = api_request($body_request);
    if ( ! empty($api_request['status'])) {
        echo '<pre>';
        print_r($api_request);
        echo '</pre>';
    }

Create flow

Request URL

Parameter Data type Required Description
api_key String Yes Unique API key for request authentication.
name String Yes Flow name (3–32 characters).
url_white_page String Yes White page URL (5–1024 characters).
url_offer_page String Yes Offer page URL (5–1024 characters).
mode_white_page String Yes White page mode: loading or redirect.
mode_offer_page String Yes Offer page mode: loading, redirect, iframe.
filter_countries Array Yes List of country IDs for filtering.
filter_devices Array Yes List of device IDs for filtering.
filter_os Array Yes List of OS IDs for filtering.
filter_browsers Array Yes List of browser IDs for filtering.
filter_langs Array No List of language IDs for filtering.
filter_time_zones Array No List of timezone IDs for filtering.
filter_connections Array No List of connection type IDs for filtering.
filter_tags Array No List of GET parameters that must be present in the request (e.g. clickid, utm_source). Maximum 10 parameters.
filter_cloaking_flag Number Yes Bot filtering flag (1 – enabled, 0 – disabled).
filter_vpn_proxy_flag Number Yes VPN/Proxy filtering flag (1 – enabled, 0 – disabled).
filter_ip_v6_flag Number Yes IPv6 filtering flag (1 – enabled, 0 – disabled).
filter_referer_flag Number Yes Referrer filtering flag (1 – enabled, 0 – disabled).
filter_isp_flag Number Yes ISP filtering flag (1 – enabled, 0 – disabled).
filter_black_ip_flag Number Yes Black IP filtering flag (1 – enabled, 0 – disabled).
filter_tag_flag Number Yes Flag to enable filtering by GET parameters (1 – enabled, 0 – disabled).
filter_ip_clicks_per_day Number Yes Maximum clicks per IP per day. Default: 0 (disabled).
filter_clicks_before_filtering Number Yes Number of clicks before applying filters. Default: 0 (disabled).
mode_list_country Number Yes Country filter mode (1 - allowed, 0 - blocked).
mode_list_device Number Yes Device filter mode (1 - allowed, 0 - blocked).
mode_list_os Number Yes OS filter mode (1 - allowed, 0 - blocked).
mode_list_browser Number Yes Browser filter mode (1 - allowed, 0 - blocked).
mode_list_lang Number Yes Language filter mode (1 - allowed, 0 - blocked).
mode_list_time_zone Number Yes Timezone filter mode (1 - allowed, 0 - blocked).
mode_list_connection Number Yes Connection type filter mode (1 - allowed, 0 - blocked).
filter_id Number No Filter list ID applied to the flow. Default: 0 (not used).
allowed_ips Array No List of allowed IP addresses (IPv4 or IPv6).
Parameter Data type Description
status String Indicates whether the request was successful ("success") or resulted in an error ("error").
msg String Error message or additional information about the request.
code Number Response code, for example 200 for a successful request.
flow_id Number Unique flow ID.
label String System flow ID.

<?php


    function api_request($data = [])
    {
        $ch = curl_init('https://cloaking.house/api/flows/create');

        curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
        curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
        curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
        curl_setopt($ch, CURLOPT_IPRESOLVE, CURL_IPRESOLVE_V4);
        curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($data));

        $body = curl_exec($ch);
        $info = curl_getinfo($ch);

        curl_close($ch);

        if ( ! empty($info['http_code']) && $info['http_code'] == 200) {
            return json_decode($body, TRUE);
        }
    }


    $body_request = [
        'api_key'                           => 'YOUR_API_KEY',
        'name'                              => 'Test flow',
        'url_white_page'                    => 'https://google.com',
        'url_offer_page'                    => 'https://google.com',
        'mode_white_page'                   => 'redirect',
        'mode_offer_page'                   => 'redirect',
        'filter_countries'                  => [107, 5555],
        'filter_devices'                    => [2],
        'filter_os'                         => [6],
        'filter_browsers'                   => [2],
        'filter_langs'                      => [1],
        'filter_time_zones'                 => [1, 2, 3],
        'filter_connections'                => [1, 2],
        'filter_tags'                       => ['clickid', 'gclid', 'fbclid', 'ttclid'],
        'filter_cloaking_flag'              => 1,
        'filter_vpn_proxy_flag'             => 1,
        'filter_referer_flag'               => 1,
        'filter_isp_flag'                   => 1,
        'filter_ip_clicks_per_day'          => 10,
        'filter_clicks_before_filtering'    => 10,
        'filter_black_ip_flag'              => 1,
        'filter_tag_flag'                   => 1,
        'mode_list_country'                 => 1,
        'mode_list_device'                  => 1,
        'mode_list_os'                      => 1,
        'mode_list_browser'                 => 1,
        'mode_list_lang'                    => 1,
        'mode_list_time_zone'               => 1,
        'mode_list_connection'              => 1,
        'status'                            => 'pause',
        'filter_id'                         => 0,
        'allowed_ips'                       => ['66.249.64.104', '5.133.192.168']
    ];


    $api_request = api_request($body_request);
    if ( ! empty($api_request['status'])) {
        echo '<pre>';
        print_r($api_request);
        echo '</pre>';
    }

Update flow

Request URL

Parameter Data type Required Description
api_key String Yes Unique API key for request authentication.
flow_id Number Yes Unique flow ID.
name String Yes Flow name (3–32 characters).
url_white_page String Yes White page URL (5–1024 characters).
url_offer_page String Yes Offer page URL (5–1024 characters).
mode_white_page String Yes White page mode: loading or redirect.
mode_offer_page String Yes Offer page mode: loading, redirect, iframe.
filter_countries Array Yes List of country IDs for filtering.
filter_devices Array Yes List of device IDs for filtering.
filter_os Array Yes List of OS IDs for filtering.
filter_browsers Array Yes List of browser IDs for filtering.
filter_langs Array No List of language IDs for filtering.
filter_time_zones Array No List of timezone IDs for filtering.
filter_connections Array No List of connection type IDs for filtering.
filter_tags Array No List of GET parameters that must be present in the request (e.g. clickid, utm_source). Maximum 10 parameters.
filter_cloaking_flag Number Yes Bot filtering flag (1 – enabled, 0 – disabled).
filter_vpn_proxy_flag Number Yes VPN/Proxy filtering flag (1 – enabled, 0 – disabled).
filter_ip_v6_flag Number Yes IPv6 filtering flag (1 – enabled, 0 – disabled).
filter_referer_flag Number Yes Referrer filtering flag (1 – enabled, 0 – disabled).
filter_isp_flag Number Yes ISP filtering flag (1 – enabled, 0 – disabled).
filter_black_ip_flag Number Yes Black IP filtering flag (1 – enabled, 0 – disabled).
filter_tag_flag Number Yes Flag to enable filtering by GET parameters (1 – enabled, 0 – disabled).
filter_ip_clicks_per_day Number Yes Maximum clicks per IP per day. Default: 0 (disabled).
filter_clicks_before_filtering Number Yes Number of clicks before applying filters. Default: 0 (disabled).
mode_list_country Number Yes Country filter mode (1 - allowed, 0 - blocked).
mode_list_device Number Yes Device filter mode (1 - allowed, 0 - blocked).
mode_list_os Number Yes OS filter mode (1 - allowed, 0 - blocked).
mode_list_browser Number Yes Browser filter mode (1 - allowed, 0 - blocked).
mode_list_lang Number Yes Language filter mode (1 - allowed, 0 - blocked).
mode_list_time_zone Number Yes Timezone filter mode (1 - allowed, 0 - blocked).
mode_list_connection Number Yes Connection type filter mode (1 - allowed, 0 - blocked).
filter_id Number No Filter list ID applied to the flow. Default: 0 (not used).
allowed_ips Array No List of allowed IP addresses (IPv4 or IPv6).
Parameter Data type Description
status String Indicates whether the request was successful ("success") or resulted in an error ("error").
msg String Error message or additional information about the request.
code Number Response code, for example 200 for a successful request.
flow_id Number Unique flow ID.
label String System flow ID.

<?php


    function api_request($data = [])
    {
        $ch = curl_init('https://cloaking.house/api/flows/update');

        curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
        curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
        curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
        curl_setopt($ch, CURLOPT_IPRESOLVE, CURL_IPRESOLVE_V4);
        curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($data));

        $body = curl_exec($ch);
        $info = curl_getinfo($ch);

        curl_close($ch);

        if ( ! empty($info['http_code']) && $info['http_code'] == 200) {
            return json_decode($body, TRUE);
        }
    }


    $body_request = [
        'api_key'                           => 'YOUR_API_KEY',
        'flow_id'                           => 1,
        'name'                              => 'Test flow',
        'url_white_page'                    => 'https://google.com',
        'url_offer_page'                    => 'https://google.com',
        'mode_white_page'                   => 'redirect',
        'mode_offer_page'                   => 'redirect',
        'filter_countries'                  => [107, 5555],
        'filter_devices'                    => [2],
        'filter_os'                         => [6],
        'filter_browsers'                   => [2],
        'filter_langs'                      => [1],
        'filter_time_zones'                 => [1, 2, 3],
        'filter_connections'                => [1, 2],
        'filter_tags'                       => ['clickid', 'gclid', 'fbclid', 'ttclid'],
        'filter_cloaking_flag'              => 1,
        'filter_vpn_proxy_flag'             => 1,
        'filter_referer_flag'               => 1,
        'filter_isp_flag'                   => 1,
        'filter_ip_clicks_per_day'          => 10,
        'filter_clicks_before_filtering'    => 10,
        'filter_black_ip_flag'              => 1,
        'filter_tag_flag'                   => 1,
        'mode_list_country'                 => 1,
        'mode_list_device'                  => 1,
        'mode_list_os'                      => 1,
        'mode_list_browser'                 => 1,
        'mode_list_lang'                    => 1,
        'mode_list_time_zone'               => 1,
        'mode_list_connection'              => 1,
        'status'                            => 'pause',
        'filter_id'                         => 0,
        'allowed_ips'                       => ['66.249.64.104', '5.133.192.168']
    ];


    $api_request = api_request($body_request);
    if ( ! empty($api_request['status'])) {
        echo '<pre>';
        print_r($api_request);
        echo '</pre>';
    }

Get flow details

Request URL

Parameter Data type Required Description
api_key String Yes Unique API key for request authentication.
flow_id Number Yes Unique flow ID.
Parameter Data type Description
status String Indicates whether the request was successful ("success") or resulted in an error ("error").
msg String Error message or additional information about the request.
code Number Response code, for example 200 for a successful request.
data Array Array with flow details including parameters and settings.
└─ flow_id Number Unique flow ID.
└─ name String Flow name..
└─ status String Flow status: active, pause, deleted.
└─ label String System flow ID.
└─ time_created Number Flow creation time in Unix format.
└─ date_created String Flow creation date (YYYY-MM-DD).
└─ url_white_page String Flow white page URL.
└─ url_offer_page String Flow offer page URL.
└─ mode_white_page String White page mode: loading or redirect.
└─ mode_offer_page String Offer page mode: loading, redirect, iframe.
└─ filter_cloaking_flag Number Bot filtering flag (1 – enabled, 0 – disabled).
└─ filter_vpn_proxy_flag Number VPN/Proxy filtering flag (1 – enabled, 0 – disabled).
└─ filter_ip_v6_flag Number IPv6 filtering flag (1 – enabled, 0 – disabled).
└─ filter_referer_flag Number Referrer filtering flag (1 – enabled, 0 – disabled).
└─ filter_isp_flag Number ISP filtering flag (1 – enabled, 0 – disabled).
└─ filter_black_ip_flag Number Black IP filtering flag (1 – enabled, 0 – disabled).
└─ filter_ip_clicks_per_day Number Maximum clicks per IP per day. Default: 0 (disabled).
└─ filter_clicks_before_filtering Number Number of clicks before applying filters. Default: 0 (disabled).
└─ mode_list_country Number Country filter mode (1 - allowed, 0 - blocked).
└─ mode_list_device Number Device filter mode (1 - allowed, 0 - blocked).
└─ mode_list_os Number OS filter mode (1 - allowed, 0 - blocked).
└─ mode_list_browser Number Browser filter mode (1 - allowed, 0 - blocked).
└─ mode_list_lang Number Language filter mode (1 - allowed, 0 - blocked).
└─ mode_list_time_zone Number Timezone filter mode (1 - allowed, 0 - blocked).
└─ mode_list_connection Number Connection type filter mode (1 - allowed, 0 - blocked).
└─ filter_id Number Filter list ID applied to the flow. Default: 0 (not used).
└─ allowed_ips Array List of allowed IPs (whitelist).
└─ country_ids Array List of country IDs for filtering.
└─ device_ids Array List of device IDs for filtering.
└─ os_ids Array List of OS IDs for filtering.
└─ browser_ids Array List of browser IDs for filtering.
└─ language_ids Array List of language IDs for filtering.
└─ time_zone_ids Array List of timezone IDs for filtering.
└─ connection_ids Array List of connection type IDs for filtering.
└─ hosts Number Number of unique IP requests.
└─ hits Number Total number of IP requests.
└─ filtered Number Number of requests passed filtering.
└─ ctr Number Click-through rate (CTR) in percent.

<?php


    function api_request($data = [])
    {
        $ch = curl_init('https://cloaking.house/api/flows/details');

        curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
        curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
        curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
        curl_setopt($ch, CURLOPT_IPRESOLVE, CURL_IPRESOLVE_V4);
        curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($data));

        $body = curl_exec($ch);
        $info = curl_getinfo($ch);

        curl_close($ch);

        if ( ! empty($info['http_code']) && $info['http_code'] == 200) {
            return json_decode($body, TRUE);
        }
    }


    $body_request = [
        'api_key' => 'YOUR_API_KEY',
        'flow_id' => 1
    ];


    $api_request = api_request($body_request);
    if ( ! empty($api_request['status'])) {
        echo '<pre>';
        print_r($api_request);
        echo '</pre>';
    }

Delete flow

Request URL

Parameter Data type Required Description
api_key String Yes Unique API key for request authentication.
flow_id Yes Yes Unique flow ID.
Parameter Data type Description
status String Indicates whether the request was successful ("success") or resulted in an error ("error").
msg String Error message or additional information about the request.
code Yes Response code, for example 200 for a successful request.
flow_id Yes Unique flow ID.
label String System flow ID.

<?php


    function api_request($data = [])
    {
        $ch = curl_init('https://cloaking.house/api/flows/delete');

        curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
        curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
        curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
        curl_setopt($ch, CURLOPT_IPRESOLVE, CURL_IPRESOLVE_V4);
        curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($data));

        $body = curl_exec($ch);
        $info = curl_getinfo($ch);

        curl_close($ch);

        if ( ! empty($info['http_code']) && $info['http_code'] == 200) {
            return json_decode($body, TRUE);
        }
    }


    $body_request = [
        'api_key' => 'YOUR_API_KEY',
        'flow_id' => 1
    ];


    $api_request = api_request($body_request);
    if ( ! empty($api_request['status'])) {
        echo '<pre>';
        print_r($api_request);
        echo '</pre>';
    }

Restore flow

Request URL

Parameter Data type Required Description
api_key String Yes Unique API key for request authentication.
flow_id Number Yes Unique flow ID.
Parameter Data type Description
status String Indicates whether the request was successful ("success") or resulted in an error ("error").
msg String Error message or additional information about the request.
code Number Response code, for example 200 for a successful request.
flow_id Number Unique flow ID.
label String System flow ID.

<?php


    function api_request($data = [])
    {
        $ch = curl_init('https://cloaking.house/api/flows/restore');

        curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
        curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
        curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
        curl_setopt($ch, CURLOPT_IPRESOLVE, CURL_IPRESOLVE_V4);
        curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($data));

        $body = curl_exec($ch);
        $info = curl_getinfo($ch);

        curl_close($ch);

        if ( ! empty($info['http_code']) && $info['http_code'] == 200) {
            return json_decode($body, TRUE);
        }
    }


    $body_request = [
        'api_key' => 'YOUR_API_KEY',
        'flow_id' => 1
    ];


    $api_request = api_request($body_request);
    if ( ! empty($api_request['status'])) {
        echo '<pre>';
        print_r($api_request);
        echo '</pre>';
    }

Activate flow

Request URL

Parameter Data type Required Description
api_key String Yes Unique API key for request authentication.
flow_id Number Yes Unique flow ID.
Parameter Data type Description
status String Indicates whether the request was successful ("success") or resulted in an error ("error").
msg String Error message or additional information about the request.
code Number Response code, for example 200 for a successful request.
flow_id Number Unique flow ID.
label String System flow ID.

<?php


    function api_request($data = [])
    {
        $ch = curl_init('https://cloaking.house/api/flows/activate');

        curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
        curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
        curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
        curl_setopt($ch, CURLOPT_IPRESOLVE, CURL_IPRESOLVE_V4);
        curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($data));

        $body = curl_exec($ch);
        $info = curl_getinfo($ch);

        curl_close($ch);

        if ( ! empty($info['http_code']) && $info['http_code'] == 200) {
            return json_decode($body, TRUE);
        }
    }


    $body_request = [
        'api_key' => 'YOUR_API_KEY',
        'flow_id' => 1
    ];


    $api_request = api_request($body_request);
    if ( ! empty($api_request['status'])) {
        echo '<pre>';
        print_r($api_request);
        echo '</pre>';
    }

Pause flow

Request URL

Parameter Data type Required Description
api_key String Yes Unique API key for request authentication.
flow_id Number Yes Unique flow ID.
Parameter Data type Description
status String Indicates whether the request was successful ("success") or resulted in an error ("error").
msg String Error message or additional information about the request.
code Number Response code, for example 200 for a successful request.
flow_id Number Unique flow ID.
label String System flow ID.

<?php


    function api_request($data = [])
    {
        $ch = curl_init('https://cloaking.house/api/flows/pause');

        curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
        curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
        curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
        curl_setopt($ch, CURLOPT_IPRESOLVE, CURL_IPRESOLVE_V4);
        curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($data));

        $body = curl_exec($ch);
        $info = curl_getinfo($ch);

        curl_close($ch);

        if ( ! empty($info['http_code']) && $info['http_code'] == 200) {
            return json_decode($body, TRUE);
        }
    }


    $body_request = [
        'api_key' => 'YOUR_API_KEY',
        'flow_id' => 1
    ];


    $api_request = api_request($body_request);
    if ( ! empty($api_request['status'])) {
        echo '<pre>';
        print_r($api_request);
        echo '</pre>';
    }

Download integration file

Request URL

Parameter Data type Required Description
api_key String Yes Unique API key for request authentication.
flow_id Number Yes Unique flow ID.
Parameter Data type Description
status String Indicates whether the request was successful ("success") or resulted in an error ("error").
msg String Error message or additional information about the request.
code Number Response code, for example 200 for a successful request.
flow_id Number Unique flow ID.
label String System flow ID.
download_url String URL to download ZIP file.

<?php


    function api_request($data = [])
    {
        $ch = curl_init('https://cloaking.house/api/flows/download');

        curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
        curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
        curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
        curl_setopt($ch, CURLOPT_IPRESOLVE, CURL_IPRESOLVE_V4);
        curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($data));

        $body = curl_exec($ch);
        $info = curl_getinfo($ch);

        curl_close($ch);

        if ( ! empty($info['http_code']) && $info['http_code'] == 200) {
            return json_decode($body, TRUE);
        }
    }


    $body_request = [
        'api_key' => 'YOUR_API_KEY',
        'flow_id' => 1
    ];


    $api_request = api_request($body_request);
    if ( ! empty($api_request['status'])) {
        echo '<pre>';
        print_r($api_request);
        echo '</pre>';
    }

Get filter lists

Request URL

Parameter Data type Required Description
api_key String Yes Unique API key for request authentication.
date_ranges String No Date range in format DD.MM.YYYY - DD.MM.YYYY.
status String No Filter status. Allowed values: active, deleted.
list_type String No List type: white — whitelist, black — blacklist.
search String No Search string for filter name or fields.
per_page Number No Number of records per page (10 to 200). Default: 10.
page Number No Page number starting from 1. Default: 1.
Parameter Data type Description
status String Indicates whether the request was successful ("success") or resulted in an error ("error").
msg String Error message or additional information about the request.
code Number Response code, for example 200 for a successful request.
total Number Number of filters matching the query.
per_page Number Number of records per page.
page Number Current page number.
data Array Array with filter data.
<?php


    function api_request($data = [])
    {
        $ch = curl_init('https://cloaking.house/api/filters');

        curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
        curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
        curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
        curl_setopt($ch, CURLOPT_IPRESOLVE, CURL_IPRESOLVE_V4);
        curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($data));

        $body = curl_exec($ch);
        $info = curl_getinfo($ch);

        curl_close($ch);

        if ( ! empty($info['http_code']) && $info['http_code'] == 200) {
            return json_decode($body, TRUE);
        }
    }


    $body_request = [
        'api_key'       => 'YOUR_API_KEY',
        'date_ranges'   => '01.01.2023 - 31.12.2023',
        'status'        => 'active',
        'list_type'     => 'black',
        'search'        => '84b593db13ccd6acf79ec7287d5da586',
        'per_page'      => 10,
        'page'          => 1
    ];


    $api_request = api_request($body_request);
    if ( ! empty($api_request['status'])) {
        echo '<pre>';
        print_r($api_request);
        echo '</pre>';
    }

Create filter list

Request URL

Parameter Data type Required Description
api_key String Yes Unique API key for request authentication.
name String Yes Filter name (3–32 characters).
list_type String Yes List type: white — whitelist, black — blacklist.
list_ips Array No List of IP addresses for filtering (max 5000 unique).
list_agents Array No List of User-Agent values for filtering (max 5000 unique).
list_providers Array No List of ISPs for filtering (max 5000 unique).
list_referers Array No List of Referer header values for filtering (max 5000 unique).
Parameter Data type Description
status String Indicates whether the request was successful ("success") or resulted in an error ("error").
msg String Error message or additional information about the request.
code Number Response code, for example 200 for a successful request.
filter_id Number Unique filter ID.
label String System filter ID.

<?php


    function api_request($data = [])
    {
        
        $ch = curl_init('https://cloaking.house/api/filters/create');

        curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
        curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
        curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
        curl_setopt($ch, CURLOPT_IPRESOLVE, CURL_IPRESOLVE_V4);
        curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($data));

        $body = curl_exec($ch);
        $info = curl_getinfo($ch);

        curl_close($ch);

        if ( ! empty($info['http_code']) && $info['http_code'] == 200) {
            return json_decode($body, TRUE);
        }
    }


    $body_request = [
        'api_key'   => 'YOUR_API_KEY',
        'name'      => 'Test filter',
        'list_type' => 'black',
        'list_ips'  => [
            '14.215.163.132', 
            '103.145.72.0', 
            '103.142.100.0', 
            '198.11.149.0'
        ],
        'list_agents' => [
            'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/110.0.0.0 Safari/537.36 OPR/96.0.0.0'
        ],
        'list_providers' => [
            'Google CWB private VPN P1P',
            'Google CWB private VPN P2P',
            'Google CWB private VPN P3P',
            'Google CWB private VPN P4P'
        ],
        'list_referers' => [
            'https://example.com/*',
            'https://test.com/*',
            'https://*.example.com/*',
            'https://*.test.com/*'
        ]
    ];


    $api_request = api_request($body_request);
    if ( ! empty($api_request['status'])) {
        echo '<pre>';
        print_r($api_request);
        echo '</pre>';
    }

Update filter list

Request URL

Parameter Data type Required Description
api_key String Yes Unique API key for request authentication.
filter_id Number Yes Unique filter ID.
name String Yes Filter name (3–32 characters).
list_ips Array No List of IP addresses for filtering (max 5000 unique).
list_agents Array No List of User-Agent values for filtering (max 5000 unique).
list_providers Array No List of ISPs for filtering (max 5000 unique).
list_referers Array No List of Referer header values for filtering (max 5000 unique).
Parameter Data type Description
status String Indicates whether the request was successful ("success") or resulted in an error ("error").
msg String Error message or additional information about the request.
code Number Response code, for example 200 for a successful request.
filter_id Number Unique filter ID.
label String System filter ID.

<?php


    function api_request($data = [])
    {
        $ch = curl_init('https://cloaking.house/api/filters/update');

        curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
        curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
        curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
        curl_setopt($ch, CURLOPT_IPRESOLVE, CURL_IPRESOLVE_V4);
        curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($data));

        $body = curl_exec($ch);
        $info = curl_getinfo($ch);

        curl_close($ch);

        if ( ! empty($info['http_code']) && $info['http_code'] == 200) {
            return json_decode($body, TRUE);
        }
    }


    $body_request = [
        'api_key'   => 'YOUR_API_KEY',
        'filter_id' => 1,
        'name'      => 'Test filter',
        'list_ips'  => [
            '14.215.163.132', 
            '103.145.72.0', 
            '103.142.100.0', 
            '198.11.149.0'
        ],
        'list_agents' => [
            'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/110.0.0.0 Safari/537.36 OPR/96.0.0.0'
        ],
        'list_providers' => [
            'Google CWB private VPN P1P',
            'Google CWB private VPN P2P',
            'Google CWB private VPN P3P',
            'Google CWB private VPN P4P'
        ],
        'list_referers' => [
            'https://example.com/*',
            'https://test.com/*',
            'https://*.example.com/*',
            'https://*.test.com/*'
        ]
    ];


    $api_request = api_request($body_request);
    if ( ! empty($api_request['status'])) {
        echo '<pre>';
        print_r($api_request);
        echo '</pre>';
    }

Get filter list details

Request URL

Parameter Data type Required Description
api_key String Yes Unique API key for request authentication.
filter_id Number Yes Unique filter ID.
Parameter Data type Description
status String Indicates whether the request was successful ("success") or resulted in an error ("error").
msg String Error message or additional information about the request.
code Number Response code, for example 200 for a successful request.
data Array Array with filter list details.
└─ filter_id Number Unique filter ID.
└─ name String Filter name.
└─ label String System filter ID.
└─ status String Filter status: "active" or "deleted".
└─ list_type String List type: white — whitelist, black — blacklist.
└─ date_created String Filter creation date (YYYY-MM-DD).
└─ time_created Number Filter creation time in Unix format.
└─ count_ips Number Number of IPs in the filter.
└─ count_agents Number Number of User-Agents in the filter.
└─ count_providers Number Number of ISPs in the filter.
└─ list_ips Array List of IP addresses.
└─ list_agents Array List of User-Agent values.
└─ list_providers Array List of ISPs.
└─ list_referers Array List of Referer header values associated with the filter.

<?php


    function api_request($data = [])
    {
        $ch = curl_init('https://cloaking.house/api/filters/details');

        curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
        curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
        curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
        curl_setopt($ch, CURLOPT_IPRESOLVE, CURL_IPRESOLVE_V4);
        curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($data));

        $body = curl_exec($ch);
        $info = curl_getinfo($ch);

        curl_close($ch);

        if ( ! empty($info['http_code']) && $info['http_code'] == 200) {
            return json_decode($body, TRUE);
        }
    }


    $body_request = [
        'api_key'   => 'YOUR_API_KEY',
        'filter_id' => 1
    ];


    $api_request = api_request($body_request);
    if ( ! empty($api_request['status'])) {
        echo '<pre>';
        print_r($api_request);
        echo '</pre>';
    }

Delete filter list

Request URL

Parameter Data type Required Description
api_key String Yes Unique API key for request authentication.
filter_id Number Yes Unique filter ID.
Parameter Data type Description
status String Indicates whether the request was successful ("success") or resulted in an error ("error").
msg String Error message or additional information about the request.
code Number Response code, for example 200 for a successful request.
filter_id Number Unique filter ID.
label String System filter ID.

<?php


    function api_request($data = [])
    {
        $ch = curl_init('https://cloaking.house/api/filters/delete');

        curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
        curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
        curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
        curl_setopt($ch, CURLOPT_IPRESOLVE, CURL_IPRESOLVE_V4);
        curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($data));

        $body = curl_exec($ch);
        $info = curl_getinfo($ch);

        curl_close($ch);

        if ( ! empty($info['http_code']) && $info['http_code'] == 200) {
            return json_decode($body, TRUE);
        }
    }


    $body_request = [
        'api_key'   => 'YOUR_API_KEY',
        'filter_id' => 1
    ];


    $api_request = api_request($body_request);
    if ( ! empty($api_request['status'])) {
        echo '<pre>';
        print_r($api_request);
        echo '</pre>';
    }

Restore filter list

Request URL

Parameter Data type Required Description
api_key String Yes Unique API key for request authentication.
filter_id Number Yes Unique filter ID.
Parameter Data type Description
status String Indicates whether the request was successful ("success") or resulted in an error ("error").
msg String Error message or additional information about the request.
code Number Response code, for example 200 for a successful request.
filter_id Number Unique filter ID.
label String System filter ID.

<?php


    function api_request($data = [])
    {
        $ch = curl_init('https://cloaking.house/api/filters/restore');

        curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
        curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
        curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
        curl_setopt($ch, CURLOPT_IPRESOLVE, CURL_IPRESOLVE_V4);
        curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($data));

        $body = curl_exec($ch);
        $info = curl_getinfo($ch);

        curl_close($ch);

        if ( ! empty($info['http_code']) && $info['http_code'] == 200) {
            return json_decode($body, TRUE);
        }
    }


    $body_request = [
        'api_key'   => 'YOUR_API_KEY',
        'filter_id' => 1
    ];


    $api_request = api_request($body_request);
    if ( ! empty($api_request['status'])) {
        echo '<pre>';
        print_r($api_request);
        echo '</pre>';
    }

Get list of domains

Request URL

Parameter Data type Required Description
api_key String Yes Unique API key for request authentication.
date_ranges String No Date range in format DD.MM.YYYY - DD.MM.YYYY.
status String No Current domain status.
search String No Search string for domain name or attributes.
per_page Number No Number of records per page (10 to 200). Default: 10.
page Number No Page number starting from 1. Default: 1.
Parameter Data type Description
status String Indicates whether the request was successful ("success") or resulted in an error ("error").
msg String Error message or additional information about the request.
code Number Response code, for example 200 for a successful request.
total Number Number of domains matching the query.
per_page Number Number of records per page.
page Number Current page number.
data Array Array with domain data.
<?php


    function api_request($data = [])
    {
        $ch = curl_init('https://cloaking.house/api/domains');

        curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
        curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
        curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
        curl_setopt($ch, CURLOPT_IPRESOLVE, CURL_IPRESOLVE_V4);
        curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($data));

        $body = curl_exec($ch);
        $info = curl_getinfo($ch);

        curl_close($ch);

        if ( ! empty($info['http_code']) && $info['http_code'] == 200) {
            return json_decode($body, TRUE);
        }
    }


    $body_request = [
        'api_key'       => 'YOUR_API_KEY',
        'date_ranges'   => '01.01.2023 - 31.12.2023',
        'status'        => 'connected',
        'search'        => 'domain.com',
        'per_page'      => 10,
        'page'          => 1
    ];


    $api_request = api_request($body_request);
    if ( ! empty($api_request['status'])) {
        echo '<pre>';
        print_r($api_request);
        echo '</pre>';
    }

Bind domain

Request URL

Parameter Data type Required Description
api_key String Yes Unique API key for request authentication.
host_name String Yes Full domain name for binding (e.g. example.com).
Parameter Data type Description
status String Indicates whether the request was successful ("success") or resulted in an error ("error").
msg String Error message or additional information about the request.
code Number Response code, for example 200 for a successful request.
domain_id Number Unique domain ID.
host_name String Bound domain URL (e.g. https://example.com).
dns_servers Array List of DNS servers.
<?php


    function api_request($data = [])
    {
        $ch = curl_init('https://cloaking.house/api/domains/bind');

        curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
        curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
        curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
        curl_setopt($ch, CURLOPT_IPRESOLVE, CURL_IPRESOLVE_V4);
        curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($data));

        $body = curl_exec($ch);
        $info = curl_getinfo($ch);

        curl_close($ch);

        if ( ! empty($info['http_code']) && $info['http_code'] == 200) {
            return json_decode($body, TRUE);
        }
    }


    $body_request = [
        'api_key'   => 'YOUR_API_KEY',
        'host_name' => 'domain.com'
    ];


    $api_request = api_request($body_request);
    if ( ! empty($api_request['status'])) {
        echo '<pre>';
        print_r($api_request);
        echo '</pre>';
    }

Get domain details

Request URL

Parameter Data type Required Description
api_key String Yes Unique API key for request authentication.
domain_id Number Yes Unique domain ID.
Parameter Data type Description
status String Indicates whether the request was successful ("success") or resulted in an error ("error").
msg String Error message or additional information about the request.
code Number Response code, for example 200 for a successful request.
data Array Array with domain details.
└─ domain_id Number Unique domain ID.
└─ host_name String Domain URL (e.g. https://example.com).
└─ status String Domain status: connected, waiting, not_connected, infected, deleted.
└─ time_created Number Domain creation time in Unix format.
└─ date_created String Domain binding date in YYYY-MM-DD format.
└─ dns_servers Array List of DNS servers.
<?php


    function api_request($data = [])
    {
        $ch = curl_init('https://cloaking.house/api/domains/details');

        curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
        curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
        curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
        curl_setopt($ch, CURLOPT_IPRESOLVE, CURL_IPRESOLVE_V4);
        curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($data));

        $body = curl_exec($ch);
        $info = curl_getinfo($ch);

        curl_close($ch);

        if ( ! empty($info['http_code']) && $info['http_code'] == 200) {
            return json_decode($body, TRUE);
        }
    }


    $body_request = [
        'api_key'   => 'YOUR_API_KEY',
        'domain_id' => 1
    ];


    $api_request = api_request($body_request);
    if ( ! empty($api_request['status'])) {
        echo '<pre>';
        print_r($api_request);
        echo '</pre>';
    }

Delete domain

Request URL

Parameter Data type Required Description
api_key String Yes Unique API key for request authentication.
domain_id Number Yes Unique domain ID.
Parameter Data type Description
status String Indicates whether the request was successful ("success") or resulted in an error ("error").
msg String Error message or additional information about the request.
code Number Response code, for example 200 for a successful request.
domain_id Number Unique domain ID.
host_name String Bound domain URL (e.g. https://example.com).
<?php


    function api_request($data = [])
    {
        $ch = curl_init('https://cloaking.house/api/domains/delete');

        curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
        curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
        curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
        curl_setopt($ch, CURLOPT_IPRESOLVE, CURL_IPRESOLVE_V4);
        curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($data));

        $body = curl_exec($ch);
        $info = curl_getinfo($ch);

        curl_close($ch);

        if ( ! empty($info['http_code']) && $info['http_code'] == 200) {
            return json_decode($body, TRUE);
        }
    }


    $body_request = [
        'api_key'   => 'YOUR_API_KEY',
        'domain_id' => 1
    ];


    $api_request = api_request($body_request);
    if ( ! empty($api_request['status'])) {
        echo '<pre>';
        print_r($api_request);
        echo '</pre>';
    }

Restore domain

Request URL

Parameter Data type Required Description
api_key String Yes Unique API key for request authentication.
domain_id Number Yes Unique domain ID.
Parameter Data type Description
status String Indicates whether the request was successful ("success") or resulted in an error ("error").
msg String Error message or additional information about the request.
code Number Response code, for example 200 for a successful request.
domain_id Number Unique domain ID.
host_name String Bound domain URL (e.g. https://example.com).
<?php


    function api_request($data = [])
    {
        $ch = curl_init('https://cloaking.house/api/domains/restore');

        curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
        curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
        curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
        curl_setopt($ch, CURLOPT_IPRESOLVE, CURL_IPRESOLVE_V4);
        curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($data));

        $body = curl_exec($ch);
        $info = curl_getinfo($ch);

        curl_close($ch);

        if ( ! empty($info['http_code']) && $info['http_code'] == 200) {
            return json_decode($body, TRUE);
        }
    }


    $body_request = [
        'api_key'   => 'YOUR_API_KEY',
        'domain_id' => 1
    ];


    $api_request = api_request($body_request);
    if ( ! empty($api_request['status'])) {
        echo '<pre>';
        print_r($api_request);
        echo '</pre>';
    }

Get domain status

Request URL

Parameter Data type Required Description
api_key String Yes Unique API key for request authentication.
domain_id Number Yes Unique domain ID.
Parameter Data type Description
status String Indicates whether the request was successful ("success") or resulted in an error ("error").
msg String Error message or additional information about the request.
code Number Response code, for example 200 for a successful request.
domain_id Number Unique domain ID.
host_name String Bound domain URL (e.g. https://example.com).
status String Current domain status.
<?php


    function api_request($data = [])
    {
        $ch = curl_init('https://cloaking.house/api/domains/status');

        curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
        curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
        curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
        curl_setopt($ch, CURLOPT_IPRESOLVE, CURL_IPRESOLVE_V4);
        curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($data));

        $body = curl_exec($ch);
        $info = curl_getinfo($ch);

        curl_close($ch);

        if ( ! empty($info['http_code']) && $info['http_code'] == 200) {
            return json_decode($body, TRUE);
        }
    }


    $body_request = [
        'api_key'   => 'YOUR_API_KEY',
        'domain_id' => 1
    ];


    $api_request = api_request($body_request);
    if ( ! empty($api_request['status'])) {
        echo '<pre>';
        print_r($api_request);
        echo '</pre>';
    }

Get list of browsers

Request URL

Parameter Data type Required Description
api_key String Yes Unique API key for request authentication.
Parameter Data type Description
status String Indicates whether the request was successful ("success") or resulted in an error ("error").
msg String Error message or additional information about the request.
code Number Response code, for example 200 for a successful request.
data Array Array of available browsers.
└─ browser_id Number Unique browser ID.
└─ name String Browser name (e.g. "Google Chrome").
<?php


    function api_request($data = [])
    {
        $ch = curl_init('https://cloaking.house/api/browsers');

        curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
        curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
        curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
        curl_setopt($ch, CURLOPT_IPRESOLVE, CURL_IPRESOLVE_V4);
        curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($data));

        $body = curl_exec($ch);
        $info = curl_getinfo($ch);

        curl_close($ch);

        if ( ! empty($info['http_code']) && $info['http_code'] == 200) {
            return json_decode($body, TRUE);
        }
    }


    $body_request = ['api_key' => 'YOUR_API_KEY'];


    $api_request = api_request($body_request);
    if ( ! empty($api_request['status'])) {
        echo '<pre>';
        print_r($api_request);
        echo '</pre>';
    }

Get list of devices

Request URL

Parameter Data type Required Description
api_key String Yes Unique API key for request authentication.
Parameter Data type Description
status String Indicates whether the request was successful ("success") or resulted in an error ("error").
msg String Error message or additional information about the request.
code Number Response code, for example 200 for a successful request.
data Array Array of device types.
└─ device_id Number Unique device type ID.
└─ name String Device type name (e.g. "Desktop").
<?php


    function api_request($data = [])
    {
        $ch = curl_init('https://cloaking.house/api/devices');

        curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
        curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
        curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
        curl_setopt($ch, CURLOPT_IPRESOLVE, CURL_IPRESOLVE_V4);
        curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($data));

        $body = curl_exec($ch);
        $info = curl_getinfo($ch);

        curl_close($ch);

        if ( ! empty($info['http_code']) && $info['http_code'] == 200) {
            return json_decode($body, TRUE);
        }
    }


    $body_request = ['api_key' => 'YOUR_API_KEY'];


    $api_request = api_request($body_request);
    if ( ! empty($api_request['status'])) {
        echo '<pre>';
        print_r($api_request);
        echo '</pre>';
    }

Get list of countries

Request URL

Parameter Data type Required Description
api_key String Yes Unique API key for request authentication.
Parameter Data type Description
status String Indicates whether the request was successful ("success") or resulted in an error ("error").
msg String Error message or additional information about the request.
code Number Response code, for example 200 for a successful request.
data Array Array of available countries.
└─ country_id Number Unique country ID.
└─ name String Country name in English.
└─ iso_code String ISO country code (e.g. "US", "FR").
<?php


    function api_request($data = [])
    {
        $ch = curl_init('https://cloaking.house/api/countries');

        curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
        curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
        curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
        curl_setopt($ch, CURLOPT_IPRESOLVE, CURL_IPRESOLVE_V4);
        curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($data));

        $body = curl_exec($ch);
        $info = curl_getinfo($ch);

        curl_close($ch);

        if ( ! empty($info['http_code']) && $info['http_code'] == 200) {
            return json_decode($body, TRUE);
        }
    }


    $body_request = ['api_key' => 'YOUR_API_KEY'];


    $api_request = api_request($body_request);
    if ( ! empty($api_request['status'])) {
        echo '<pre>';
        print_r($api_request);
        echo '</pre>';
    }

Get list of operating systems

Request URL

Parameter Data type Required Description
api_key String Yes Unique API key for request authentication.
Parameter Data type Description
status String Indicates whether the request was successful ("success") or resulted in an error ("error").
msg String Error message or additional information about the request.
code Number Response code, for example 200 for a successful request.
data Array Array of available operating systems.
└─ os_id Number Unique OS ID.
└─ name String Operating system name (e.g. "Windows").
<?php


    function api_request($data = [])
    {
        $ch = curl_init('https://cloaking.house/api/operating_systems');

        curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
        curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
        curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
        curl_setopt($ch, CURLOPT_IPRESOLVE, CURL_IPRESOLVE_V4);
        curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($data));

        $body = curl_exec($ch);
        $info = curl_getinfo($ch);

        curl_close($ch);

        if ( ! empty($info['http_code']) && $info['http_code'] == 200) {
            return json_decode($body, TRUE);
        }
    }


    $body_request = ['api_key' => 'YOUR_API_KEY'];


    $api_request = api_request($body_request);
    if ( ! empty($api_request['status'])) {
        echo '<pre>';
        print_r($api_request);
        echo '</pre>';
    }

Get list of languages

Request URL

Parameter Data type Required Description
api_key String Yes Unique API key for request authentication.
Parameter Data type Description
status String Indicates whether the request was successful ("success") or resulted in an error ("error").
msg String Error message or additional information about the request.
code Number Response code, for example 200 for a successful request.
data Array Array of available languages.
└─ lang_id Number Unique language ID.
└─ name String Language name in English.
└─ iso_code String ISO language code (e.g. "en", "ru").
<?php


    function api_request($data = [])
    {
        $ch = curl_init('https://cloaking.house/api/languages');

        curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
        curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
        curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
        curl_setopt($ch, CURLOPT_IPRESOLVE, CURL_IPRESOLVE_V4);
        curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($data));

        $body = curl_exec($ch);
        $info = curl_getinfo($ch);

        curl_close($ch);

        if ( ! empty($info['http_code']) && $info['http_code'] == 200) {
            return json_decode($body, TRUE);
        }
    }


    $body_request = ['api_key' => 'YOUR_API_KEY'];


    $api_request = api_request($body_request);
    if ( ! empty($api_request['status'])) {
        echo '<pre>';
        print_r($api_request);
        echo '</pre>';
    }

Get list of timezones

Request URL

Parameter Data type Required Description
api_key String Yes Unique API key for request authentication.
Parameter Data type Description
status String Indicates whether the request was successful ("success") or resulted in an error ("error").
msg String Error message or additional information about the request.
code Number Response code, for example 200 for a successful request.
data Array Array of available operating systems.
└─ zone_id Number Unique timezone ID.
└─ name String Timezone name (city, country).
└─ gmt_offset String GMT offset (e.g. +03:00).
<?php


    function api_request($data = [])
    {
        $ch = curl_init('https://cloaking.house/api/time_zones');

        curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
        curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
        curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
        curl_setopt($ch, CURLOPT_IPRESOLVE, CURL_IPRESOLVE_V4);
        curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($data));

        $body = curl_exec($ch);
        $info = curl_getinfo($ch);

        curl_close($ch);

        if ( ! empty($info['http_code']) && $info['http_code'] == 200) {
            return json_decode($body, TRUE);
        }
    }


    $body_request = ['api_key' => 'YOUR_API_KEY'];


    $api_request = api_request($body_request);
    if ( ! empty($api_request['status'])) {
        echo '<pre>';
        print_r($api_request);
        echo '</pre>';
    }

Get list of connection types

Request URL

Parameter Data type Required Description
api_key String Yes Unique API key for request authentication.
Parameter Data type Description
status String Indicates whether the request was successful ("success") or resulted in an error ("error").
msg String Error message or additional information about the request.
code Number Response code, for example 200 for a successful request.
data Array Array of available operating systems.
└─ connection_id Number Unique connection type ID.
└─ name String Connection type name in English.
<?php


    function api_request($data = [])
    {
        $ch = curl_init('https://cloaking.house/api/connection_types');

        curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
        curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
        curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
        curl_setopt($ch, CURLOPT_IPRESOLVE, CURL_IPRESOLVE_V4);
        curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($data));

        $body = curl_exec($ch);
        $info = curl_getinfo($ch);

        curl_close($ch);

        if ( ! empty($info['http_code']) && $info['http_code'] == 200) {
            return json_decode($body, TRUE);
        }
    }


    $body_request = ['api_key' => 'YOUR_API_KEY'];


    $api_request = api_request($body_request);
    if ( ! empty($api_request['status'])) {
        echo '<pre>';
        print_r($api_request);
        echo '</pre>';
    }

Get statistics

Request URL

Parameter Data type Обязательный Description
api_key String Yes Unique API key for request authentication.
group_by String Yes

Parameter for grouping statistics.

Allowed values: date, hour, day_week, flow, country, city, device, operating_system, browser, brand.
date_ranges String No Date range in format DD.MM.YYYY - DD.MM.YYYY.
filter_countries Array No Array of country IDs for filtering statistics.
filter_statistics Array No Array of flow IDs for filtering statistics.
filter_devices Array No Array of device IDs for filtering statistics.
filter_os Array No Array of OS IDs for filtering statistics.
filter_browsers Array No Array of browser IDs for filtering statistics.
filter_langs Array No Array of language IDs for statistics filtering.
Parameter Data type Description
status String Indicates whether the request was successful ("success") or resulted in an error ("error").
msg String Error message or additional information about the request.
code Number Response code, for example 200 for a successful request.
data Array Array with statistics data.
└─ group_by String Grouping parameter used for statistics (e.g. "date" or "country").
└─ value String Grouping value indicating the category (e.g. date or country).
└─ hosts Number Number of unique users for the selected period.
└─ hits Number Total number of visits for the selected period.
└─ filtered Number Number of filtered requests for the selected period.
└─ ctr Number Click-through rate (CTR) in percent.
<?php


    function api_request($data = [])
    {
        $ch = curl_init('https://cloaking.house/api/statistics');

        curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
        curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
        curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
        curl_setopt($ch, CURLOPT_IPRESOLVE, CURL_IPRESOLVE_V4);
        curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($data));

        $body = curl_exec($ch);
        $info = curl_getinfo($ch);

        curl_close($ch);

        if ( ! empty($info['http_code']) && $info['http_code'] == 200) {
            return json_decode($body, TRUE);
        }
    }


    $body_request = [
        'api_key'           => 'YOUR_API_KEY',
        'group_by'          => 'browser',
        'date_ranges'       => '20.10.2024 - 20.10.2024',
        'filter_countries'  => [107],
        'filter_flows'      => [67988, 13897],
        'filter_devices'    => [2],
        'filter_os'         => [7],
        'filter_browsers'   => [2],
        'filter_langs'      => [1],
    ];


    $api_request = api_request($body_request);
    if ( ! empty($api_request['status'])) {
        echo '<pre>';
        print_r($api_request);
        echo '</pre>';
    }

Get click data

Request URL

Parameter Data type Required Description
api_key String Yes Unique API key for request authentication.
date_ranges String No Date range in format DD.MM.YYYY - DD.MM.YYYY.
filter_countries Array No Array of country IDs for retrieving click data.
filter_flows Array No Array of flow IDs for retrieving click data.
filter_devices Array No Array of device IDs for retrieving click data.
filter_os Array No Array of OS IDs for retrieving click data.
filter_browsers Array No Array of browser IDs for retrieving click data.
filter_filters Array No

Array of filter types for click filtering.

Allowed values: success, status, ip_clicks_per_day, clicks_before_filtering, bot, ip_v6, referer, isp, country, device, os, browser, black_ip, vpn_proxy, black_list, white_list.
filter_langs Array No Array of language IDs for click filtering.
filter_pages Array No Array of page types. Allowed values: "white" or "offer".
per_page Number No Number of records per page (10 to 200). Default: 10.
page Number No Page number starting from 1. Default: 1.
Parameter Data type Description
status String Indicates whether the request was successful ("success") or resulted in an error ("error").
msg String Error message or additional information about the request.
code Number Response code, for example 200 for a successful request.
data Array Array of click data, each element contains information about a click.
└─ click_id String Unique click identifier.
└─ flow_id Number Flow ID the click belongs to.
└─ time_created Number Click creation time in Unix format..
└─ date_created String Click creation date in YYYY-MM-DD format.
└─ country_code String ISO country code (e.g. "US", "FR").
└─ ip_address String User IP address.
└─ isp String Internet service provider name.
└─ referer String Referrer URL.
└─ user_agent String Browser User Agent.
└─ device String Device type (e.g. Desktop, Mobile).
└─ brand String Device brand.
└─ os String Operating system.
└─ browser String User browser.
└─ filter_type String Filter type applied to the click.
└─ filter_page String Filter page type (white or offer).
<?php


    function api_request($data = [])
    {
        $ch = curl_init('https://cloaking.house/api/clicks');

        curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
        curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
        curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
        curl_setopt($ch, CURLOPT_IPRESOLVE, CURL_IPRESOLVE_V4);
        curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($data));

        $body = curl_exec($ch);
        $info = curl_getinfo($ch);

        curl_close($ch);

        if ( ! empty($info['http_code']) && $info['http_code'] == 200) {
            return json_decode($body, TRUE);
        }
    }


    $body_request = [
        'api_key'           => 'YOUR_API_KEY',
        'date_ranges'       => '20.10.2024 - 20.10.2024',
        'filter_countries'  => [107],
        'filter_flows'      => [67988, 13897],
        'filter_devices'    => [2],
        'filter_os'         => [6],
        'filter_browsers'   => [2],
        'filter_langs'      => [1],
        'filter_filters'    => ['browser'],
        'filter_pages'      => ['offer'],
        'per_page'          => 100,
        'page'              => 1
    ];


    $api_request = api_request($body_request);
    if ( ! empty($api_request['status'])) {
        echo '<pre>';
        print_r($api_request);
        echo '</pre>';
    }

Transfer funds

Request URL

Parameter Data type Required Description
api_key String Yes Unique API key for request authentication.
amount Number Yes Transfer amount (minimum 10 USD).
email String Yes Recipient email address. Must be valid.
Parameter Data type Description
status String Indicates whether the request was successful ("success") or resulted in an error ("error").
msg String Error message or additional information about the request.
code Number Response code, for example 200 for a successful request.
transaction_number String Unique transaction ID.
<?php


    function api_request($data = [])
    {
        $ch = curl_init('https://cloaking.house/api/accounts/transfer_funds');

        curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
        curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
        curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
        curl_setopt($ch, CURLOPT_IPRESOLVE, CURL_IPRESOLVE_V4);
        curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($data));

        $body = curl_exec($ch);
        $info = curl_getinfo($ch);

        curl_close($ch);

        if ( ! empty($info['http_code']) && $info['http_code'] == 200) {
            return json_decode($body, TRUE);
        }
    }


    $body_request = [
        'api_key'   => 'YOUR_API_KEY',
        'email'     => '[email protected]',
        'amount'    => 10
    ];


    $api_request = api_request($body_request);
    if ( ! empty($api_request['status'])) {
        echo '<pre>';
        print_r($api_request);
        echo '</pre>';
    }

Get account balance

Request URL

Parameter Data type Required Description
api_key String Yes Unique API key for request authentication.
Parameter Data type Description
status String Indicates whether the request was successful ("success") or resulted in an error ("error").
msg String Error message or additional information about the request.
code Number Response code, for example 200 for a successful request.
balance Number Current account balance.
<?php


    function api_request($data = [])
    {
        $ch = curl_init('https://cloaking.house/api/accounts/balance');

        curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
        curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
        curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
        curl_setopt($ch, CURLOPT_IPRESOLVE, CURL_IPRESOLVE_V4);
        curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($data));

        $body = curl_exec($ch);
        $info = curl_getinfo($ch);

        curl_close($ch);

        if ( ! empty($info['http_code']) && $info['http_code'] == 200) {
            return json_decode($body, TRUE);
        }
    }


    $body_request = ['api_key' => 'YOUR_API_KEY'];


    $api_request = api_request($body_request);
    if ( ! empty($api_request['status'])) {
        echo '<pre>';
        print_r($api_request);
        echo '</pre>';
    }