### Get User Balance API Response Source: https://prosmm.io/api This example shows the response for retrieving the user's account balance. It includes the available balance and the currency. ```json { "balance": "100.84292", "currency": "USD" } ``` -------------------------------- ### Get Multiple Orders Status API Response Source: https://prosmm.io/api This is an example response when querying the status of multiple orders. ```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 Order Status API Response Source: https://prosmm.io/api This is an example response when querying the status of a single order. ```json { "charge": "0.27819", "start_count": "3572", "status": "Partial", "remains": "157", "currency": "USD" } ``` -------------------------------- ### Add Order API Response Source: https://prosmm.io/api This is an example response when successfully adding an order to the API. ```json { "order": 23501 } ``` -------------------------------- ### List Services API Response Source: https://prosmm.io/api This is an example response when requesting a list of available services from the API. ```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 } ] ``` -------------------------------- ### Get Single Refill Status API Response Source: https://prosmm.io/api This is an example response for retrieving the status of a single refill. It indicates the completion status of the refill operation. ```json { "status": "Completed" } ``` -------------------------------- ### Create Single Refill API Response Source: https://prosmm.io/api This is an example of a successful response when creating a single refill. It confirms the refill action for the specified order. ```json { "refill": "1" } ``` -------------------------------- ### Get refill status Source: https://prosmm.io/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** (integer) - Required - Refill ID ### Request Example ``` GET /api?key=YOUR_API_KEY&action=refill_status&refill=1 ``` ### 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://prosmm.io/api Retrieves the status for multiple refills using their refill IDs. Accepts a comma-separated list of refill IDs. ```APIDOC ## Get multiple refill status ### Description Retrieves the status for multiple refills using their refill IDs. Accepts a comma-separated list of 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) ### Request Example ``` GET /api?key=YOUR_API_KEY&action=refill_status&refills=1,2,3 ``` ### Response #### Success Response (200) - **refill** (integer) - The refill ID. - **status** (string or object) - The status of the refill or an error object if the refill is not found. - If an error occurs, the object contains an **error** field (string). #### Response Example ```json [ { "refill": 1, "status": "Completed" }, { "refill": 2, "status": "Rejected" }, { "refill": 3, "status": { "error": "Refill not found" } } ] ``` ``` -------------------------------- ### Get Multiple Refill Statuses API Response Source: https://prosmm.io/api This response provides the status for multiple refill IDs. It lists the status for each refill, including potential errors if a refill is not found. ```json [ { "refill": 1, "status": "Completed" }, { "refill": 2, "status": "Rejected" }, { "refill": 3, "status": { "error": "Refill not found" } } ] ``` -------------------------------- ### Create Refill Source: https://prosmm.io/api Initiates a refill for a completed order. ```APIDOC ## POST /api/v2 ### Description Requests a refill for a specified order. ### Method POST ### Endpoint https://prosmm.io/api/v2 ### Parameters #### Query Parameters - **key** (string) - Required - Your API key - **action** (string) - Required - Must be 'refill' - **order** (integer) - Required - The ID of the order to refill ### Response #### Success Response (200) (No specific response body is detailed in the source for successful refill creation, typically an empty success or a confirmation message would be expected.) ``` -------------------------------- ### Service List Source: https://prosmm.io/api Retrieve a list of available services with their details. Requires an API key and the 'services' action. ```APIDOC ## POST /api/v2 ### Description Retrieves a list of available services from Prosmm.io. ### Method POST ### Endpoint https://prosmm.io/api/v2 ### Parameters #### Query Parameters - **key** (string) - Required - Your API key - **action** (string) - Required - Must be 'services' ### Response #### Success Response (200) - **service** (integer) - The ID of the service. - **name** (string) - The name of the service. - **type** (string) - The type of the service. - **category** (string) - The category the service belongs to. - **rate** (string) - The cost per unit of the service. - **min** (string) - The minimum quantity allowed for the service. - **max** (string) - The maximum quantity allowed for the service. - **refill** (boolean) - Indicates if the service supports refills. - **cancel** (boolean) - Indicates if the service can be canceled. ### Response Example ```json [ { "service": 1, "name": "Followers", "type": "Default", "category": "First Category", "rate": "0.90", "min": "50", "max": "10000", "refill": true, "cancel": true } ] ``` ``` -------------------------------- ### User balance Source: https://prosmm.io/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 ### Request Example ``` GET /api?key=YOUR_API_KEY&action=balance ``` ### Response #### Success Response (200) - **balance** (string) - The current balance amount. - **currency** (string) - The currency of the balance (e.g., "USD"). #### Response Example ```json { "balance": "100.84292", "currency": "USD" } ``` ``` -------------------------------- ### Create multiple refill Source: https://prosmm.io/api Initiates a refill for multiple orders. Accepts a comma-separated list of order IDs. ```APIDOC ## Create multiple refill ### Description Initiates a refill for multiple orders. Accepts a comma-separated list of order IDs. ### 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) ### Request Example ``` GET /api?key=YOUR_API_KEY&action=refill&orders=1,2,3 ``` ### Response #### Success Response (200) - **order** (integer) - The order ID. - **refill** (integer or object) - The refill status or an error object if the refill failed. - If an error occurs, the object contains an **error** field (string). #### Response Example ```json [ { "order": 1, "refill": 1 }, { "order": 2, "refill": 2 }, { "order": 3, "refill": { "error": "Incorrect order ID" } } ] ``` ``` -------------------------------- ### Add Order Source: https://prosmm.io/api Adds a new order for a specified service. Various parameters are available depending on the service type. ```APIDOC ## POST /api/v2 ### Description Adds a new order to Prosmm.io. The required parameters vary based on the service type. ### Method POST ### Endpoint https://prosmm.io/api/v2 ### Parameters #### Query Parameters - **key** (string) - Required - Your API key - **action** (string) - Required - Must be 'add' - **service** (integer) - Required - The ID of the service - **link** (string) - Required - Link to the target page - **quantity** (integer) - Required - The desired quantity for the order - **runs** (integer) - Optional - Number of runs for the service - **interval** (integer) - Optional - Interval in minutes for recurring services - **comments** (string) - Optional - A list of comments separated by newline characters (\n or \r\n) - **usernames** (string) - Optional - A list of usernames separated by newline characters (\n or \r\n) - **hashtags** (string) - Optional - A hashtag to scrape usernames from - **username** (string) - Optional - Username for specific services (e.g., polls, comments) - **min** (integer) - Optional - Minimum quantity for certain services - **max** (integer) - Optional - Maximum quantity for certain services - **posts** (integer) - Optional - Limit for new posts to be parsed for subscriptions - **old_posts** (integer) - Optional - Number of existing posts to parse for subscriptions - **delay** (integer) - Optional - Delay in minutes for order delivery (e.g., 0, 5, 10, ..., 600) - **expiry** (string) - Optional - Expiry date in 'd/m/Y' format - **media** (string) - Optional - URL of the media to scrape likers from - **answer_number** (integer) - Optional - Answer number for poll services ### Response #### Success Response (200) - **order** (integer) - The ID of the created order. ### Response Example ```json { "order": 23501 } ``` ``` -------------------------------- ### Create cancel Source: https://prosmm.io/api Initiates a cancellation for multiple orders. Accepts a comma-separated list of order IDs. ```APIDOC ## Create cancel ### Description Initiates a cancellation for multiple orders. Accepts a comma-separated list of 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) ### Request Example ``` GET /api?key=YOUR_API_KEY&action=cancel&orders=9,2 ``` ### Response #### Success Response (200) - **order** (integer) - The order ID. - **cancel** (integer or object) - The cancellation status or an error object if the cancellation failed. - If an error occurs, the object contains an **error** field (string). #### Response Example ```json [ { "order": 9, "cancel": { "error": "Incorrect order ID" } }, { "order": 2, "cancel": 1 } ] ``` ``` -------------------------------- ### Create Multiple Refills API Response Source: https://prosmm.io/api This response shows the outcome of attempting to create multiple refills. It details the status for each order, indicating success or providing error messages for specific orders. ```json [ { "order": 1, "refill": 1 }, { "order": 2, "refill": 2 }, { "order": 3, "refill": { "error": "Incorrect order ID" } } ] ``` -------------------------------- ### Order Status Source: https://prosmm.io/api Retrieves the status of a specific order or multiple orders. ```APIDOC ## POST /api/v2 ### Description Retrieves the status of one or more orders. ### Method POST ### Endpoint https://prosmm.io/api/v2 ### Parameters #### Query Parameters - **key** (string) - Required - Your API key - **action** (string) - Required - Must be 'status' - **order** (integer) - Required (for single order status) - The ID of the order - **orders** (string) - Required (for multiple orders status) - Comma-separated Order IDs (up to 100) ### Response #### Success Response (200) For a single order: - **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 for the order. - **currency** (string) - The currency used for the charge. For multiple orders: - A JSON object where keys are order IDs and values are status objects (or an error message). ### Response Example (Single Order) ```json { "charge": "0.27819", "start_count": "3572", "status": "Partial", "remains": "157", "currency": "USD" } ``` ### Response Example (Multiple Orders) ```json { "1": { "charge": "0.27819", "start_count": "3572", "status": "Partial", "remains": "157", "currency": "USD" }, "10": { "error": "Incorrect order ID" } } ``` ``` -------------------------------- ### Create Cancel API Response Source: https://prosmm.io/api This response indicates the result of a cancellation request for orders. It shows which orders were successfully cancelled and which encountered errors, such as incorrect order IDs. ```json [ { "order": 9, "cancel": { "error": "Incorrect order ID" } }, { "order": 2, "cancel": 1 } ] ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.