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

# Partner

Partner program management (private)

## Check user qualification

> Check whether a user is affiliated with the partner and verify their qualification status. Weight: 1.

```json
{"openapi":"3.0.3","info":{"title":"Pionex Partner Open API","version":"1.0.0"},"tags":[{"name":"Partner","description":"Partner program management (private)"}],"servers":[{"url":"https://api.pionex.com","description":"Production"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","in":"header","name":"PIONEX-KEY","description":"API Key for authentication. Signature must be provided in PIONEX-SIGNATURE header."}},"parameters":{"Timestamp":{"name":"timestamp","in":"query","required":true,"description":"Request timestamp in milliseconds. Any timestamp older than 20,000 milliseconds or in the future is invalid.","schema":{"type":"integer","format":"int64"}}},"schemas":{"BaseResponse":{"type":"object","properties":{"result":{"type":"boolean","description":"Success indicator"},"timestamp":{"type":"integer","format":"int64","description":"Response timestamp in milliseconds"},"code":{"type":"string","description":"Error code (present only on failure)"},"message":{"type":"string","description":"Error message (present only on failure)"}}},"CheckQualificationResponse":{"type":"object","description":"User qualification check response","properties":{"result":{"type":"boolean","description":"Whether the user is affiliated with the requesting partner"}}}},"responses":{"BadRequest":{"description":"Bad Request - Invalid parameters","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/BaseResponse"}]}}}},"Unauthorized":{"description":"Unauthorized - Missing or invalid API key or signature","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/BaseResponse"}]}}}}}},"paths":{"/api/v1/partner/kol/checkQualification":{"get":{"tags":["Partner"],"summary":"Check user qualification","description":"Check whether a user is affiliated with the partner and verify their qualification status. Weight: 1.","operationId":"checkUserQualification","parameters":[{"$ref":"#/components/parameters/Timestamp"},{"name":"uid","in":"query","required":true,"description":"The user UID to verify affiliation and qualification status","schema":{"type":"string"}},{"name":"bot_id","in":"query","required":true,"description":"The bot/partner identifier making the request","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/BaseResponse"},{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CheckQualificationResponse"}}}]}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"}}}}}}
```

## Get user trading volume

> Query user trading volume statistics for a date range. Weight: 1.

```json
{"openapi":"3.0.3","info":{"title":"Pionex Partner Open API","version":"1.0.0"},"tags":[{"name":"Partner","description":"Partner program management (private)"}],"servers":[{"url":"https://api.pionex.com","description":"Production"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","in":"header","name":"PIONEX-KEY","description":"API Key for authentication. Signature must be provided in PIONEX-SIGNATURE header."}},"parameters":{"Timestamp":{"name":"timestamp","in":"query","required":true,"description":"Request timestamp in milliseconds. Any timestamp older than 20,000 milliseconds or in the future is invalid.","schema":{"type":"integer","format":"int64"}}},"schemas":{"BaseResponse":{"type":"object","properties":{"result":{"type":"boolean","description":"Success indicator"},"timestamp":{"type":"integer","format":"int64","description":"Response timestamp in milliseconds"},"code":{"type":"string","description":"Error code (present only on failure)"},"message":{"type":"string","description":"Error message (present only on failure)"}}},"UserTradingVolumeResponse":{"type":"object","description":"User trading volume statistics response","properties":{"total":{"type":"integer","description":"The number of records returned"},"list":{"type":"array","items":{"$ref":"#/components/schemas/UserTradingStatItem"},"description":"User trading volume list"}}},"UserTradingStatItem":{"type":"object","description":"User trading volume statistic","properties":{"uid":{"type":"string","description":"User's UID"},"account":{"type":"string","description":"User's account"},"perpTradeAmount":{"type":"string","description":"Volume for perpetual trading"},"spotTradeAmount":{"type":"string","description":"Volume for spot trading"}}}},"responses":{"BadRequest":{"description":"Bad Request - Invalid parameters","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/BaseResponse"}]}}}},"Unauthorized":{"description":"Unauthorized - Missing or invalid API key or signature","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/BaseResponse"}]}}}}}},"paths":{"/api/v1/partner/kol/inviteTradeStat":{"get":{"tags":["Partner"],"summary":"Get user trading volume","description":"Query user trading volume statistics for a date range. Weight: 1.","operationId":"getUserTradingVolume","parameters":[{"$ref":"#/components/parameters/Timestamp"},{"name":"startTime","in":"query","required":true,"description":"Query begin time in format YYYY-MM-dd","schema":{"type":"string","format":"date"}},{"name":"endTime","in":"query","required":true,"description":"Query end time in format YYYY-MM-dd","schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/BaseResponse"},{"type":"object","properties":{"data":{"$ref":"#/components/schemas/UserTradingVolumeResponse"}}}]}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"}}}}}}
```