API Documentation

Introduction

The AccsZone API is a RESTful API that uses JSON for request and response bodies. All API endpoints are prefixed with /api/v1.

📦 Response Format

All responses follow a consistent JSON structure with success, message, and data fields.

Standard Response Structure

{
    "success": true,
    "message": "Operation successful",
    "data": { ... }
}

Authentication

The API uses API key authentication. Generate a key from your dashboard and include it in the X-API-Key header for all requests.

🔑 API Key Header

Include in all requests:
X-API-Key: YOUR_API_KEY

⚠️ Key Security

Your API key is shown only once when created. Store it securely. You can create up to 5 keys and set optional expiration dates from your API Details dashboard.

Error Codes

The API uses standard HTTP status codes to indicate the success or failure of requests.

Code	Meaning	Description
200	OK	Request succeeded
201	Created	Resource created (purchase, registration)
400	Bad Request	Invalid input or business logic error
401	Unauthorized	Missing or invalid API key
403	Forbidden	API access disabled or account deactivated
404	Not Found	Resource not found
422	Validation Error	Request body validation failed
429	Too Many Requests	Rate limit exceeded
500	Server Error	Internal server error

Rate Limiting

API requests are rate-limited to protect the service. When you exceed the limit, you'll receive a 429 response.

60

Requests per minute (all endpoints)

User Endpoints

Manage user profile and check balance.

GET /api/v1/user/profile 🔒 Get user info ▼

Retrieve the authenticated user's profile information including balance.

🔒 API Key Required

Include X-API-Key: YOUR_API_KEY header.

Example Request

curl https://accszone.com/api/v1/user/profile \
  -H "X-API-Key: YOUR_API_KEY"

Example Response

200 Success

{
    "success": true,
    "data": {
        "id": 5,
        "name": "John",
        "lname": "Doe",
        "email": "[email protected]",
        "phone": "+1234567890",
        "address": "123 Main St",
        "country": "US",
        "balance": "150.00",
        "referral_balance": "25.00",
        "ref_code": "ABC123",
        "member_since": "2025-01-15"
    }
}

PUT /api/v1/user/profile 🔒 Update profile ▼

Update the authenticated user's profile fields. All fields are optional.

🔒 API Key Required

Include X-API-Key: YOUR_API_KEY header.

Parameters

Name	Type	Required	Description
name	string	Optional	First name
lname	string	Optional	Last name
phone	string	Optional	Phone number
address	string	Optional	Address
country	string	Optional	Country
telegram	string	Optional	Telegram handle

Example Request

curl -X PUT https://accszone.com/api/v1/user/profile \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"John","phone":"+1234567890"}'

Example Response

200 Success

{
    "success": true,
    "message": "Profile updated successfully"
}

GET /api/v1/user/balance 🔒 Check balance ▼

Get the current account balance and referral balance.

🔒 API Key Required

Include X-API-Key: YOUR_API_KEY header.

Example Request

curl https://accszone.com/api/v1/user/balance \
  -H "X-API-Key: YOUR_API_KEY"

Example Response

200 Success

{
    "success": true,
    "data": {
        "balance": "150.00",
        "referral_balance": "25.00"
    }
}

Category Endpoints

Browse available categories and subcategories.

GET /api/v1/categories/{id}/subcategories 🔒 By category ▼

List all subcategories under a specific main category.

🔒 API Key Required

Include X-API-Key: YOUR_API_KEY header.

Parameters

Name	Type	Required	Description
id	integer	Required	Main category ID (URL parameter)

Example Request

curl https://accszone.com/api/v1/categories/1/subcategories \
  -H "X-API-Key: YOUR_API_KEY"

Example Response

200 Success

{
    "success": true,
    "data": {
        "category": { "id": 1, "title": "Social Media" },
        "subcategories": [
            { "id": 1, "title": "Facebook", "slug": "facebook" },
            { "id": 2, "title": "Instagram", "slug": "instagram" }
        ]
    }
}

Listing Endpoints

Browse and search available listings.

GET /api/v1/listings 🔒 Browse all ▼

Browse all active listings with optional filters, search, sorting, and pagination.

🔒 API Key Required

Include X-API-Key: YOUR_API_KEY header.

Parameters

Name	Type	Required	Description
category_id	integer	Optional	Filter by main category ID
subcategory_id	integer	Optional	Filter by subcategory ID
search	string	Optional	Search by listing title
sort	string	Optional	Sort by: sort_key, total_price, available_stock, title
direction	string	Optional	Sort direction: asc or desc
per_page	integer	Optional	Items per page (default: 20, max: 100)
page	integer	Optional	Page number

Example Request

curl "https://accszone.com/api/v1/listings?category_id=1&search=facebook&per_page=10" \
  -H "X-API-Key: YOUR_API_KEY"

Example Response

200 Success

{
    "success": true,
    "data": [
        {
            "id": 1,
            "title": "Facebook Aged Accounts",
            "slug": "facebook-aged-accounts",
            "price": "2.50",
            "available_stock": 150,
            "sold": 320,
            "category": { "id": 1, "title": "Social Media", "slug": "social-media" },
            "subcategory": { "id": 1, "title": "Facebook", "slug": "facebook" }
        }
    ],
    "meta": {
        "current_page": 1,
        "last_page": 5,
        "per_page": 10,
        "total": 48
    }
}

GET /api/v1/listings/{slug} 🔒 Single listing ▼

Get detailed information about a specific listing including description and supplier.

🔒 API Key Required

Include X-API-Key: YOUR_API_KEY header.

Parameters

Name	Type	Required	Description
slug	string	Required	Listing slug (URL parameter)

Example Request

curl https://accszone.com/api/v1/listings/facebook-aged-accounts \
  -H "X-API-Key: YOUR_API_KEY"

Example Response

200 Success

{
    "success": true,
    "data": {
        "id": 1,
        "title": "Facebook Aged Accounts",
        "slug": "facebook-aged-accounts",
        "price": "2.50",
        "available_stock": 150,
        "sold": 320,
        "description": "Premium aged Facebook accounts...",
        "supplier": { "name": "AccsZone" },
        "category": { "id": 1, "title": "Social Media", "slug": "social-media" },
        "subcategory": { "id": 1, "title": "Facebook", "slug": "facebook" }
    }
}

Order Endpoints

Purchase accounts and manage order history.

POST /api/v1/purchase 🔒 Buy accounts ▼

Purchase accounts from a listing. The amount is deducted from your balance and the purchased account credentials are returned immediately.

🔒 API Key Required

Include X-API-Key: YOUR_API_KEY header.

Parameters

Name	Type	Required	Description
ad_id	integer	Required	Listing ID to purchase from
quantity	integer	Required	Number of accounts to purchase (min: 1)
promo_code	string	Optional	Promotional code for discount

Example Request

curl -X POST https://accszone.com/api/v1/purchase \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"ad_id":1,"quantity":2}'

Example Response

201 Success

{
    "success": true,
    "message": "Purchase successful",
    "data": {
        "order_id": 42,
        "listing": "Facebook Aged Accounts",
        "quantity": 2,
        "amount": "5.00",
        "discount": "0.00",
        "new_balance": "145.00",
        "accounts": [
            "[email protected]:password123",
            "[email protected]:password456"
        ],
        "purchased_at": "2025-12-20T14:30:00+00:00"
    }
}

GET /api/v1/orders 🔒 Order history ▼

List all orders placed by the authenticated user with pagination.

🔒 API Key Required

Include X-API-Key: YOUR_API_KEY header.

Parameters

Name	Type	Required	Description
per_page	integer	Optional	Items per page (default: 20, max: 100)
page	integer	Optional	Page number

Example Request

curl "https://accszone.com/api/v1/orders?per_page=10" \
  -H "X-API-Key: YOUR_API_KEY"

Example Response

200 Success

{
    "success": true,
    "data": [
        {
            "id": 42,
            "listing": "Facebook Aged Accounts",
            "category": "Social Media",
            "subcategory": "Facebook",
            "quantity": 2,
            "amount": "5.00",
            "discount": "0.00",
            "is_refund": false,
            "purchased_at": "2025-12-20"
        }
    ],
    "meta": {
        "current_page": 1,
        "last_page": 3,
        "per_page": 10,
        "total": 25
    }
}

GET /api/v1/orders/{id} 🔒 With accounts ▼

Get details of a specific order including the purchased account credentials.

🔒 API Key Required

Include X-API-Key: YOUR_API_KEY header.

Parameters

Name	Type	Required	Description
id	integer	Required	Order ID (URL parameter)

Example Request

curl https://accszone.com/api/v1/orders/42 \
  -H "X-API-Key: YOUR_API_KEY"

Example Response

200 Success

{
    "success": true,
    "data": {
        "id": 42,
        "listing": "Facebook Aged Accounts",
        "category": "Social Media",
        "subcategory": "Facebook",
        "quantity": 2,
        "amount": "5.00",
        "discount": "0.00",
        "is_refund": false,
        "accounts": [
            "[email protected]:password123",
            "[email protected]:password456"
        ],
        "purchased_at": "2025-12-20"
    }
}

Promo Endpoints

Validate promotional codes before purchase.

POST /api/v1/promo/validate 🔒 Check promo code ▼

Validate a promotional code against an amount and preview the discount before purchasing.

🔒 API Key Required

Include X-API-Key: YOUR_API_KEY header.

Parameters

Name	Type	Required	Description
code	string	Required	Promotional code
amount	number	Required	Amount to apply the code against

Example Request

curl -X POST https://accszone.com/api/v1/promo/validate \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"code":"SAVE10","amount":50.00}'

Example Response

200 Success

{
    "success": true,
    "data": {
        "valid": true,
        "original_amount": "50.00",
        "discount": "5.00",
        "final_amount": "45.00"
    }
}