Analytics Performance Growth Community Ecosystem
Developer Docs

API Reference

Integrate Octagon's platform data into your own applications with our RESTful API.

Overview

The Octagon API allows developers to programmatically access platform data including investment plans, portfolio balances, transaction history, and referral statistics. All responses are in JSON format.

Base URL

https://api.octagoninvestment.org/v1

Authentication

All API requests require an API key passed in the request header. Obtain your key from your dashboard under Settings → API Access.

HEADERAuthorization: Bearer YOUR_API_KEY

Rate Limits

60
Requests / minute
1,000
Requests / hour
10,000
Requests / day

Error Codes

CodeMeaningDescription
200 OK Request succeeded
400 Bad Request Invalid parameters
401 Unauthorized Missing or invalid API key
403 Forbidden Action not permitted for this key
404 Not Found Resource does not exist
429 Too Many Requests Rate limit exceeded
500 Server Error Internal server error — contact support

Endpoints

GET /v1/plans

List Investment Plans

Returns all available investment plans with their rates and limits.

Example Response
{"plans":[{"id":1,"name":"Starter","min":50,"max":999,"daily_roi":"1.5","duration_days":30}]}
GET /v1/portfolio

Get User Portfolio

Returns the authenticated user's current portfolio balance and active investments.

Example Response
{"balance":"1500.00","active_plans":[{"plan":"Silver","invested":"1000.00","earned":"45.00"}]}
POST /v1/deposit

Submit Deposit Request

Creates a new deposit request. Requires amount and currency.

Request Body
{"amount":1000,"currency":"USDT_TRC20"}
Example Response
{"status":"pending","deposit_id":482,"message":"Awaiting admin review"}
GET /v1/withdrawals

List Withdrawals

Returns the user's withdrawal history.

Example Response
{"withdrawals":[{"id":12,"amount":"200.00","status":"approved","date":"2025-03-10"}]}
GET /v1/referrals

Referral Statistics

Returns referral count, earnings, and referral code.

Example Response
{"code":"AB12CD34","referrals":8,"earnings":"120.00"}

Webhooks

Configure webhooks in your dashboard to receive real-time event notifications via HTTP POST to your endpoint.

Events

deposit.approved deposit.rejected withdrawal.approved withdrawal.rejected roi.credited referral.joined

Example Payload

{"event":"deposit.approved","data":{"user_id":123,"amount":"500.00","currency":"USDT_TRC20","timestamp":"2025-06-01T12:00:00Z"}}

Need API Access?

API keys are available to verified Octagon members. Generate yours from your account dashboard or contact our developer support team.

Get API Key Developer Support