# pet.trezy.getLeaderboard

> Published by [trezy.pet](https://lexicon.garden/identity/did:plc:ollch4g7tes2reb5eceiwuol)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:ollch4g7tes2reb5eceiwuol/pet.trezy.getLeaderboard)
- [Documentation](https://lexicon.garden/lexicon/did:plc:ollch4g7tes2reb5eceiwuol/pet.trezy.getLeaderboard/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:ollch4g7tes2reb5eceiwuol/pet.trezy.getLeaderboard/examples)

## Definitions

### `pet.trezy.getLeaderboard`

**Type**: `query`

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `limit` | `integer` | No |  |
| `cursor` | `string` | No |  |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `cursor` | `string` | No |  |
| `entries` | `array` | Yes |  |

### `pet.trezy.getLeaderboard#entry`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `did` | `string` (did) | Yes |  |
| `pet` | `string` (at-uri) | Yes |  |
| `name` | `string` | Yes |  |
| `level` | `integer` | Yes |  |
| `score` | `integer` | Yes |  |
| `species` | `string` | Yes |  |

## Raw Schema

```json
{
  "id": "pet.trezy.getLeaderboard",
  "defs": {
    "main": {
      "type": "query",
      "output": {
        "schema": {
          "type": "object",
          "required": [
            "entries"
          ],
          "properties": {
            "cursor": {
              "type": "string"
            },
            "entries": {
              "type": "array",
              "items": {
                "ref": "#entry",
                "type": "ref"
              }
            }
          }
        },
        "encoding": "application/json"
      },
      "parameters": {
        "type": "params",
        "properties": {
          "limit": {
            "type": "integer",
            "default": 25,
            "maximum": 50,
            "minimum": 1
          },
          "cursor": {
            "type": "string"
          }
        }
      }
    },
    "entry": {
      "type": "object",
      "required": [
        "did",
        "pet",
        "species",
        "name",
        "score",
        "level"
      ],
      "properties": {
        "did": {
          "type": "string",
          "format": "did"
        },
        "pet": {
          "type": "string",
          "format": "at-uri"
        },
        "name": {
          "type": "string"
        },
        "level": {
          "type": "integer"
        },
        "score": {
          "type": "integer"
        },
        "species": {
          "type": "string"
        }
      }
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```