API Reference

Complete reference documentation for the ArcusX REST API.

---

Base URL

• Development: http://arcusx.pro/api

• Production: https://arcusx.pro/api

All authenticated endpoints are under /auth/ path.

Authentication

All API requests (except login and register) require a JWT token in the Authorization header:

Authorization: Bearer {jwt_token}

Response Format

All responses follow this structure:

Success

{
  "success": true,
  "message": "Operation successful",
  "data": { /* response data */ }
}

Error

{
  "success": false,
  "message": "Error message",
  "error": "Detailed error information"
}

Endpoint Categories

Authentication Endpoints

User registration, login, and wallet management.

• Login

• Register

• Register Wallet

• Verify Wallet

• Sync Supabase User

Task Endpoints

Task creation, retrieval, and management.

• Get Tasks

• Get User Tasks

• Get Accepted Tasks

• Get Task Details

• Create Task

• Complete Task

• Task Stats

Proposal Endpoints

Worker proposals and application management.

• Apply to Task

• Get Task Proposals

• Select Proposal

Escrow Endpoints

Escrow contract creation and status management.

• Create Escrow

• Get Escrow Status

• Save Escrow Secret

• Get Escrow Secret

Message Endpoints

User messaging and communication.

• Get Messages

• Send Message

Dispute Endpoints

Dispute creation and management.

• Create Dispute

• Get User Disputes

• Get Dispute Chat

• Get Dispute Files

• Get Dispute Timeline

User Endpoints

User profile and account management.

• Get User Details

• Get User Profile

• Update User

• Update User Profile

• Get User Public Stats

• Get Completed Tasks Count

• Get User Limits

Transaction Endpoints

Transaction history and management.

• Get User Transactions

• Get User Earnings Summary

• Save Pending Transaction

• Get Pending Transaction

• Submit Complete Transaction

Rating Endpoints

User ratings and reviews.

• Create Rating

• Get Ratings

• Get User Rating Summary

Notification Endpoints

User notifications.

• Get Notifications

• Mark Notification Read

• Get Pending Actions

Cancellation Endpoints

Task cancellation and refunds.

• Check Cancellation Allowed

• Cancel Task

Admin Endpoints

Administrative operations (admin access required).

• Admin Login

• Get Admin Stats

• Get Admin Users

• Get Admin Tasks

• Get Admin Disputes

• Resolve Dispute

• And more...

Platform Endpoints

Platform configuration and status.

• Get Platform Fee

• Get Stats

HTTP Methods

• GET: Retrieve resources

• POST: Create resources or perform actions

• PUT: Update resources (some endpoints)

• DELETE: Delete resources (admin endpoints)

Status Codes

• 200 OK: Successful request

• 201 Created: Resource created successfully

• 400 Bad Request: Invalid request parameters

• 401 Unauthorized: Authentication required or invalid

• 403 Forbidden: Insufficient permissions

• 404 Not Found: Resource not found

• 500 Internal Server Error: Server error

Error Handling

Always check the success field in responses:

const response = await fetch(endpoint);
const data = await response.json();

if (!data.success) {
  // Handle error
  console.error(data.message);
  // data.error may contain additional details
}

Rate Limits

Currently, ArcusX does not enforce strict rate limits. However:

• Implement reasonable request throttling

• Cache responses when appropriate

• Avoid excessive polling

• Respect server resources

Pagination

Some endpoints support pagination:

GET /api/auth/get_tasks.php?page=1&limit=20

Parameters:

• page: Page number (default: 1)

• limit: Items per page (default: 20, max: 100)

Filtering and Sorting

Many endpoints support filtering and sorting via query parameters. See individual endpoint documentation for details.

Data Formats

Dates

Dates are returned in ISO 8601 format: YYYY-MM-DD HH:MM:SS

Currency

All monetary values are in USDC with 7 decimal precision.

Wallet Addresses

Stellar wallet addresses are 56-character strings starting with 'G'.

Contract IDs

Escrow contract IDs are Soroban contract addresses starting with 'C'.

SDK and Libraries

While ArcusX doesn't provide official SDKs, you can use our TypeScript services as a reference:

• Authentication Service: src/services/authService.ts

• Escrow Service: src/services/trustlessWorkEscrowService.ts

• Admin Service: src/services/adminService.ts

Support

For API support:

• Review endpoint-specific documentation

• Check error messages for details

• Review code examples

• Contact support through official channels

Next Steps

• Review Authentication Endpoints

• Explore Task Endpoints

• Study Escrow Endpoints

• Learn about Error Handling