PRM4U API

https://prm4u.com/api
Admin
PRM4U API is a platform for submitting and tracking orders for social media services including...
Tokens:4,216
Snippets:26
Trust Score:8.7
Update:5 months ago
Show doc for...
Tokens:
Raw
### Get Order Status

Source: https://prm4u.com/api

Retrieve the status of a single order using its ID. Provides details on charge, start count, status, and remaining quantity.

```json
{
    "charge": "0.27819",
    "start_count": "3572",
    "status": "Partial",
    "remains": "157",
    "currency": "USD"
}
      
```

--------------------------------

### Get Multiple Order Statuses

Source: https://prm4u.com/api

Retrieve the status for multiple orders by providing a comma-separated list of order IDs. Handles individual order statuses and errors.

```json
{
    "1": {
        "charge": "0.27819",
        "start_count": "3572",
        "status": "Partial",
        "remains": "157",
        "currency": "USD"
    },
    "10": {
        "error": "Incorrect order ID"
    },
    "100": {
        "charge": "1.44219",
        "start_count": "234",
        "status": "In progress",
        "remains": "10",
        "currency": "USD"
    }
}
      
```

--------------------------------

### Get refill status

Source: https://prm4u.com/api

Retrieves the status of a specific refill using its refill ID.

```APIDOC
## Get refill status

### Description
Retrieves the status of a specific refill using its refill ID.

### Parameters
#### Query Parameters
- **key** (string) - Required - Your API key
- **action** (string) - Required - refill_status
- **refill** (string) - Required - Refill ID

### Response
#### Success Response (200)
- **status** (string) - The status of the refill (e.g., "Completed")

### Response Example
```json
{
    "status": "Completed"
}
```
```

--------------------------------

### Get multiple refill status

Source: https://prm4u.com/api

Retrieves the status for multiple refills using their refill IDs. Supports up to 100 refill IDs.

```APIDOC
## Get multiple refill status

### Description
Retrieves the status for multiple refills using their refill IDs. Supports up to 100 refill IDs.

### Parameters
#### Query Parameters
- **key** (string) - Required - Your API key
- **action** (string) - Required - refill_status
- **refills** (string) - Required - Refill IDs (separated by a comma, up to 100 IDs)

### Response
#### Success Response (200)
- **refill** (integer) - The refill ID
- **status** (string or object) - The status of the refill or an error object if not found

### Response Example
```json
[
    {
        "refill": 1,
        "status": "Completed"
    },
    {
        "refill": 2,
        "status": "Rejected"
    },
    {
        "refill": 3,
        "status": {
            "error": "Refill not found"
        }
    }
]
```
```

--------------------------------

### List Services

Source: https://prm4u.com/api

Retrieve a list of available services with their details. This is useful for understanding what services are offered and their parameters.

```json
[
    {
        "service": 1,
        "name": "Followers",
        "type": "Default",
        "category": "First Category",
        "rate": "0.90",
        "min": "50",
        "max": "10000",
        "refill": true,
        "cancel": true
    },
    {
        "service": 2,
        "name": "Comments",
        "type": "Custom Comments",
        "category": "Second Category",
        "rate": "8",
        "min": "10",
        "max": "1500",
        "refill": false,
        "cancel": true
    }
]
      
```

--------------------------------

### Add Order - Default

Source: https://prm4u.com/api

Submit a new order for a service. Requires service ID, link, and quantity. Optional parameters include runs and interval for delivery.

```json
{
    "order": 23501
}
      
```

--------------------------------

### Service List

Source: https://prm4u.com/api

Retrieve a list of available services with their details.

```APIDOC
## POST /api/v2

### Description
Retrieves a list of available services.

### Method
POST

### Endpoint
https://prm4u.com/api/v2

### Parameters
#### Query Parameters
- **key** (string) - Required - Your API key
- **action** (string) - Required - Must be 'services'

### Response
#### Success Response (200)
- **service** (integer) - Service ID
- **name** (string) - Name of the service
- **type** (string) - Type of the service
- **category** (string) - Category of the service
- **rate** (string) - Cost per unit
- **min** (string) - Minimum order quantity
- **max** (string) - Maximum order quantity
- **refill** (boolean) - Whether refill is available
- **cancel** (boolean) - Whether cancellation is available

### Response Example
```json
[
    {
        "service": 1,
        "name": "Followers",
        "type": "Default",
        "category": "First Category",
        "rate": "0.90",
        "min": "50",
        "max": "10000",
        "refill": true,
        "cancel": true
    },
    {
        "service": 2,
        "name": "Comments",
        "type": "Custom Comments",
        "category": "Second Category",
        "rate": "8",
        "min": "10",
        "max": "1500",
        "refill": false,
        "cancel": true
    }
]
```
```

--------------------------------

### User balance

Source: https://prm4u.com/api

Retrieves the current user balance and currency.

```APIDOC
## User balance

### Description
Retrieves the current user balance and currency.

### Parameters
#### Query Parameters
- **key** (string) - Required - Your API key
- **action** (string) - Required - balance

### Response
#### Success Response (200)
- **balance** (string) - The current account balance
- **currency** (string) - The currency of the balance (e.g., "USD")

### Response Example
```json
{
    "balance": "100.84292",
    "currency": "USD"
}
```
```

--------------------------------

### Add Order - Default Package

Source: https://prm4u.com/api

Adds a new order for a default package service.

```APIDOC
## POST /api/v2

### Description
Adds a new order for a default package service.

### Method
POST

### Endpoint
https://prm4u.com/api/v2

### Parameters
#### Query Parameters
- **key** (string) - Required - Your API key
- **action** (string) - Required - Must be 'add'
- **service** (integer) - Required - Service ID
- **link** (string) - Required - Link to the page
- **quantity** (integer) - Required - Needed quantity
- **runs** (integer) - Optional - Runs to deliver
- **interval** (integer) - Optional - Interval in minutes

### Response
#### Success Response (200)
- **order** (integer) - The ID of the newly created order

### Response Example
```json
{
    "order": 23501
}
```
```

--------------------------------

### Create Refill

Source: https://prm4u.com/api

Creates a refill for a completed order.

```APIDOC
## POST /api/v2

### Description
Creates a refill for a completed order.

### Method
POST

### Endpoint
https://prm4u.com/api/v2

### Parameters
#### Query Parameters
- **key** (string) - Required - Your API key
- **action** (string) - Required - Must be 'refill'
- **order** (integer) - Required - Order ID

### Response
#### Success Response (200)
- **refill** (string) - Indicates if the refill was successful (e.g., "1")

### Response Example
```json
{
    "refill": "1"
}
```
```

--------------------------------

### Add Order - Subscriptions

Source: https://prm4u.com/api

Adds a new order for a subscription service.

```APIDOC
## POST /api/v2

### Description
Adds a new order for a subscription service.

### Method
POST

### Endpoint
https://prm4u.com/api/v2

### Parameters
#### Query Parameters
- **key** (string) - Required - Your API key
- **action** (string) - Required - Must be 'add'
- **service** (integer) - Required - Service ID
- **link** (string) - Required - Link to page
- **quantity** (integer) - Required - Needed quantity
- **groups** (string) - Required - Groups list separated by \r\n or \n
### Response
#### Success Response (200)
- **order** (integer) - The ID of the newly created order

### Response Example
```json
{
    "order": 23501
}
```
```

--------------------------------

### Create multiple refill

Source: https://prm4u.com/api

Creates multiple refills for given order IDs. Supports up to 100 order IDs at a time.

```APIDOC
## Create multiple refill

### Description
Creates multiple refills for given order IDs. Supports up to 100 order IDs at a time.

### Parameters
#### Query Parameters
- **key** (string) - Required - Your API key
- **action** (string) - Required - refill
- **orders** (string) - Required - Order IDs (separated by a comma, up to 100 IDs)

### Response
#### Success Response (200)
- **order** (integer) - Description of the order ID
- **refill** (integer or object) - Refill ID or an error object if creation failed

### Response Example
```json
[
    {
        "order": 1,
        "refill": 1
    },
    {
        "order": 2,
        "refill": 2
    },
    {
        "order": 3,
        "refill": {
            "error": "Incorrect order ID"
        }
    }
]
```
```

--------------------------------

### Add Order - Web Traffic

Source: https://prm4u.com/api

Adds a new order for web traffic service.

```APIDOC
## POST /api/v2

### Description
Adds a new order for web traffic service.

### Method
POST

### Endpoint
https://prm4u.com/api/v2

### Parameters
#### Query Parameters
- **key** (string) - Required - Your API key
- **action** (string) - Required - Must be 'add'
- **service** (integer) - Required - Service ID
- **link** (string) - Required - Link to page
- **quantity** (integer) - Required - Needed quantity
- **runs** (integer) - Optional - Runs to deliver
- **interval** (integer) - Optional - Interval in minutes
- **country** (string) - Required - Country code or full country name. Format: "US" or "United States"
- **device** (integer) - Required - Device name. 1 - Desktop, 2 - Mobile (Android), 3 - Mobile (IOS), 4 - Mixed (Mobile), 5 - Mixed (Mobile & Desktop)
- **type_of_traffic** (integer) - Required - 1 - Google Keyword, 2 - Custom Referrer, 3 - Blank Referrer
- **google_keyword** (string) - Required if type_of_traffic = 1
- **referring_url** (string) - Required if type_of_traffic = 2

### Response
#### Success Response (200)
- **order** (integer) - The ID of the newly created order

### Response Example
```json
{
    "order": 23501
}
```
```

--------------------------------

### Create cancel

Source: https://prm4u.com/api

Creates a cancellation for specified order IDs. Supports up to 100 order IDs.

```APIDOC
## Create cancel

### Description
Creates a cancellation for specified order IDs. Supports up to 100 order IDs.

### Parameters
#### Query Parameters
- **key** (string) - Required - Your API key
- **action** (string) - Required - cancel
- **orders** (string) - Required - Order IDs (separated by a comma, up to 100 IDs)

### Response
#### Success Response (200)
- **order** (integer) - The order ID
- **cancel** (integer or object) - Cancellation status or an error object if failed

### Response Example
```json
[
    {
        "order": 9,
        "cancel": {
            "error": "Incorrect order ID"
        }
    },
    {
        "order": 2,
        "cancel": 1
    }
]
```
```

--------------------------------

### Add Order - Custom Comments

Source: https://prm4u.com/api

Adds a new order for custom comments service.

```APIDOC
## POST /api/v2

### Description
Adds a new order for custom comments service.

### Method
POST

### Endpoint
https://prm4u.com/api/v2

### Parameters
#### Query Parameters
- **key** (string) - Required - Your API key
- **action** (string) - Required - Must be 'add'
- **service** (integer) - Required - Service ID
- **link** (string) - Required - Link to page
- **comments** (string) - Required - Comments list separated by \r\n or \n
### Response
#### Success Response (200)
- **order** (integer) - The ID of the newly created order

### Response Example
```json
{
    "order": 23501
}
```
```

--------------------------------

### Create Refill

Source: https://prm4u.com/api

Request a refill for a completed order using the order ID. Returns a confirmation of the refill request.

```json
{
    "refill": "1"
}
      
```

--------------------------------

### Add Order - SEO Custom Comments

Source: https://prm4u.com/api

Adds a new order for SEO custom comments service.

```APIDOC
## POST /api/v2

### Description
Adds a new order for SEO custom comments service.

### Method
POST

### Endpoint
https://prm4u.com/api/v2

### Parameters
#### Query Parameters
- **key** (string) - Required - Your API key
- **action** (string) - Required - Must be 'add'
- **service** (integer) - Required - Service ID
- **link** (string) - Required - Link to page
- **keywords** (string) - Required - Keywords list separated by \r\n or \n
### Response
#### Success Response (200)
- **order** (integer) - The ID of the newly created order

### Response Example
```json
{
    "order": 23501
}
```
```

--------------------------------

### Multiple Orders Status

Source: https://prm4u.com/api

Retrieves the status of multiple orders.

```APIDOC
## POST /api/v2

### Description
Retrieves the status of multiple orders.

### Method
POST

### Endpoint
https://prm4u.com/api/v2

### Parameters
#### Query Parameters
- **key** (string) - Required - Your API key
- **action** (string) - Required - Must be 'status'
- **orders** (string) - Required - Order IDs separated by a comma (up to 100 IDs)

### Response
#### Success Response (200)
- **order_id** (object) - An object where keys are order IDs and values are their status details.
  - **charge** (string) - The cost of the order
  - **start_count** (string) - The initial count when the order started
  - **status** (string) - The current status of the order
  - **remains** (string) - The remaining quantity to be delivered
  - **currency** (string) - The currency of the charge
  - **error** (string) - Error message if the order ID is invalid

### Response Example
```json
{
    "1": {
        "charge": "0.27819",
        "start_count": "3572",
        "status": "Partial",
        "remains": "157",
        "currency": "USD"
    },
    "10": {
        "error": "Incorrect order ID"
    },
    "100": {
        "charge": "1.44219",
        "start_count": "234",
        "status": "In progress",
        "remains": "10",
        "currency": "USD"
    }
}
```
```

--------------------------------

### Order Status

Source: https://prm4u.com/api

Retrieves the status of a specific order.

```APIDOC
## POST /api/v2

### Description
Retrieves the status of a specific order.

### Method
POST

### Endpoint
https://prm4u.com/api/v2

### Parameters
#### Query Parameters
- **key** (string) - Required - Your API key
- **action** (string) - Required - Must be 'status'
- **order** (integer) - Required - Order ID

### Response
#### Success Response (200)
- **charge** (string) - The cost of the order
- **start_count** (string) - The initial count when the order started
- **status** (string) - The current status of the order (e.g., "Partial", "In progress")
- **remains** (string) - The remaining quantity to be delivered
- **currency** (string) - The currency of the charge

### Response Example
```json
{
    "charge": "0.27819",
    "start_count": "3572",
    "status": "Partial",
    "remains": "157",
    "currency": "USD"
}
```
```

--------------------------------

### Add Order - Poll

Source: https://prm4u.com/api

Adds a new order for a poll service.

```APIDOC
## POST /api/v2

### Description
Adds a new order for a poll service.

### Method
POST

### Endpoint
https://prm4u.com/api/v2

### Parameters
#### Query Parameters
- **key** (string) - Required - Your API key
- **action** (string) - Required - Must be 'add'
- **service** (integer) - Required - Service ID
- **link** (string) - Required - Link to page
- **answer_number** (integer) - Required - Answer number of the poll

### Response
#### Success Response (200)
- **order** (integer) - The ID of the newly created order

### Response Example
```json
{
    "order": 23501
}
```
```
Tokens:
Raw