Aquanode Referrals API
The Referrals API from Aquanode — 4 operation(s) for referrals.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/aquanode-io:aquanode-io-referrals-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
version: 1.0.0
title: Aquanode Orchestrator Referrals API
description: API documentation for the Aquanode deployment orchestrator.
servers:
- url: /api/v1
tags:
- name: Referrals
paths:
/referrals/code:
get:
summary: Get user referral code
description: Retrieves the current user's unique referral code.
tags:
- Referrals
security:
- BearerAuth: []
responses:
'200':
description: Referral code retrieved successfully
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
data:
type: object
properties:
code:
type: string
example: AQUA123
required:
- code
message:
type: string
example: Operation successful
timestamp:
type: string
example: '2026-11-09T19:02:47.340Z'
required:
- success
- data
- timestamp
'401':
description: Unauthorized
'404':
description: Referral code not found
operationId: getReferralsCode
x-operation-id-source: derived
/referrals/stats:
get:
summary: Get referral statistics
description: Retrieves statistics about the user's referrals, including count and rewards.
tags:
- Referrals
security:
- BearerAuth: []
responses:
'200':
description: Referral stats retrieved successfully
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
data:
type: object
properties:
totalReferrals:
type: number
example: 5
activeReferrals:
type: number
example: 3
totalRewards:
type: number
example: 150.5
required:
- totalReferrals
- activeReferrals
- totalRewards
message:
type: string
example: Operation successful
timestamp:
type: string
example: '2026-11-09T19:02:47.340Z'
required:
- success
- data
- timestamp
'401':
description: Unauthorized
'404':
description: Referral stats not found
operationId: getReferralsStats
x-operation-id-source: derived
/referrals/history:
get:
summary: Get referral history
description: Retrieves the list of users who signed up with the caller's referral code, with masked emails, per-referral payout status, and credits earned.
tags:
- Referrals
security:
- BearerAuth: []
responses:
'200':
description: Referral history retrieved successfully
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
data:
type: array
items:
type: object
properties:
referred_user:
type: string
example: pr***@***.com
status:
type: string
enum:
- paid
- pending
example: paid
signup_bonus_amount:
type: number
example: 50
first_payment_bonus_amount:
type: number
example: 500
earned_credits:
type: number
example: 550
signed_up_at:
type: string
example: '2026-04-14T10:00:00.000Z'
required:
- referred_user
- status
- signup_bonus_amount
- first_payment_bonus_amount
- earned_credits
- signed_up_at
message:
type: string
example: Operation successful
timestamp:
type: string
example: '2026-11-09T19:02:47.340Z'
required:
- success
- data
- timestamp
'401':
description: Unauthorized
operationId: getReferralsHistory
x-operation-id-source: derived
/referrals/apply:
post:
summary: Apply a referral code
description: Allows a new user to apply a referral code within the allowed window.
tags:
- Referrals
security:
- BearerAuth: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ApplyReferralCode'
responses:
'200':
description: Referral code applied successfully
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
data:
type: string
example: Referral code applied successfully
message:
type: string
example: Operation successful
timestamp:
type: string
example: '2026-11-09T19:02:47.340Z'
required:
- success
- data
- timestamp
'400':
description: Invalid request data or window expired
'401':
description: Unauthorized
operationId: postReferralsApply
x-operation-id-source: derived
components:
schemas:
ApplyReferralCode:
type: object
properties:
referralCode:
type: string
minLength: 1
maxLength: 20
description: The referral code to apply
example: AQUA123
required:
- referralCode
securitySchemes:
BearerAuth:
type: http
scheme: bearer
bearerFormat: aq_sk_ API key
description: 'An Aquanode API key, created under API keys in the console, sent as `Authorization: Bearer aq_sk_...` (or in the `x-api-key` header). A key is scoped to the team that created it; mutating routes need a key with the `deploy` or `full` scope.'