### Order Status Response Example Source: https://amarboost.com/api This JSON response provides the current status of a specific order, including charge, start count, status, remaining quantity, and currency. ```json { "charge": "0.27819", "start_count": "3572", "status": "Partial", "remains": "157", "currency": "USD" } ``` -------------------------------- ### User Balance Response Example Source: https://amarboost.com/api This JSON response displays the user's current account balance and the currency. ```json { "balance": "100.84292", "currency": "USD" } ``` -------------------------------- ### Get Refill Status Response Example Source: https://amarboost.com/api This JSON response provides the status of a specific refill request. ```json { "status": "Completed" } ``` -------------------------------- ### Get Available Services Source: https://amarboost.com/example.txt Retrieve a list of all available services from the API. This is useful for understanding what services can be ordered. ```php $services = $api->services(); ``` -------------------------------- ### Get Services Source: https://amarboost.com/example.txt Retrieves a list of all available services from the AmarBoost platform. This is useful for understanding what services can be ordered. ```APIDOC ## Get Services ### Description Retrieves a list of all available services. ### Method POST ### Endpoint /api/v2 ### Parameters #### Query Parameters - **key** (string) - Required - Your API key. - **action** (string) - Required - Must be set to "services". ### Request Example ```json { "key": "YOUR_API_KEY", "action": "services" } ``` ### Response #### Success Response (200) - **services** (array) - A list of available services, each with its own details. #### Response Example ```json { "services": [ { "id": 1, "name": "Service Name", "rate": 1.00, "min_quantity": 10, "max_quantity": 10000 } ] } ``` ``` -------------------------------- ### Get Multiple Refill Statuses Response Example Source: https://amarboost.com/api This JSON response provides the status for multiple refill requests. Each entry includes the refill ID and its status, or an error if the refill is not found. ```json [ { "refill": 1, "status": "Completed" }, { "refill": 2, "status": "Rejected" }, { "refill": 3, "status": { "error": "Refill not found" } } ] ``` -------------------------------- ### Get Multiple Order Statuses Source: https://amarboost.com/example.txt Retrieve the statuses for multiple orders by providing an array of order IDs. Returns status, charge, remains, start count, and currency for each. ```php $statuses = $api->multiStatus([1, 2, 3]); ``` -------------------------------- ### Service List Response Example Source: https://amarboost.com/api This JSON response shows the structure for a list of available services, including details like service ID, name, type, category, rate, minimum and maximum order quantities, and refill/cancel support. ```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 } ] ``` -------------------------------- ### Create Refill Response Example Source: https://amarboost.com/api This JSON response confirms the creation of a refill request for a specified order, returning the refill ID. ```json { "refill": "1" } ``` -------------------------------- ### Get Order Status Source: https://amarboost.com/example.txt Retrieves the status of a specific order, including charge, remaining count, start count, and currency. ```APIDOC ## Get Order Status ### Description Retrieves the status of a specific order. ### Method POST ### Endpoint /api/v2 ### Parameters #### Query Parameters - **key** (string) - Required - Your API key. - **action** (string) - Required - Must be set to "status". - **order** (integer) - Required - The ID of the order to check. ### Request Example ```json { "key": "YOUR_API_KEY", "action": "status", "order": 12345 } ``` ### Response #### Success Response (200) - **status** (string) - The current status of the order (e.g., 'Processing', 'Completed'). - **charge** (float) - The amount charged for the order. - **remains** (integer) - The remaining quantity for the order. - **start_count** (integer) - The number of items started. - **currency** (string) - The currency of the charge. #### Response Example ```json { "status": "Processing", "charge": 1.00, "remains": 50, "start_count": 50, "currency": "USD" } ``` ``` -------------------------------- ### Add Order Response Example Source: https://amarboost.com/api This JSON response indicates the successful creation of a new order, returning the unique order ID. ```json { "order": 23501 } ``` -------------------------------- ### Multiple Orders Status Response Example Source: https://amarboost.com/api This JSON response shows the status for multiple orders, with each order ID as a key. It includes details for successful lookups and error messages for invalid IDs. ```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" } } ``` -------------------------------- ### Process Refills and Get Statuses Source: https://amarboost.com/example.txt Initiate refills for multiple orders and then retrieve the status of these refills. This involves two API calls. ```php $refill = (array) $api->multiRefill([1, 2]); $refillIds = array_column($refill, 'refill'); if ($refillIds) { $refillStatuses = $api->multiRefillStatus($refillIds); } ``` -------------------------------- ### Get User Balance Source: https://amarboost.com/example.txt Fetch the current balance of your API account. This helps in managing funds for orders. ```php $balance = $api->balance(); ``` -------------------------------- ### Get Single Order Status Source: https://amarboost.com/example.txt Retrieve the status of a specific order using its ID. Returns details like status, charge, remaining count, start count, and currency. ```php $status = $api->status($order->order); ``` -------------------------------- ### Create Multiple Refills Response Example Source: https://amarboost.com/api This JSON response shows the result of multiple refill requests. Each entry indicates the order ID and the corresponding refill ID or an error message if the request failed. ```json [ { "order": 1, "refill": 1 }, { "order": 2, "refill": 2 }, { "order": 3, "refill": { "error": "Incorrect order ID" } } ] ``` -------------------------------- ### Get Balance Source: https://amarboost.com/example.txt Retrieves the current balance of the user's account. This is essential for managing funds and ensuring sufficient balance for orders. ```APIDOC ## Get Balance ### Description Retrieves the current balance of the user's account. ### Method POST ### Endpoint /api/v2 ### Parameters #### Query Parameters - **key** (string) - Required - Your API key. - **action** (string) - Required - Must be set to "balance". ### Request Example ```json { "key": "YOUR_API_KEY", "action": "balance" } ``` ### Response #### Success Response (200) - **balance** (float) - The current account balance. - **currency** (string) - The currency of the balance. #### Response Example ```json { "balance": 100.50, "currency": "USD" } ``` ``` -------------------------------- ### Create Cancel Response Example Source: https://amarboost.com/api This JSON response indicates the result of a cancellation request for one or more orders. It shows either an error for invalid order IDs or the cancellation status for valid ones. ```json [ { "order": 9, "cancel": { "error": "Incorrect order ID" } }, { "order": 2, "cancel": 1 } ] ``` -------------------------------- ### Get Refill Status Source: https://amarboost.com/example.txt Checks the status of a specific refill request using its refill ID. ```APIDOC ## Get Refill Status ### Description Checks the status of a specific refill request. ### Method POST ### Endpoint /api/v2 ### Parameters #### Query Parameters - **key** (string) - Required - Your API key. - **action** (string) - Required - Must be set to "refill_status". - **refill** (integer) - Required - The ID of the refill request. ### Request Example ```json { "key": "YOUR_API_KEY", "action": "refill_status", "refill": 67890 } ``` ### Response #### Success Response (200) - **status** (string) - The status of the refill request. #### Response Example ```json { "status": "Completed" } ``` ``` -------------------------------- ### Get Multiple Orders Status Source: https://amarboost.com/example.txt Retrieves the status for multiple orders simultaneously. This is efficient for checking the status of several orders at once. ```APIDOC ## Get Multiple Orders Status ### Description Retrieves the status for multiple orders. ### Method POST ### Endpoint /api/v2 ### Parameters #### Query Parameters - **key** (string) - Required - Your API key. - **action** (string) - Required - Must be set to "status". - **orders** (string) - Required - A comma-separated string of order IDs. ### Request Example ```json { "key": "YOUR_API_KEY", "action": "status", "orders": "1,2,3" } ``` ### Response #### Success Response (200) - Returns an array of order status objects, each containing status, charge, remains, start count, and currency for the requested orders. #### Response Example ```json [ { "order": 1, "status": "Completed", "charge": 1.00, "remains": 0, "start_count": 100, "currency": "USD" }, { "order": 2, "status": "Processing", "charge": 0.50, "remains": 25, "start_count": 75, "currency": "USD" } ] ``` ``` -------------------------------- ### Get Multiple Refill Statuses Source: https://amarboost.com/example.txt Retrieves the status for multiple refill requests simultaneously. Provide a list of refill IDs. ```APIDOC ## Get Multiple Refill Statuses ### Description Retrieves the status for multiple refill requests. ### Method POST ### Endpoint /api/v2 ### Parameters #### Query Parameters - **key** (string) - Required - Your API key. - **action** (string) - Required - Must be set to "refill_status". - **refills** (string) - Required - A comma-separated string of refill IDs. ### Request Example ```json { "key": "YOUR_API_KEY", "action": "refill_status", "refills": "67890,67891" } ``` ### Response #### Success Response (200) - Returns an array of refill status objects, each containing the status for the requested refill IDs. #### Response Example ```json [ { "refill": 67890, "status": "Completed" }, { "refill": 67891, "status": "Pending" } ] ``` ``` -------------------------------- ### Get Refill Status Source: https://amarboost.com/api Retrieves the status of a refill request or multiple refill requests. Requires an API key and the refill ID(s). ```APIDOC ## POST /api/v2 ### Description Retrieves the status of one or more refill requests. ### Method POST ### Endpoint https://amarboost.com/api/v2 ### Parameters #### Query Parameters - **key** (string) - Required - Your API key - **action** (string) - Required - Must be set to 'refill_status' - **refill** (integer) - Required (for single refill status) - The ID of the refill request to check. - **refills** (string) - Required (for multiple refill status) - A comma-separated string of refill IDs (up to 100). ### Response #### Success Response (200) For a single refill status: - **status** (string) - The status of the refill (e.g., Completed, Rejected). For multiple refill statuses: - A JSON array where each object contains the refill ID and its status. The status can be a string or an error object. ### Response Example (Single Refill Status) ```json { "status": "Completed" } ``` ### Response Example (Multiple Refill Statuses) ```json [ { "refill": 1, "status": "Completed" }, { "refill": 2, "status": "Rejected" }, { "refill": 3, "status": { "error": "Refill not found" } } ] ``` ``` -------------------------------- ### Initialize API Client Source: https://amarboost.com/example.txt Instantiate the Api class. Ensure your API key is set. ```php $api = new Api(); // Set your API key here if not set in the class constructor // $api->api_key = 'YOUR_API_KEY'; ``` -------------------------------- ### Add Order for a Package Source: https://amarboost.com/example.txt Place an order for a pre-defined service package. Only requires service ID and link. ```php $order = $api->order(['service' => 1, 'link' => 'http://example.com/test']); ``` -------------------------------- ### Add a New Order (Default) Source: https://amarboost.com/example.txt Place a new order with default parameters. Requires service ID, link, quantity, and optionally runs and interval. ```php $order = $api->order(['service' => 1, 'link' => 'http://example.com/test', 'quantity' => 100, 'runs' => 2, 'interval' => 5]); ``` -------------------------------- ### Add Order with Custom Comments Source: https://amarboost.com/example.txt Place an order and include custom comments. Useful for specific instructions or notes related to the order. ```php $order = $api->order(['service' => 1, 'link' => 'http://example.com/test', 'comments' => "good pic\ngreat photo\n:)\n;)"]); ``` -------------------------------- ### Service List Source: https://amarboost.com/api Retrieve a list of available services with their details. This endpoint requires an API key and the action parameter set to 'services'. ```APIDOC ## POST /api/v2 ### Description Retrieves a list of available services from the API. ### Method POST ### Endpoint https://amarboost.com/api/v2 ### Parameters #### Query Parameters - **key** (string) - Required - Your API key - **action** (string) - Required - Must be set to 'services' ### Response #### Success Response (200) - **service** (integer) - The unique identifier for the service. - **name** (string) - The name of the service (e.g., Followers, Comments). - **type** (string) - The type of service (e.g., Default, Custom Comments). - **category** (string) - The category the service belongs to. - **rate** (string) - The price per unit of the service. - **min** (string) - The minimum quantity that can be ordered. - **max** (string) - The maximum quantity that can be ordered. - **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 }, { "service": 2, "name": "Comments", "type": "Custom Comments", "category": "Second Category", "rate": "8", "min": "10", "max": "1500", "refill": false, "cancel": true } ] ``` ``` -------------------------------- ### Add Order Source: https://amarboost.com/example.txt Places a new order for a service. Requires specifying the service ID, link, and optionally quantity, runs, interval, comments, or answer number. ```APIDOC ## Add Order ### Description Places a new order for a service. ### Method POST ### Endpoint /api/v2 ### Parameters #### Query Parameters - **key** (string) - Required - Your API key. - **action** (string) - Required - Must be set to "add". - **service** (integer) - Required - The ID of the service to order. - **link** (string) - Required - The link for the service (e.g., URL). - **quantity** (integer) - Optional - The desired quantity for the order. - **runs** (integer) - Optional - The number of runs for the service. - **interval** (integer) - Optional - The interval between runs in minutes. - **comments** (string) - Optional - Custom comments for the order. - **answer_number** (string) - Optional - The answer number for poll-type services. ### Request Example ```json { "key": "YOUR_API_KEY", "action": "add", "service": 1, "link": "http://example.com/test", "quantity": 100, "runs": 2, "interval": 5 } ``` ### Response #### Success Response (200) - **order** (integer) - The ID of the newly created order. #### Response Example ```json { "order": 12345 } ``` ``` -------------------------------- ### Create Refill Source: https://amarboost.com/api Initiates a refill for a specific order or multiple orders. Requires an API key and the order ID(s). ```APIDOC ## POST /api/v2 ### Description Creates a refill for one or more orders. ### Method POST ### Endpoint https://amarboost.com/api/v2 ### Parameters #### Query Parameters - **key** (string) - Required - Your API key - **action** (string) - Required - Must be set to 'refill' - **order** (integer) - Required (for single refill) - The ID of the order to refill. - **orders** (string) - Required (for multiple refills) - A comma-separated string of order IDs (up to 100). ### Response #### Success Response (200) For a single refill: - **refill** (integer) - Indicates the success of the refill request (e.g., 1 for success). For multiple refills: - A JSON array where each object contains the order ID and the refill status. The refill status can be an integer (success) or an error object. ### Response Example (Single Refill) ```json { "refill": "1" } ``` ### Response Example (Multiple Refills) ```json [ { "order": 1, "refill": 1 }, { "order": 2, "refill": 2 }, { "order": 3, "refill": { "error": "Incorrect order ID" } } ] ``` ``` -------------------------------- ### User Balance Source: https://amarboost.com/api Retrieves the current balance of the user's account. Requires an API key. ```APIDOC ## POST /api/v2 ### Description Retrieves the current balance of the user's account. ### Method POST ### Endpoint https://amarboost.com/api/v2 ### Parameters #### Query Parameters - **key** (string) - Required - Your API key - **action** (string) - Required - Must be set to '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" } ``` ``` -------------------------------- ### Create Cancel Source: https://amarboost.com/api Initiates the cancellation of one or more orders. Requires an API key and the order ID(s). ```APIDOC ## POST /api/v2 ### Description Creates a cancellation request for one or more orders. ### Method POST ### Endpoint https://amarboost.com/api/v2 ### Parameters #### Query Parameters - **key** (string) - Required - Your API key - **action** (string) - Required - Must be set to 'cancel' - **orders** (string) - Required - A comma-separated string of order IDs (up to 100) to cancel. ### Response #### Success Response (200) - A JSON array where each object represents an order and its cancellation status. The status can be an integer (success) or an error object. ### Response Example ```json [ { "order": 9, "cancel": { "error": "Incorrect order ID" } }, { "order": 2, "cancel": 1 } ] ``` ``` -------------------------------- ### Refill Multiple Orders Source: https://amarboost.com/example.txt Requests refills for multiple orders simultaneously. Provide a list of order IDs to initiate refills for all of them. ```APIDOC ## Refill Multiple Orders ### Description Requests refills for multiple orders. ### Method POST ### Endpoint /api/v2 ### Parameters #### Query Parameters - **key** (string) - Required - Your API key. - **action** (string) - Required - Must be set to "refill". - **orders** (string) - Required - A comma-separated string of order IDs to refill. ### Request Example ```json { "key": "YOUR_API_KEY", "action": "refill", "orders": "1,2,3" } ``` ### Response #### Success Response (200) - Returns an array of refill information, where each element contains the refill ID for the corresponding order. #### Response Example ```json [ { "order": 1, "refill": 67890 }, { "order": 2, "refill": 67891 } ] ``` ``` -------------------------------- ### Add Order for Polls Source: https://amarboost.com/example.txt Place an order for a poll, specifying the answer number. Requires service ID, link, quantity, and answer number. ```php $order = $api->order(['service' => 1, 'link' => 'http://example.com/test', 'quantity' => 100, 'answer_number' => '7']); ``` -------------------------------- ### Refill Order Source: https://amarboost.com/example.txt Requests a refill for a specific order if the service supports it and the initial quantity was not met. Requires the order ID. ```APIDOC ## Refill Order ### Description Requests a refill for a specific order. ### Method POST ### Endpoint /api/v2 ### Parameters #### Query Parameters - **key** (string) - Required - Your API key. - **action** (string) - Required - Must be set to "refill". - **order** (integer) - Required - The ID of the order to refill. ### Request Example ```json { "key": "YOUR_API_KEY", "action": "refill", "order": 12345 } ``` ### Response #### Success Response (200) - **refill** (integer) - The ID of the refill request. #### Response Example ```json { "refill": 67890 } ``` ``` -------------------------------- ### Order Status Source: https://amarboost.com/api Retrieves the status of a specific order or multiple orders. Requires an API key and the order ID(s). ```APIDOC ## POST /api/v2 ### Description Retrieves the status of one or more orders. ### Method POST ### Endpoint https://amarboost.com/api/v2 ### Parameters #### Query Parameters - **key** (string) - Required - Your API key - **action** (string) - Required - Must be set to 'status' - **order** (integer) - Required (for single order status) - The ID of the order to check. - **orders** (string) - Required (for multiple orders status) - A comma-separated string of order IDs (up to 100). ### Response #### Success Response (200) For a single order: - **charge** (string) - The cost associated with 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 or count 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 (similar to single order response) or an error object if the order ID is invalid. ### 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" }, "100": { "charge": "1.44219", "start_count": "234", "status": "In progress", "remains": "10", "currency": "USD" } } ``` ``` -------------------------------- ### Cancel Multiple Orders Source: https://amarboost.com/example.txt Cancel a list of orders by providing their IDs. This is useful for stopping ongoing services or correcting mistakes. ```php $api->cancel([1, 2, 3]); ``` -------------------------------- ### Cancel Orders Source: https://amarboost.com/example.txt Cancels one or more orders. Provide a list of order IDs to cancel. ```APIDOC ## Cancel Orders ### Description Cancels one or more orders. ### Method POST ### Endpoint /api/v2 ### Parameters #### Query Parameters - **key** (string) - Required - Your API key. - **action** (string) - Required - Must be set to "cancel". - **orders** (string) - Required - A comma-separated string of order IDs to cancel. ### Request Example ```json { "key": "YOUR_API_KEY", "action": "cancel", "orders": "1,2,3" } ``` ### Response #### Success Response (200) - **status** (string) - Indicates the result of the cancellation request (e.g., 'success', 'partial', 'error'). #### Response Example ```json { "status": "success" } ``` ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.