---
title: "SHFE warehouse inventory"
method: GET
path: "/v1/shfe/inventory"
tags: ["Regional"]
---

# SHFE warehouse inventory

`GET /v1/shfe/inventory`

## Request

- Base URL: `https://api.metalcharts.org`
- URL: `https://api.metalcharts.org/v1/shfe/inventory`
- Auth: none declared

Shanghai Futures Exchange warehouse inventory history for a metal. Requires the Pro plan or higher. Every response carries asOf, ageDays and a stale flag, so you can tell a current series from one that has stopped updating without inspecting the array.

## Query parameters

- `symbol` string, required: Required. cu, al, zn, pb, ni, sn, au or ag.
- `range` string: One of 1M, 3M, 6M, 1Y, 5Y or ALL. Defaults to 1Y. ALL returns the whole series, and MAX is accepted as a synonym for it.
- `type` string

## Response `200`

Success.

- object
  - `success` boolean, required
  - `symbol` string
  - `range` string
  - `asOf` string, date
  - `ageDays` number
  - `stale` boolean
  - `count` number
  - `data` object[], required
    - `date` string, date
    - `total` number

## Other responses

- `400`: Invalid parameter.

---

[API](https://skmtc.dev/metalcharts/apis/metalcharts-api.md) · [All operations](https://skmtc.dev/metalcharts/apis/metalcharts-api/llms.txt) · [OpenAPI document](https://skmtc.dev/metalcharts/apis/metalcharts-api/revisions/53d6a0af0479?raw)