# com.suibari.nagi.getCardBoard

> おすそわけボード。図鑑のカードごとにボードに「ある／ない」と、自分が置ける枚数・取れるかを返す。在庫の枚数と提供者は返さない。AAR はボードに無くても botたんの分が常にあり、その額で並ぶ。Ƶ の残高も返す。はじめて開いたときに Ƶ を1回だけ配る。要認証。

- Kind: query
- Authority: nagi.suibari.com
- Lexicon: 1
- Published by [suibari.com](https://lexicon.garden/identity/did:plc:uixgxpiqf4i63p6rgpu7ytmx), the NSID's authority

## Links

- [Documentation](https://lexicon.garden/lexicon/did:plc:uixgxpiqf4i63p6rgpu7ytmx/com.suibari.nagi.getCardBoard)
- [Schema JSON](https://lexicon.garden/lexicon/did:plc:uixgxpiqf4i63p6rgpu7ytmx/com.suibari.nagi.getCardBoard/schema.json)
- [Analytics](https://lexicon.garden/lexicon/did:plc:uixgxpiqf4i63p6rgpu7ytmx/com.suibari.nagi.getCardBoard/analytics)

## Query (`com.suibari.nagi.getCardBoard`)

Type: query · GET

### Output (application/json)

- `balance` (integer, required): 自分の Ƶ 残高。本人にだけ返す。
- `cards` (array, required): 図鑑順の CardBoardEntry。
  - `items` (unknown)
- `welcomeGranted` (integer): 今回はじめての Ƶ を配ったときだけ、その額。

## Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "おすそわけボード。図鑑のカードごとにボードに「ある／ない」と、自分が置ける枚数・取れるかを返す。在庫の枚数と提供者は返さない。AAR はボードに無くても botたんの分が常にあり、その額で並ぶ。Ƶ の残高も返す。はじめて開いたときに Ƶ を1回だけ配る。要認証。",
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "balance": {
              "description": "自分の Ƶ 残高。本人にだけ返す。",
              "type": "integer"
            },
            "cards": {
              "description": "図鑑順の CardBoardEntry。",
              "items": {
                "type": "unknown"
              },
              "type": "array"
            },
            "welcomeGranted": {
              "description": "今回はじめての Ƶ を配ったときだけ、その額。",
              "type": "integer"
            }
          },
          "required": [
            "balance",
            "cards"
          ],
          "type": "object"
        }
      },
      "type": "query"
    }
  },
  "id": "com.suibari.nagi.getCardBoard",
  "lexicon": 1
}
```