Overview

The Redox API provides a RESTful interface to manage core resources.

All endpoints return JSON responses and follow standard HTTP methods such as GET, POST, PATCH, and DELETE.

Use this documentation to explore available endpoints, understand request parameters, and test API calls directly from the interface.

Base URL

{URL_API_REDOX}/api/v1

URL MCP (AI Agent)

Our API is compatible with MCP AI agents.

{URL_API_REDOX}/mcp

Authentication

All requests must include a Bearer token in the Authorization header.

Authorization: Bearer {YOUR_API_KEY}

Quick Start

Here is a simple example showing how to retrieve the list of addresses.

Node.js

const axios = require("axios")

const res = await axios.get(
  "https://{url_api_redox}/api/v1/addresses",
  {
    headers: {
      Authorization: "Bearer {YOUR_API_KEY}"
    }
  }
)

console.log(res.data)

cURL

curl "https://{url_api_redox}/api/v1/addresses" \
-H "Authorization: Bearer {YOUR_API_KEY}"

Example Response

{
  "meta": {
    "page": 1,
    "limit_rows": 500,
    "total_pages": 1,
    "total_rows": 1
  },
  "items": []
}

Error Codes

200 : 'OK'              // Success
201 : 'CREATED'         // Resource created
400 : 'BAD_REQUEST'     // Bad request
401 : 'UNAUTHORIZED'    // Not authorized
403 : 'FORBIDDEN'       // Forbidden
404 : 'NOT_FOUND'       // Not found
409 : 'CONFLICT'        // Conflict
413 : 'LIMIT_FILE_SIZE' // File too large
500 : 'SERVER_ERROR'    // Internal server error