fyi.opensocial.checkImport

lexicons.opensocial.fyi

Documentation

What moving an account here would make of it, before anything moves (importAccount moves it so): its handle here, whether that's the one it has, and its address, this host's own name for it, where its site lives. A handle on a domain of the account's own that still names it comes along; one its old server gives out becomes the address. `refused` says why it can't have that address, as importAccount would.

main query

What moving an account here would make of it, before anything moves (importAccount moves it so): its handle here, whether that's the one it has, and its address, this host's own name for it, where its site lives. A handle on a domain of the account's own that still names it comes along; one its old server gives out becomes the address. `refused` says why it can't have that address, as importAccount would.

Parameters

address string Optional

The label of its address here, if not its handle's first label.

did string did Required

A decentralized identifier (DID).

Output

Encodingapplication/json
address stringhandle Required

An AT Protocol handle (e.g., alice.bsky.social).

did stringdid Required

A decentralized identifier (DID).

from string Optional

The handle it has now.

handle stringhandle Required

Its handle once moved.

keeps boolean Required

Whether that's the handle it has now.

label string Required

No description available.

refused unknown Optional

{error, message}: InvalidHandle or HandleNotAvailable.

Errors

NotPlc
Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Base URL for XRPC calls (e.g., https://api.bsky.social)
Parameters
The label of its address here, if not its handle's first label.
A decentralized identifier (DID).
View raw schema
{
  "description": "What moving an account here would make of it, before anything moves (importAccount moves it so): its handle here, whether that's the one it has, and its address, this host's own name for it, where its site lives. A handle on a domain of the account's own that still names it comes along; one its old server gives out becomes the address. `refused` says why it can't have that address, as importAccount would.",
  "errors": [
    {
      "name": "NotPlc"
    }
  ],
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "address": {
          "format": "handle",
          "type": "string"
        },
        "did": {
          "format": "did",
          "type": "string"
        },
        "from": {
          "description": "The handle it has now.",
          "type": "string"
        },
        "handle": {
          "description": "Its handle once moved.",
          "format": "handle",
          "type": "string"
        },
        "keeps": {
          "description": "Whether that's the handle it has now.",
          "type": "boolean"
        },
        "label": {
          "type": "string"
        },
        "refused": {
          "description": "{error, message}: InvalidHandle or HandleNotAvailable.",
          "type": "unknown"
        }
      },
      "required": [
        "did",
        "handle",
        "address",
        "label",
        "keeps"
      ],
      "type": "object"
    }
  },
  "parameters": {
    "properties": {
      "address": {
        "description": "The label of its address here, if not its handle's first label.",
        "type": "string"
      },
      "did": {
        "format": "did",
        "type": "string"
      }
    },
    "required": [
      "did"
    ],
    "type": "params"
  },
  "type": "query"
}

Lexicon Garden

@