--- updatedAt: 2025-06-16T21:07:17.000Z agentTools: projectIndex: https://dev.fio.net/llms.txt --- # Check availability Checks if a FIO Handle or FIO Domain is available for registration. # OpenAPI definition ```json { "openapi": "3.0.0", "x-stoplight": { "id": "0arqsww8kj7jl" }, "info": { "title": "FIO Chain Getters API", "version": "1.9", "contact": { "url": "http://fioprotocol.io", "name": "FIO", "email": "getinfo@fioprotocol.io" }, "license": { "name": "MIT", "url": "https://opensource.org/license/mit/" }, "description": "FIO Chain Getter API offers multiple endpoints design to return information about the FIO Chain or specific FIO Handles, FIO Requests, FIO Data, NFT Signatures, or FIO Chain accounts.\n\nThere are many FIO Chain API servers ran by Block Producers and other entities. For latest server API urls, see https://github.com/fioprotocol/fio.mainnet#fio-api\n\nYou may also choose to run your own FIO Chain API node." }, "servers": [ { "url": "https://test.fio.eosusa.io/v1/chain", "description": "Testnet" }, { "url": "https://fio.blockpane.com/v1/chain", "description": "Mainnet" } ], "tags": [ { "name": "FIO Handle", "description": "API calls to return information tied to FIO Handle" } ], "paths": { "/avail_check": { "parameters": [], "post": { "summary": "Check availability", "operationId": "avail_check", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "is_registered": { "type": "integer", "minimum": 0, "maximum": 1, "description": "1 - FIO Handle or Domain is registered; 0 - FIO Handle or Domain is not registered.\r\n\r\n" } }, "required": [ "is_registered" ] }, "examples": { "Success": { "value": { "is_registered": 1 } } } } } }, "400": { "$ref": "#/components/responses/Error400" }, "404": { "$ref": "#/components/responses/Error404" } }, "description": "Checks if a FIO Handle or FIO Domain is available for registration.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "fio_name" ], "properties": { "fio_name": { "type": "string", "description": "FIO Handle or FIO Domain to check.\r\n", "default": "purse@alice", "example": "purse@alice" } } }, "examples": { "Example 1": { "value": { "fio_name": "purse@alice" } } } } }, "description": "" }, "tags": [ "FIO Handle" ], "x-stoplight": { "id": "hw9w7tjimz9ol" } } } }, "components": { "responses": { "Error400": { "description": "HTTP code 400 is returned when request was malformed or contained improper values. The response body will indicate the name of the incorrect field, its type, and the value the service received.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "x-stoplight": { "id": "4j4mgwukbxxa7" }, "type": "string", "default": "invalid_input" }, "message": { "type": "string", "x-stoplight": { "id": "lqhqbc71twejf" }, "default": "An invalid request was sent in, please check the nested errors for details." }, "fields": { "type": "object", "x-stoplight": { "id": "u984g5pvenewm" }, "properties": { "name": { "type": "string", "x-stoplight": { "id": "9nj27sjxp11mq" } }, "value": { "type": "string", "x-stoplight": { "id": "fkejlq13tyxfk" } }, "error": { "type": "string", "x-stoplight": { "id": "nurkwro0d4spc" } } } } } }, "examples": { "Invalid FIO Address": { "value": { "type": "invalid_input", "message": "An invalid request was sent in, please check the nested errors for details.", "fields": { "name": "fio_address", "value": "bob", "error": "Invalid FIO Address" } } }, "Invalid Chain Code": { "value": { "type": "invalid_input", "message": "An invalid request was sent in, please check the nested errors for details.", "fields": { "name": "chain_code", "value": "+", "error": "Invalid Chain Code" } } }, "Invalid Token Code": { "value": { "type": "invalid_input", "message": "An invalid request was sent in, please check the nested errors for details.", "fields": { "name": "token_code", "value": "", "error": "Invalid Token Code" } } }, "Invalid Limit": { "value": { "type": "invalid_input", "message": "An invalid request was sent in, please check the nested errors for details.", "fields": { "name": "limit", "value": "x", "error": "Invalid limit" } } }, "Invalid Offset": { "value": { "type": "invalid_input", "message": "An invalid request was sent in, please check the nested errors for details.", "fields": { "name": "offset", "value": "x", "error": "Invalid offset" } } }, "FIO Address does not exist": { "value": { "type": "invalid_input", "message": "An invalid request was sent in, please check the nested errors for details.", "fields": { "name": "fio_address", "value": "bob@empty", "error": "FIO Address does not exist" } } }, "Invalid Contract Address": { "value": { "type": "invalid_input", "message": "An invalid request was sent in, please check the nested errors for details.", "fields": { "name": "contract_address", "value": "0123456789012345678901234567890123456789012345678901234567890123456789", "error": "Invalid Contract Address" } } }, "Invalid FIO Public Key": { "value": { "type": "invalid_input", "message": "An invalid request was sent in, please check the nested errors for details.", "fields": { "name": "fio_public_key", "value": "FIO123", "error": "Invalid FIO Address" } } }, "Invalid FIO Name": { "value": { "type": "invalid_input", "message": "An invalid request was sent in, please check the nested errors for details.", "fields": { "name": "fio_name", "value": "_.@", "error": "Invalid FIO Name" } } }, "Invalid account": { "value": { "type": "invalid_input", "message": "An invalid request was sent in, please check the nested errors for details.", "fields": { "name": "account", "value": "!@#$", "error": "Format of FIO Account not valid." } } }, "Invalid Grantee Account": { "value": { "type": "invalid_input", "message": "An invalid request was sent in, please check the nested errors for details.", "fields": { "name": "grantee_account", "value": "-123", "error": "Invalid account." } } }, "Invalid Object Name": { "value": { "type": "invalid_input", "message": "An invalid request was sent in, please check the nested errors for details.", "fields": { "name": "object_name", "value": "123", "error": "Object Name is invalid." } } }, "Invalid Permission Name": { "value": { "type": "invalid_input", "message": "An invalid request was sent in, please check the nested errors for details.", "fields": { "name": "permission_name", "value": "123", "error": "Permission Name is invalid." } } } } } } }, "Error404": { "description": "HTTP code 404 is returned when the requested information could not be found.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "x-stoplight": { "id": "bok8iqdel2p7x" } } } }, "examples": { "Public key not found": { "value": { "message": "Public key not found" } }, "NFTs not found": { "value": { "message": "NFTs not found" } }, "No FIO Addresses": { "value": { "message": "No FIO Addresses" } }, "No FIO Domains": { "value": { "message": "No FIO Domains" } }, "No lock tokens in account": { "value": { "message": "No lock tokens in account" } }, "Account not found": { "value": { "message": "Account not found" } }, "No permissions": { "value": { "message": "Permissions not found." } } } } } } } }, "security": [], "x-readme": { "explorer-enabled": true, "proxy-enabled": true } } ```