Get apiv1referrals - XOXNO Docs

GET

/

api

/

v1

/

referrals

/

{id}

cURL

curl --request GET \
  --url https://stellar-swap.xoxno.com/api/v1/referrals/{id}

const options = {method: 'GET'};

fetch('https://stellar-swap.xoxno.com/api/v1/referrals/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "active": true,
  "feePolicy": "<string>",
  "id": "<string>",
  "staticFeeBps": 1,
  "whitelistedTokens": [
    "<string>"
  ],
  "referralFeeBps": 1,
  "totalFeeBps": 1
}

{
  "code": "<string>",
  "error": "<string>"
}

{
  "code": "<string>",
  "error": "<string>"
}

{
  "code": "<string>",
  "error": "<string>"
}

Path Parameters

id

string

required

Unsigned u32 decimal referral ID; 0 means no referral

Response

Active referral fee, from the quote cache (up to 60 seconds old); cache misses query RPC

active

boolean

required

An active referral was found. False includes missing and inactive IDs; ID zero is the no-referral sentinel, not a registered referral.

feePolicy

string

required

Input unless the output is whitelisted and the input is not.

id

string

required

Referral identifier as a decimal string.

staticFeeBps

integer<int32>

required

Cached router admin fee, charged only with an active nonzero referral.

Required range: x >= 0

whitelistedTokens

string[]

required

Cached token whitelist used by the quote fee calculation.

referralFeeBps

integer<int32> | null

Active referral fee; null when no active referral was found.

Required range: x >= 0

totalFeeBps

integer<int32> | null

Zero for id zero; null for missing/inactive referrals.

Required range: x >= 0

cURL

curl --request GET \
  --url https://stellar-swap.xoxno.com/api/v1/referrals/{id}

const options = {method: 'GET'};

fetch('https://stellar-swap.xoxno.com/api/v1/referrals/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "active": true,
  "feePolicy": "<string>",
  "id": "<string>",
  "staticFeeBps": 1,
  "whitelistedTokens": [
    "<string>"
  ],
  "referralFeeBps": 1,
  "totalFeeBps": 1
}

{
  "code": "<string>",
  "error": "<string>"
}

{
  "code": "<string>",
  "error": "<string>"
}

{
  "code": "<string>",
  "error": "<string>"
}