Open app

API reference

Markdown

Get an address’s points

GET/v2/points/{address}

Read an address points balance.

Authentication: None. This route is public.

#Parameters

Name In Type Required Description
address path string Yes Address whose points balance to read.

#Response

200 returns an object with:

  • address · string · required
  • volumeUsd · number · required
  • eligibleOrderVolumeUsd · number · required
  • bonusVolumeUsd · number · required
  • wagyu · number · required
  • rank · number or null · required
  • tradeCount · number · required
  • lastOrderAt · string or null · required
  • formula · object · required
    • pointsPerUsd · number · required
    • label · string · required

Errors use the standard error envelope: branch on code, never on the message.

#Example

curl
curl 'https://api-beta.wagyu.xyz/v2/points/<address>'
JavaScript
const res = await fetch('https://api-beta.wagyu.xyz/v2/points/<address>'
);
const data = await res.json();
Python
import requests

res = requests.get('https://api-beta.wagyu.xyz/v2/points/<address>', timeout=30)
data = res.json()

No response is captured for this route: it needs a real order. The response fields above come from the live contract.

Tip: every page is also plain Markdown, and /llms.txt indexes them for AI tools.