> For the complete documentation index, see [llms.txt](/llms.txt).

# `pin_ls`

## `/api/v0/pin/ls`[​](#apiv0pinls "Direct link to apiv0pinls")

Lists objects pinned to local storage.

### Request[​](#request "Direct link to Request")

- Syntax
- Example

```
curl "https://ipfs.infura.io:5001/api/v0/pin/ls?arg=<ipfs-path>&type=all&quiet=<value>&stream=<value>" \
  -X POST \
  -u "<YOUR-API-KEY>:<YOUR-API-KEY-SECRET>"

```

```
curl "https://ipfs.infura.io:5001/api/v0/pin/ls?arg=QmfQ5QAjvg4GtA3wg3adpnDJug8ktA1BxurVqBD8rtgVjM" \
  -X POST \
  -u "<YOUR-API-KEY>:<YOUR-API-KEY-SECRET>"

```

#### Request parameters[​](#request-parameters "Direct link to Request parameters")

- `arg` _[Optional]_ - Path to objects to be listed.
- `type` _[Optional]_ - The type of pinned keys to list. Can be `direct`, `indirect`, `recursive`, or `all`. The default is `all`.
- `quiet` _[Optional]_ - Write just hashes of objects.
- `stream` _[Optional]_ - Enable streaming of pins as they are discovered.

### Response[​](#response "Direct link to Response")

On success, the call to this endpoint returns with 200 and the following body:

#### Body[​](#body "Direct link to Body")

```
{
  "PinLsList": {
    "Keys": {
      "<string>": {
        "Type": "string"
      }
    }
  },
  "PinLsObject": {
    "Cid": "string",
    "Type": "string"
  }
}

```