Open Interest
Open interest for the futures tracking a commodity.
Endpoint
GET /commodity/v1/openInterest
Authentication: Standard plan. Requires a valid platform API key (X-Primit-API-Key) tied to an active Standard plan (标准套餐) subscription or above. See Authentication.
Query parameters
| Name | Type | Required | Default | Notes |
|---|---|---|---|---|
symbol | string | Yes | — | Commodity code, e.g. XAU (gold), WTI (crude oil). |
period | string | No | 1d | Aggregation period. |
limit | integer | No | 30 | Number of data points to return. |
Response — 200 OK
{
"symbol": "XAU",
"openInterest": "458213",
"time": 1745884800000
}
Errors
| HTTP | Cause |
|---|---|
401 | Missing or invalid X-Primit-API-Key. |
403 | No active Standard plan (subscription expired or never purchased). |
404 | symbol not found. |
422 | Missing symbol. |
Example
curl -s "https://api-dev.pipai.org/commodity/v1/openInterest?symbol=XAU" \
-H "X-Primit-API-Key: $PRIMIT_API_KEY"