API Documentation

API Endpoint

All API requests should be sent to:

POST https://pathshub.com/api/v2

Authentication

Include your API key in the request body:

{
    "key": "YOUR_API_KEY",
    "action": "..."
}

Available Actions

1. Get Services

{
    "key": "YOUR_API_KEY",
    "action": "services"
}

Response:

[
    {
        "service": 1,
        "name": "Service Name",
        "category": "Category",
        "type": "Default",
        "rate": 2.50,
        "min": 50,
        "max": 3000,
        "dripfeed": false,
        "refill": false,
        "cancel": true
    }
]

2. Create Order

{
    "key": "YOUR_API_KEY",
    "action": "add",
    "service": 1,
    "link": "https://example.com",
    "quantity": 1000
}

Response:

{
    "order": "123456",
    "currency": "USD"
}

3. Check Order Status

{
    "key": "YOUR_API_KEY",
    "action": "status",
    "order": "123456"
}

Response:

{
    "charge": 2.50,
    "start_count": 0,
    "status": "Pending",
    "remains": 1000,
    "currency": "USD"
}

4. Check Multiple Orders Status

{
    "key": "YOUR_API_KEY",
    "action": "multiStatus",
    "orders": "123456,123457,123458"
}

Response:

{
    "123456": {
        "charge": 2.50,
        "start_count": 0,
        "status": "Completed",
        "remains": 0,
        "currency": "USD"
    },
    "123457": {
        "charge": 3.00,
        "start_count": 100,
        "status": "In progress",
        "remains": 500,
        "currency": "USD"
    }
}

5. Cancel Order

{
    "key": "YOUR_API_KEY",
    "action": "cancel",
    "order": "123456"
}

Response:

{
    "success": true,
    "refunded": 2.50
}

6. Create Refill

{
    "key": "YOUR_API_KEY",
    "action": "refill",
    "order": "123456"
}

Response:

{
    "refill": "refill_1234567890"
}

7. Check Refill Status

{
    "key": "YOUR_API_KEY",
    "action": "refillStatus",
    "refill": "refill_1234567890"
}

Response:

{
    "status": "Completed"
}

8. Check Balance

{
    "key": "YOUR_API_KEY",
    "action": "balance"
}

Response:

{
    "balance": "100.00",
    "currency": "USD"
}

Status Codes

Pending: Order is waiting to be processed
In progress: Order is being processed
Completed: Order has been completed
Partial: Order was partially completed
Canceled: Order was canceled
Processing: Order is in queue

Error Responses

All errors will return with appropriate HTTP status codes and error messages:

{
    "error": "Error description"
}