> For the complete documentation index, see [llms.txt](https://docs.afx.xyz/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.afx.xyz/api-reference/info/referral.md).

# Referral

## GET /info/referral/code

> Query Referral Code

```json
{"openapi":"3.0.3","info":{"title":"AFX DEX Info API","version":"1.0.0"},"servers":[{"url":"https://api.afx.xyz","description":"Mainnet"},{"url":"https://api-testnet.afx.xyz","description":"Testnet"}],"paths":{"/info/referral/code":{"get":{"operationId":"getReferralCode","summary":"Query Referral Code","tags":["Referral"],"parameters":[{"name":"userAddr","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Referral code info"}}}}}}
```

## GET /info/referral/summary

> Query Referral Summary

```json
{"openapi":"3.0.3","info":{"title":"AFX DEX Info API","version":"1.0.0"},"servers":[{"url":"https://api.afx.xyz","description":"Mainnet"},{"url":"https://api-testnet.afx.xyz","description":"Testnet"}],"paths":{"/info/referral/summary":{"get":{"operationId":"getReferralSummary","summary":"Query Referral Summary","tags":["Referral"],"parameters":[{"name":"userAddr","in":"query","required":true,"schema":{"type":"string"}},{"name":"period","in":"query","schema":{"type":"string","default":"all"}},{"name":"startTime","in":"query","schema":{"type":"integer","format":"int64"}},{"name":"endTime","in":"query","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Referral summary statistics"}}}}}}
```

## GET /info/referral/referrals

> Query Referral List

```json
{"openapi":"3.0.3","info":{"title":"AFX DEX Info API","version":"1.0.0"},"servers":[{"url":"https://api.afx.xyz","description":"Mainnet"},{"url":"https://api-testnet.afx.xyz","description":"Testnet"}],"paths":{"/info/referral/referrals":{"get":{"operationId":"getReferrals","summary":"Query Referral List","tags":["Referral"],"parameters":[{"name":"userAddr","in":"query","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","schema":{"type":"integer","default":1}},{"name":"size","in":"query","schema":{"type":"integer","default":10}},{"name":"sortBy","in":"query","schema":{"type":"string","default":"dateJoined"}},{"name":"sortOrder","in":"query","schema":{"type":"string","default":"desc"}},{"name":"search","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Paginated referral list"}}}}}}
```

## GET /info/referral/payouts

> Query Referral Payouts

```json
{"openapi":"3.0.3","info":{"title":"AFX DEX Info API","version":"1.0.0"},"servers":[{"url":"https://api.afx.xyz","description":"Mainnet"},{"url":"https://api-testnet.afx.xyz","description":"Testnet"}],"paths":{"/info/referral/payouts":{"get":{"operationId":"getPayouts","summary":"Query Referral Payouts","tags":["Referral"],"parameters":[{"name":"userAddr","in":"query","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","schema":{"type":"integer","default":1}},{"name":"size","in":"query","schema":{"type":"integer","default":10}}],"responses":{"200":{"description":"Paginated payout list"}}}}}}
```

## Query Referral Tiers

> Returns referral tier configuration (no parameters).

```json
{"openapi":"3.0.3","info":{"title":"AFX DEX Info API","version":"1.0.0"},"servers":[{"url":"https://api.afx.xyz","description":"Mainnet"},{"url":"https://api-testnet.afx.xyz","description":"Testnet"}],"paths":{"/info/referral/tiers":{"get":{"operationId":"getTierConfigs","summary":"Query Referral Tiers","tags":["Referral"],"description":"Returns referral tier configuration (no parameters).","responses":{"200":{"description":"Tier config list"}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.afx.xyz/api-reference/info/referral.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.