Skip to content
Developer docs · API v2

Everything you need to make a call.

One URL, one request body, one action field. Connect your own tools to list services, place orders, track progress and manage your balance.

Base URL

API v2
https://growoxa.com/api/v2

POST with application/x-www-form-urlencoded · include key and action.

Getting started

Three steps to your first order

The API spends the same wallet the panel does, so anything you can order here you can order through the API — and both show up in the same order list.

  1. Create an account

    Sign up with your email. Add funds from the dashboard once you are in — the API spends the same wallet the panel does.

    Create an account →

  2. Generate an API key

    Open Account → API keys, name the key after the tool that will use it and press Generate. The key is shown once, so copy it straight into your server's environment.

    Open your account →

  3. Make your first call

    Send a request with action=services and your key. You get back every service you can order, with the ID, the price and the limits.

    See the endpoints →

Keep the key secret

An API key is a password. Store it in an environment variable, never in your source code, and revoke it the moment you think it may have leaked. Revoking a key takes effect immediately.

Authentication

Three ways to send your key

Every request carries the key you generated in your account. Pick whichever of the three suits your client — they are equivalent, and the API accepts any of them on every action.

As a form field
key=YOUR_API_KEY&action=services

The classic panel way. Every request is a POST with `application/x-www-form-urlencoded`, and the key travels as `key`.

As a bearer token
Authorization: Bearer YOUR_API_KEY

Works with any HTTP client that can set headers — `curl`, `fetch`, `axios` and most libraries for PHP, Python and Node.

As a header of its own
X-API-Key: YOUR_API_KEY

Useful when a client insists on sending the key in a dedicated header rather than in the query or the body.

Endpoint

Service list

POST

Service list

Returns every service available on your account, with the ID you use when placing an order.

Actionaction=services

Parameters

Parameters for Service list
ParameterTypeRequiredDescription
keystringrequiredYour API key.
actionstringrequiredMust be `services`.
limitintegeroptionalHow many services to return. Defaults to everything.

Example request

Request body
action=services

Example response

JSON
[
  {
    "service": 1,
    "name": "Instagram Followers | High Quality | Max 50K | Instant",
    "type": "Default",
    "category": "Instagram - Followers",
    "rate": "0.90",
    "min": "100",
    "max": "50000",
    "refill": true,
    "cancel": true
  }
]

Response fields

Response fields for Service list
FieldDescription
serviceService ID. Send this in the `service` parameter when you place an order.
nameHuman-readable service name, as shown on the panel.
typeService type — it decides which extra fields an order needs (`Default`, `Drip Feed`, `Custom Comments`, `Mentions`, `Poll`, …).
categoryCategory and platform the service belongs to.
ratePrice per unit, as a string. The total is `rate × quantity`.
minMinimum quantity for one order.
maxMaximum quantity for one order.
refillWhether the service supports refills.
cancelWhether the service can be cancelled through the API.
  • Cache this list on your server and refresh it on a schedule instead of requesting it before every order.
  • Check the `type` value before you send `runs`, `interval`, `comments`, `usernames` or `answer_number`.

Endpoint

Add order

POST

Add order

Creates a new order and returns the order ID you use to track it.

Actionaction=add

Parameters

Parameters for Add order
ParameterTypeRequiredDescription
keystringrequiredYour API key.
actionstringrequiredMust be `add`.
serviceintegerrequiredService ID from the service list.
linkstringrequiredThe page or profile the service should be delivered to.
quantityintegerrequiredAmount to order, within the service `min` and `max`.
runsintegeroptionalNumber of separate deliveries. Required for **Drip Feed** service types.
intervalintegeroptionalMinutes between deliveries. Required for **Drip Feed** service types.
commentsstringoptionalCustom comments, one per line. Required for **Custom Comments** service types.
usernamesstringoptionalUsernames, one per line. Required for **Mentions** service types.
answer_numberintegeroptionalPoll answer number. Required for **Poll** service types.

Example request

Request body
action=add&service=1&link=https://instagram.com/p/CwXyZ12345/&quantity=1000

Example response

JSON
{ "order": 23501 }
  • Only `key`, `action`, `service`, `link` and `quantity` are always required. Which extra fields you must send depends on the service `type`.
  • The price is calculated on our side — the numbers you send never decide what you pay.
  • If a request times out, check the order status before sending it again so you do not create a duplicate.

Endpoint

Order status

POST

Order status

Returns the charge, progress and current status of one order.

Actionaction=status

Parameters

Parameters for Order status
ParameterTypeRequiredDescription
keystringrequiredYour API key.
actionstringrequiredMust be `status`.
orderintegerrequiredThe order ID returned by `action=add`.

Example request

Request body
action=status&order=23501

Example response

JSON
{
  "charge": "0.90",
  "start_count": "120",
  "status": "In progress",
  "remains": "880",
  "currency": "USD",
  "quantity": "1000"
}

Response fields

Response fields for Order status
FieldDescription
chargeAmount deducted for this order, as a string.
start_countCount on the link when the order started.
statusOne of the order statuses — see **Order statuses** below.
remainsAmount still to be delivered. `0` usually means the order is finished.
currencyCurrency the charge is quoted in.
quantityThe quantity that was ordered.
  • Poll at a reasonable interval. For batches, use the multiple-orders status endpoint instead of one call per order.

Endpoint

Multiple orders status

POST

Multiple orders status

Returns the status of up to 100 orders in one call, keyed by order ID.

Actionaction=status

Parameters

Parameters for Multiple orders status
ParameterTypeRequiredDescription
keystringrequiredYour API key.
actionstringrequiredMust be `status`.
ordersstringrequiredUp to **100** order IDs, comma separated with no spaces.

Example request

Request body
action=status&orders=23501,23502,23503

Example response

JSON
{
  "23501": {
    "charge": "0.90",
    "start_count": "120",
    "status": "Completed",
    "remains": "0",
    "currency": "USD"
  },
  "23502": {
    "charge": "2.70",
    "start_count": "40",
    "status": "In progress",
    "remains": "960",
    "currency": "USD"
  },
  "23503": {
    "error": "Incorrect order ID"
  }
}
  • Send the IDs as one comma-separated string, not as an array parameter.
  • Always handle a per-order `error` key: one bad ID must not break your whole batch.
  • Split larger batches rather than sending them all at once.

Endpoint

Create refill

POST

Create refill

Requests a refill for one order, or for several orders at once.

Actionaction=refill

Parameters

Parameters for Create refill
ParameterTypeRequiredDescription
keystringrequiredYour API key.
actionstringrequiredMust be `refill`.
orderintegeroptionalOrder ID to refill. Required for a single refill.
ordersstringoptionalOrder IDs, comma separated. Required for a bulk refill.

Example request

Request body
action=refill&order=23501

Example response

JSON
{ "refill": 1 }

Bulk refill

Request body
action=refill&orders=23501,23502,23503

Example response

JSON
[
  { "refill": 1 },
  { "refill": 2 },
  { "order": 23503, "error": "Refill not available" }
]
  • Send either `order` or `orders`, not both.
  • Only services with `refill: true` in the service list can be refilled, and only inside their refill window.

Endpoint

Refill status

POST

Refill status

Checks the status of one refill, or of several refills at once.

Actionaction=refill_status

Parameters

Parameters for Refill status
ParameterTypeRequiredDescription
keystringrequiredYour API key.
actionstringrequiredMust be `refill_status`.
refillintegeroptionalRefill ID returned by `action=refill`. Required for a single lookup.
refillsstringoptionalRefill IDs, comma separated. Use for a bulk lookup.

Example request

Request body
action=refill_status&refill=1

Example response

JSON
{ "status": "Completed" }

Bulk refill status

Request body
action=refill_status&refills=1,2

Example response

JSON
{
  "1": { "status": "Completed" },
  "2": { "status": "Pending" },
  "3": { "error": "Refill not found" }
}
  • Poll refills far less often than orders — a refill usually takes much longer to resolve.

Endpoint

Cancel orders

POST

Cancel orders

Cancels one or more orders that are still cancellable.

Actionaction=cancel

Parameters

Parameters for Cancel orders
ParameterTypeRequiredDescription
keystringrequiredYour API key.
actionstringrequiredMust be `cancel`.
ordersstringrequiredOrder IDs to cancel, comma separated.

Example request

Request body
action=cancel&orders=23501,23502

Example response

JSON
[
  { "order": 23501, "cancel": 1 },
  { "order": 23502, "cancel": 1 }
]
  • Only services with `cancel: true` in the service list can be cancelled, and only while the order is still running.
  • Cancelling never refunds delivered quantity. Check the order status afterwards to confirm what stopped.

Endpoint

Balance

POST

Balance

Returns your current account balance and currency.

Actionaction=balance

Parameters

Parameters for Balance
ParameterTypeRequiredDescription
keystringrequiredYour API key.
actionstringrequiredMust be `balance`.

Example request

Request body
action=balance

Example response

JSON
{ "balance": "100.84292", "currency": "USD" }

Response fields

Response fields for Balance
FieldDescription
balanceAvailable balance, as a string. Parse it as a decimal, not as a float, if you do accounting with it.
currencyCurrency code the balance is held in.
  • Check your balance before a batch of orders so you fail fast instead of part-way through a run.

Reference

Order statuses

The status field uses the values below. Treat it as a display string first and a machine value second — match on the wording you expect, and keep a fallback for anything new.

Order status values
StatusMeaning
PendingThe order has been accepted and is waiting to start.
In progressThe order is being delivered right now.
CompletedThe full quantity has been delivered.
PartialOnly part of the order could be delivered; the remainder is usually refunded.
CanceledThe order was cancelled and will not continue.
RefundedThe order was refunded because the provider could not deliver it.
FailedThe order could not be started at all and was not charged.

Reference

Errors

A failed call answers with a non-2xx status and a JSON object carrying an error key instead of the data you asked for. Handle it on every call.

Common error responses
Example responseMeaningWhat to do
{ "error": "Incorrect API key" }The key is missing, wrong, or the key was revoked.Check the key stored on your server. Generate a new one if it may have leaked.
{ "error": "Unknown action" }The `action` value is not one this API knows.Use one of the actions listed above.
{ "error": "Not enough funds on balance" }Your balance is lower than the cost of the order.Add funds, then retry. Check the balance endpoint first.
{ "error": "Incorrect service ID" }The `service` value is not in your service list.Refresh the service list and use a current `service` ID.
{ "error": "Quantity is less than the minimum" }The `quantity` is below the service `min`.Clamp the quantity to the service range before sending.
{ "error": "Quantity is more than the maximum" }The `quantity` is above the service `max`.Split the order, or clamp it to the service range.
{ "error": "Incorrect order ID" }The order does not exist on your account.Check the ID you stored when the order was created.
{ "error": "Refill not available" }The service has no refill, or the refill window has closed.Only refill services with `refill: true`, inside the window.
{ "error": "Cancel not available" }The order already finished, or the service cannot be cancelled.Check the order status before cancelling.

A batch can fail one row at a time

The multiple-status and bulk refill endpoints answer with one row per order, and each row carries its own error. One bad order ID must never break the rest of your run.

Examples

Your first call, in four languages.

The same request in cURL, PHP, Python and Node.js. Every one of them reads the key from an environment variable called GROWOXA_API_KEY so the secret never ends up in your source code.

cURL
curl -X POST "https://growoxa.com/api/v2" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -H "Authorization: Bearer $GROWOXA_API_KEY" \
  -d "action=services"
PHP
$ch = curl_init('https://growoxa.com/api/v2');

curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_POST           => true,
    CURLOPT_POSTFIELDS     => http_build_query([
        'key'    => getenv('GROWOXA_API_KEY'),
        'action' => 'services',
    ]),
]);

$response = curl_exec($ch);
curl_close($ch);

$services = json_decode($response, true);
Python
import os
import requests

response = requests.post(
    "https://growoxa.com/api/v2",
    headers={"Authorization": f"Bearer {os.environ['GROWOXA_API_KEY']}"},
    data={"action": "services"},
)

services = response.json()
Node.js
const response = await fetch("https://growoxa.com/api/v2", {
  method: "POST",
  headers: {
    "Content-Type": "application/x-www-form-urlencoded",
    Authorization: `Bearer ${process.env.GROWOXA_API_KEY}`,
  },
  body: new URLSearchParams({ action: "services" }),
});

const services = await response.json();

Reference

Best practices & limits

  • Store the key in an environment variable on your server, never in your source code.
  • Give every key a name that says what uses it, so you can revoke one without guessing.
  • Cache the service list instead of requesting it on every order.
  • Poll order status at reasonable intervals; use the multiple-status endpoint for batches.
  • If a request times out, check the order status before sending the same order again, to avoid duplicates.
  • Validate quantity against the service `min` and `max` before sending.

Rate limits

Quote requests are limited to 60 per minute and creating a deposit to 10 per minute. Space out your polling, batch your status calls and back off if you are throttled.

FAQ

Questions before your first order.

Where do I find my API key?

Log in, open Account and switch to the API keys tab. Generate a key there and copy it — it is shown once and never again. Keep it in an environment variable on your server.

Can I use one key for several tools?

Yes, and we recommend it. Generate one key per tool — a cron script, a reseller panel, a bot — and revoke them one at a time if one leaks.

Is there a rate limit?

The quote endpoint accepts 60 requests per minute, and creating a deposit is capped at 10 because each one is reviewed by a human. Cache the service list, batch your status calls and back off if you receive a throttling response.

How do I avoid duplicate orders?

If a request times out, do not resend it straight away. Call the order status endpoint, or check your order list, to see whether the order was created first. Store the order ID as soon as it comes back.

Can I test without spending money?

There is no sandbox. The cheapest safe test is a single small order on the lowest-minimum service, placed from your server with the key held in an environment variable.

Who do I contact for API help?

Send your request, the endpoint and the order ID to the support team and we will help you trace it. Never paste your API key into a support ticket.

Still stuck?

Tell us the endpoint, the action and the order ID and we will trace it with you. Never paste your API key into a support ticket — contact support instead.