Referrals API · Parchment Docs

Path parameters

addressstringrequired
Wallet address
Pattern^(0[xX])?[0-9a-fA-F]{1,64}$
Example0x77b909b550ed11c45f1378c03c0954c0d77d320cdc938e35509564b1e505ce0d

Query parameters

limitstring
Page size: canonical decimal (digits only, no sign, whitespace or leading zero), 1 to 18446744073709551615, else 400 bad_request; an empty value is omitted.
Pattern^(0|[1-9][0-9]*)$
Example50
directCursorstring
Direct referee cursor (address).
Example0x77b909b550ed11c45f1378c03c0954c0d77d320cdc938e35509564b1e505ce0d
secondLevelCursorstring
Second-level referee cursor (address).
Example0x77b909b550ed11c45f1378c03c0954c0d77d320cdc938e35509564b1e505ce0d

Responses

Direct and second-level binds. estimatedDirectBonus and estimatedSecondBonus are estimates, not settled amounts. The estimate string is forwarded.
application/json
dataReferralsrequired
addressstringrequired
Pattern^0x[0-9a-f]{64}$
Example0x77b909b550ed11c45f1378c03c0954c0d77d320cdc938e35509564b1e505ce0d
asRefereenull | Referrer
asReferrerAsReferrerrequired
The address's referees and estimated bonuses.
directDirectReferee[]required
directCountstringrequired
Pattern^-?(0|[1-9][0-9]*)n$
Example24n
directNextCursorstring | null
Opaque page token for direct_cursor; null on the last page.
estimatedDirectBonusstringrequired
10% of the direct referees' claims.
Pattern^-?(0|[1-9][0-9]*)n$
Example100000000n
estimatedSecondBonusstringrequired
1% of the second-level referees' claims.
Pattern^-?(0|[1-9][0-9]*)n$
Example100000000n
refereeClaimVolumestringrequired
Sum of the referees' claims since they were bound (base units).
Pattern^-?(0|[1-9][0-9]*)n$
Example1850000000000n
secondLevelSecondLevelReferee[]required
secondLevelCountstringrequired
Pattern^-?(0|[1-9][0-9]*)n$
Example24n
secondLevelNextCursorstring | null
Opaque page token for second_level_cursor; null on the last page.
estimatestringrequired
How the bonuses are estimated.
application/json
errorErrorObjectrequired
codestringrequired
messagestringrequired
rate_limited: too many requests from this client IP; retry after Retry-After seconds
application/json
Headers: Retry-After
errorErrorObjectrequired
codestringrequired
messagestringrequired
Bad gateway: the service is temporarily unavailable
application/json
errorErrorObjectrequired
codestringrequired
messagestringrequired

Example request

curl 'https://api.parchment.trade/referrals/0x77b909b550ed11c45f1378c03c0954c0d77d320cdc938e35509564b1e505ce0d'

const res = await fetch("https://api.parchment.trade/referrals/0x77b909b550ed11c45f1378c03c0954c0d77d320cdc938e35509564b1e505ce0d");
const { data } = await res.json();

Example response (200)

application/json

{
  "data": {
    "address": "0x77b909b550ed11c45f1378c03c0954c0d77d320cdc938e35509564b1e505ce0d",
    "asReferee": {
      "boundAtMs": "1796677200000n",
      "referrer": "0x77b909b550ed11c45f1378c03c0954c0d77d320cdc938e35509564b1e505ce0d"
    },
    "asReferrer": {
      "direct": [
        {
          "address": "0x77b909b550ed11c45f1378c03c0954c0d77d320cdc938e35509564b1e505ce0d",
          "boundAtMs": "1796677200000n"
        }
      ],
      "directCount": "24n",
      "directNextCursor": "string",
      "estimatedDirectBonus": "100000000n",
      "estimatedSecondBonus": "100000000n",
      "refereeClaimVolume": "1850000000000n",
      "secondLevel": [
        {
          "address": "0x77b909b550ed11c45f1378c03c0954c0d77d320cdc938e35509564b1e505ce0d",
          "boundAtMs": "1796677200000n",
          "via": "string"
        }
      ],
      "secondLevelCount": "24n",
      "secondLevelNextCursor": "string"
    },
    "estimate": "string"
  }
}