Residential Proxies (RP)

This page describes how to add and remove balance for residential Proxies to your subusers, aswell as view their usage history and reset their auth_key. Residential Proxies are billed per GB.

Residential Proxies are the most common type of proxy. They are IP addresses that are assigned to homeowners by their local Internet Service Provider (ISP). Residential Proxies are billed per GB and can be used for a variety of purposes, including web scraping, data mining, and ad verification.

POST/v2/reseller/sub_users/give_rp_balance

Add balance

This endpoint allows you to add balance in MB (megabytes) to a subuser.

Required Body "Raw" Items

Name
username
Type
string
Description
The username of the customer.
Name
balance
Type
number
Description
The amount of MB (megabytes) you want to give to the customer.

Returned Properties

Name
data
Type
object
Description
The account data of the subuser.
Name
message
Type
string
Description
The message of the response.
Name
status
Type
number
Description
The status code of the response.
Name
timestamp
Type
number
Description
The timestamp in milliseconds of the response.

Request

POST

/v2/reseller/sub_users/give_rp_balance

  curl --location --request POST 'https://api.earn.fm/v2/reseller/sub_users/give_rp_balance' \
    --header 'X-API-KEY: [API KEY]' \
    --data '{"username":"earnfm_customer","balance": 10}'

Response

{
"message": "",
"timestamp": 1710521742499,
"data": {
"email": "customer@earn.fm",
"username": "earnfm_customer",
"created_at": "2024-03-15T16:55:42.493283Z",
"updated_at": "2024-03-15T16:55:42.493283Z",
"products": {
    "residential": {
        "balance": 10,
        "proxy_key": "o3ES790NowLodxOuFNup"
    },
    "sharedDataCenter": {
        "balance": 0,
        "proxy_key": "NudAMGhkISx6skP65dQx"
    },
    "dataCenterIPV6": {
        "proxy_key": "wvmL818vcseyNBIx0P3d",
        "threadCap": 0,
        "expiresAt": "0001-01-01T00:00:00Z",
        "expiresInHours": -2562047.788015,
        "balance": 0
    },
    "mobile": {
        "balance": 0,
        "proxy_key": "vxHEmIRGWWoiegbscLQV"
    },
    "dataCenter": {
        "proxy_key": "oZraZtsV2Lz7CCmVl4cf",
        "threadCap": 0,
        "expiresAt": "0001-01-01T00:00:00Z",
        "expiresInHours": -2562047.788015,
        "balance": 0
    }
}
},
"status": 201
}

POST/v2/reseller/sub_users/take_rp_balance

Remove balance

This endpoint allows you to remove balance in MB (megabytes) to a customer.

Required Body "Raw" Items

Name
username
Type
string
Description
The username of the customer.
Name
balance
Type
number
Description
The amount of MB (megabytes) you want to remove from the customer.

Returned Properties

Name
data
Type
object
Description
The account data of the subuser.
Name
message
Type
string
Description
The message of the response.
Name
status
Type
number
Description
The status code of the response.
Name
timestamp
Type
number
Description
The timestamp in milliseconds of the response.

Request

POST

/v2/reseller/sub_users/take_rp_balance

  curl --location --request POST 'https://api.earn.fm/v2/reseller/sub_users/take_rp_balance' \
    --header 'X-API-KEY: [API KEY]' \
    --data '{"username":"earnfm_customer","balance": 10}'

Response

{
"message": "",
"timestamp": 1710521742499,
"data": {
"email": "customer@earn.fm",
"username": "earnfm_customer",
"created_at": "2024-03-15T16:55:42.493283Z",
"updated_at": "2024-03-15T16:55:42.493283Z",
"products": {
    "residential": {
        "balance": 10,
        "proxy_key": "o3ES790NowLodxOuFNup"
    },
    "sharedDataCenter": {
        "balance": 0,
        "proxy_key": "NudAMGhkISx6skP65dQx"
    },
    "dataCenterIPV6": {
        "proxy_key": "wvmL818vcseyNBIx0P3d",
        "threadCap": 0,
        "expiresAt": "0001-01-01T00:00:00Z",
        "expiresInHours": -2562047.788015,
        "balance": 0
    },
    "mobile": {
        "balance": 0,
        "proxy_key": "vxHEmIRGWWoiegbscLQV"
    },
    "dataCenter": {
        "proxy_key": "oZraZtsV2Lz7CCmVl4cf",
        "threadCap": 0,
        "expiresAt": "0001-01-01T00:00:00Z",
        "expiresInHours": -2562047.788015,
        "balance": 0
    }
}
},
"status": 201
}

POST/v2/reseller/sub_users/reset_rp_auth_key

Reset proxy authkey

This endpoint allows you to reset the proxy password of a subuser.

Required Body "Raw" Items

Name
username
Type
string
Description
The username of the customer.

Returned Properties

Name
data
Type
object
Description
The account data of the subuser.
Name
message
Type
string
Description
The message of the response.
Name
status
Type
number
Description
The status code of the response.
Name
timestamp
Type
number
Description
The timestamp in milliseconds of the response.

Request

POST

/v2/reseller/sub_users/reset_rp_auth_key

  curl --location --request POST 'https://api.earn.fm/v2/reseller/sub_users/reset_rp_auth_key' \
    --header 'X-API-KEY: [API KEY]' \
    --data '{"username":"earnfm_customer"}'

Response

{
"message": "",
"timestamp": 1710521742499,
"data": {
"email": "customer@earn.fm",
"username": "earnfm_customer",
"created_at": "2024-03-15T16:55:42.493283Z",
"updated_at": "2024-03-15T16:55:42.493283Z",
"products": {
    "residential": {
        "balance": 10,
        "proxy_key": "o3ES790NowLodxOuFNup"
    },
    "sharedDataCenter": {
        "balance": 0,
        "proxy_key": "NudAMGhkISx6skP65dQx"
    },
    "dataCenterIPV6": {
        "proxy_key": "wvmL818vcseyNBIx0P3d",
        "threadCap": 0,
        "expiresAt": "0001-01-01T00:00:00Z",
        "expiresInHours": -2562047.788015,
        "balance": 0
    },
    "mobile": {
        "balance": 0,
        "proxy_key": "vxHEmIRGWWoiegbscLQV"
    },
    "dataCenter": {
        "proxy_key": "oZraZtsV2Lz7CCmVl4cf",
        "threadCap": 0,
        "expiresAt": "0001-01-01T00:00:00Z",
        "expiresInHours": -2562047.788015,
        "balance": 0
    }
}
},
"status": 201
}