# fyi.opensocial.checkAddress

> Whether an address under this host's domain is free for a new group: no account's handle here, nor kept by a group as its address after it took a handle of its own. Anyone may ask, as anyone may resolve a handle.

- Kind: query
- Authority: opensocial.fyi
- Lexicon: 1
- Published by [lexicons.opensocial.fyi](https://lexicon.garden/identity/did:plc:2gqnilpksz2e7faj3bwvo6qc), the NSID's authority

## Links

- [Documentation](https://lexicon.garden/lexicon/did:plc:2gqnilpksz2e7faj3bwvo6qc/fyi.opensocial.checkAddress)
- [Schema JSON](https://lexicon.garden/lexicon/did:plc:2gqnilpksz2e7faj3bwvo6qc/fyi.opensocial.checkAddress/schema.json)
- [Analytics](https://lexicon.garden/lexicon/did:plc:2gqnilpksz2e7faj3bwvo6qc/fyi.opensocial.checkAddress/analytics)

## Query (`fyi.opensocial.checkAddress`)

Type: query · GET

### Parameters (query string)

- `address` (string, required): One label under this host's domain, as describeServer names it: riders.groups.test.
  - Constraints: maxLength: 253

### Output (application/json)

- `address` (string, required): The address, lowercased.
  - Constraints: maxLength: 253
- `available` (boolean, required): Whether a new group may take it.

## Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Whether an address under this host's domain is free for a new group: no account's handle here, nor kept by a group as its address after it took a handle of its own. Anyone may ask, as anyone may resolve a handle.",
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "address": {
              "description": "The address, lowercased.",
              "maxLength": 253,
              "type": "string"
            },
            "available": {
              "description": "Whether a new group may take it.",
              "type": "boolean"
            }
          },
          "required": [
            "address",
            "available"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {
          "address": {
            "description": "One label under this host's domain, as describeServer names it: riders.groups.test.",
            "maxLength": 253,
            "type": "string"
          }
        },
        "required": [
          "address"
        ],
        "type": "params"
      },
      "type": "query"
    }
  },
  "id": "fyi.opensocial.checkAddress",
  "lexicon": 1
}
```