kylefang/stacks-puppet-node

Fork 0

mirror of https://github.com/alexgo-io/stacks-puppet-node.git synced 2026-04-14 22:20:17 +08:00

Files

Aaron Blankstein 9a3cf9c114 update api doc

2018-06-20 17:49:49 -04:00

55 KiB

Raw Blame History

Group Core Node Administration

Ping the node [GET /v1/node/ping]

Ping the Blockstack node to see if it's alive.

Public Endpoint

Response 200 (application/json)

Body

    {
        "status": "alive", 
        "version": "###version###"
    }

Schema

    {
         'type': 'object',
         'properties': {
             'status': {
                 'type': 'string'
             },
             'version': {
                 'type': 'string'
             },
         },
         'required': [
             'status',
             'version'
         ]
    }

Test $ curl https://localhost:16268/v1/node/ping

Group Managing Zone Files

This family of API endpoints deals with zone files stored in Blockstack's peer network.

Fetch zone file [GET /v1/names/{name}/zonefile?raw={raw}]

Fetch a user's raw zone file. Only works with RFC-compliant zone files, unless raw=true is passed.

Public Endpoint
Parameters
- name: hello.id (string) - fully-qualified name
- raw: true (enum[string], optional) - return a raw zone file as an octet-stream.
Test Setup $ printf '$ORIGIN hello.id\n$TTL 3600\n_http._tcp URI 10 1 "https://gaia.blockstack.org/hub/1EovsUFuGnmHspAWxr5YhT6ohZziQ1ioRJ/0/profile.json"\n' > "$BLOCKSTACK_DOCTEST_DIR/hello.id.zonefile $ blockstack-cli -t register hello.id "$BLOCKSTACK_DOCTEST_DIR/hello.id.zonefile" $ curl -X POST --data-urlencode ""$BLOCKSTACK_WEB_TEST"/nextblock

Response 200 (application/json)

Body

    { 
       "zonefile": "$ORIGIN hello.id\n$TTL 3600\n_http._tcp URI 10 1 \"https://gaia.blockstack.org/hub/1EovsUFuGnmHspAWxr5YhT6ohZziQ1ioRJ/0/profile.json\"\n"
    }

Schema

    {
      'type': 'object',
      'properties': {
          'zonefile': {
              'type': 'string',
              'pattern': '.+',
          },
       }
    }

Test $ curl

Response 200 (application/octet-stream)

Body

  $ORIGIN hello.id
  $TTL 3600
  _http._tcp URI 10 1 "https://gaia.blockstack.org/hub/1EovsUFuGnmHspAWxr5YhT6ohZziQ1ioRJ/0/profile.json"

Response 400 (application/json)

Body

  {
     "error": "Invalid name or subdomain"
  }

Schema

  {
     'type': 'object',
     'properties': {
         'error': {
            'type': 'string',
            'pattern': '.+',
          },
      },
      'required': [
          'error'
      ]
  }

Response 404 (application/json)

Body
```
  {
    "error": "Not found."
  }
```

Schema

  {
     'type': 'object',
     'properties': {
         'error': {
            'type': 'string',
            'pattern': '.+',
          },
      },
      'required': [
          'error'
      ]
  }

Publish a zone file [POST /v1/zonefile]

Publish an already-announced zone file to the Blockstack peer network. Once uploaded, this Blockstack Core node will asynchronously replicate the zone file to all other Blockstack Core nodes. Eventually, every Blockstack Core node will have a copy of the zone file. Please see the Atlas Network Documentation for details on how this works.

This method supports two modes of encoding zone files, depending on whether or not the zone file is JSON-serializable. If it is JSON-serializable, then it can be uploaded as {'zonefile': ...}. Otherwise, it must be base64-encoded first, and must be uploaded as {'zonefile_b64': ...}.

This method only succeeds if the zone file's hash corresponds to the zone file hash of an existing name in the system. It will succeed even if the name is expired.

Public Endpoint

Request (application/json)

Body

    {
        "zonefile": "$ORIGIN muneeb.id\n$TTL 3600\n_http._tcp URI 10 1 \"https://gaia.blockstack.org/hub/1J3PUxY5uDShUnHRrMyU6yKtoHEUPhKULs/0/profile.json\"\n"
    }

Schema

    {
        'type': 'object',
        'properties': {
            'zonefile': {
                'type': 'string',
                'maxLength': 40960,
            },
        }
        'required': [   
            'zonefile'
        ]
    }

Response 200 (application/json)

Body
```
    {
        'status': true
    }
```

Schema

    {
         'type': 'object',
         'properties': {
             'status': {
                 'type': boolean
             }
         },
         'required': [
             'status'
         ]
    }

Response 400 (application/json)

Body

  {
       'error': 'Invalid request'
  }

Schema

  {
       'type': 'object',
       'properties': {
           'error': {
               'type': 'string'    
           }
       },
       'required': [
           'error'
       ]
  }

Response 400 (application/json)

Body

  {
       'error': 'Blockstack node did not save the zone file' 
  }

Schema

  {
       'type': 'object',
       'properties': {
           'error': {
               'type': 'string'    
           }
       },
       'required': [
           'error'
       ]
  }

Request (application/json)

Body

    {
        "zonefile_b64": "IG11bmVlYi5pZFxuIDM2MDBcbl9odHRwLl90Y3AgVVJJIDEwIDEgImh0dHBzOi8vZ2FpYS5ibG9ja3N0YWNrLm9yZy9odWIvMUozUFV4WTV1RFNoVW5IUnJNeVU2eUt0b0hFVVBoS1VMcy8wL3Byb2ZpbGUuanNvbiJcbgo="
    }

Schema

    {
        'type': 'object',
        'properties': {
            'zonefile_b64': {
                'type': 'string',
                'pattern': '^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$'
                'maxLength': 54614,
            }
        },
        'required': [
            'zonefile'
        ]
    }

Response 200 (application/json)

Body
```
    {
        'status': true
    }
```

Schema

    {
         'type': 'object',
         'properties': {
             'status': {
                 'type': boolean
             }
         },
         'required': [
             'status'
         ]
    }

Response 400 (application/json)

Body

  {
       'error': 'Invalid request'
  }

Schema

  {
       'type': 'object',
       'properties': {
           'error': {
               'type': 'string'    
           }
       },
       'required': [
           'error'
       ]
  }

Response 400 (application/json)

Body

  {
       'error': 'Blockstack node did not save the zone file' 
  }

Schema

  {
       'type': 'object',
       'properties': {
           'error': {
               'type': 'string'    
           }
       },
       'required': [
           'error'
       ]
  }

Group Name Querying

This family of API endpoints deals with querying name information.

Get all names [GET /v1/names?page={page}]

Fetch a list of all names known to the node.

Public Endpoint
Parameters
- page: 23 (number) - names are returned in pages of size 100, so specify the page number.

Response 200 (application/json)

Body

    [
        "aldenquimby.id", 
        "aldeoryn.id",
        "alderete.id",
        "aldert.id",
        "aldi.id",
        "aldighieri.id",
        ...
    ]

Schema

    {
       'type': 'array',
       'items': {
             'type': 'string',
             'pattern': r'^([a-z0-9\\-_.+]{3,37})$',
       }
    }

Get all subdomains [GET /v1/subdomains?page={page}]

Fetch a list of all names known to the node.

Public Endpoint
Parameters
- page: 3 (number) - names are returned in pages of size 100, so specify the page number.

Response 200 (application/json)

Body

    [
          "collegeinfogeek.verified.podcast",
          "collider.verified.podcast",
          "combatandclassics.verified.podcast",
          "combatjack.verified.podcast",
          "comedybangbang.verified.podcast",
          "comedybutton.verified.podcast",
          "commonsense.verified.podcast",
          "concilio002.personal.id", 
          ... 
    ]

Schema

    {
       'type': 'array',
       'items': {
            'type': 'string',
            'pattern': r'^([a-z0-9\\-_.+]{3,37})\.([a-z0-9\\-_.+]{3,37})$',
       }
    }

Get name info [GET /v1/names/{name}]

Public Endpoint
Subdomain Aware
Parameters
- name: muneeb.id (string) - fully-qualified name

Response 200 (application/json)

Body

    {
        "address": "1QJQxDas5JhdiXhEbNS14iNjr8auFT96GP", 
        "blockchain": "bitcoin", 
        "expire_block": 489247, 
        "last_txid": "1edfa419f7b83f33e00830bc9409210da6c6d1db60f99eda10c835aa339cad6b", 
        "status": "registered", 
        "zonefile": "$ORIGIN muneeb.id\n$TTL 3600\n_http._tcp IN URI 10 1 \"https://blockstack.s3.amazonaws.com/muneeb.id\"\n", 
        "zonefile_hash": "b100a68235244b012854a95f9114695679002af9"
    }

Schema

    {
         'type': 'object',
         'properties': {
           'address': {
               'type': 'string',
               'pattern': r"^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]+)$", 
           },
           'blockchain': {
               'type': 'string',
               'pattern': '^bitcoin$',
           },
           'expire_block': {
               'type': 'integer',
               'minimum': 0,
           },
           'last_txid': {
               'type': 'string',
               'pattern': '^[0-9a-fA-F]+$',
           },
           'status': {
               'type': 'string',
               'pattern': '^(registered|revoked)$',
           },
           'zonefile': {
               'anyOf': [
                  {
                      'type': 'string',
                  },
                  {
                      'type': 'object',
                      'properties': {
                          'error': {
                              'type': 'string',
                          },
                      },
                  },
               ],
           },
           'zonefile_hash': {
               'type': 'string',
               'pattern': '^[0-9a-fA-F]{20}$`,
           },
         },
         'required': [
             'address',
              'blockchain',
              'last_txid',
              'status',
              'zonefile',
              'zonefile_hash'
         ]
    }

Name history [GET /v1/names/{name}/history?page={page}]

Get a history of all blockchain records of a registered name.

Public Endpoint
Subdomain aware
Parameters
- name: muneeb.id (string) - name to query
- page: 0 (integer) - the page (in 20-entry pages) of the history to fetch

Response 200 (application/json)

Body

    {
      "373821": [
        {
          "address": "1QJQxDas5JhdiXhEbNS14iNjr8auFT96GP", 
          "block_number": 373821, 
          "consensus_hash": null, 
          "first_registered": 373821, 
          "importer": "76a9143e2b5fdd12db7580fb4d3434b31d4fe9124bd9f088ac", 
          "importer_address": "16firc3qZU97D1pWkyL6ZYwPX5UVnWc82V", 
          "last_creation_op": ";", 
          "last_renewed": 373821, 
          "name": "muneeb.id", 
          "name_hash128": "deb7fe99776122b77925cbf0a24ab6f8", 
          "namespace_block_number": 373601, 
          "namespace_id": "id", 
          "op": ";", 
          "op_fee": 100000.0, 
          "opcode": "NAME_IMPORT", 
          "preorder_block_number": 373821,
         }
       ]
    }

Schema

    {
       'type': 'object',
       'patternProperties': {
         '^[0-9]+': {
           'type': 'array',
           'items': {
              'type': 'object',
              "properties": {
                  "address": {
                      "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{1,35})$",
                      "type": "string"
                  },
                  "base": {
                      "maximum": 255,
                      "minimum": 0,
                      "type": "integer"
                  },
                  "block_number": {
                      "minimum": 0,
                      "type": "integer"
                  },
                  "buckets": {
                      "anyOf": [
                          {
                              "pattern": "^\\[((0|1|2|3|4|5|6|7|8|9|10|11|12|13|14|15),){15}(0|1|2|3|4|5|6|7|8|9|10|11|12|13|14|15)\\]$",
                              "type": "string"
                          },
                          {
                              "items": {
                                  "maxItems": 16,
                                  "minItems": 16,
                                  "type": "integer"
                              },
                              "type": "array"
                          },
                          {
                              "type": "null"
                          }
                      ]
                  },
                  "coeff": {
                      "anyOf": [
                          {
                              "maximum": 255,
                              "minimum": 0,
                              "type": "integer"
                          },
                          {
                              "type": "null"
                          }
                      ]
                  },
                  "consensus_hash": {
                      "anyOf": [
                          {
                              "pattern": "^([0-9a-fA-F]{32})$",
                              "type": "string"
                          },
                          {
                              "type": "null"
                          }
                      ]
                  },
                  "did": {
                      "type": "string"
                  },
                  "domain": {
                      "pattern": "^([a-z0-9\\-_+]{1,37}\\.[a-z0-9\\-_.+]{1,19})$",
                      "type": "string"
                  },
                  "fee": {
                      "minimum": 0,
                      "type": "integer"
                  },
                  "first_registered": {
                      "minimum": 0,
                      "type": "integer"
                  },
                  "history_snapshot": {
                      "type": "boolean"
                  },
                  "importer": {
                      "anyOf": [
                          {
                              "pattern": "^76[aA]914[0-9a-fA-F]{40}88[aA][cC]$",
                              "type": "string"
                          },
                          {
                              "type": "null"
                          }
                      ]
                  },
                  "importer_address": {
                      "anyOf": [
                          {
                              "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{1,35})$",
                              "type": "string"
                          },
                          {
                              "type": "null"
                          }
                      ]
                  },
                  "last_renewed": {
                      "minimum": 0,
                      "type": "integer"
                  },
                  'name': {
                      'type': 'string',
                      'pattern': '^(^([a-z0-9\\-_+]{1,37}\\.[a-z0-9\\-_.+]{1,19})$)|(^([a-z0-9\\-_+]+){1,37}\\.([a-z0-9\\-_+]{1,37}\\.[a-z0-9\\-_.+]{1,19})$)$',
                  },
                  'namespace_id': {
                      'type': 'string',
                      'pattern': '^([a-z0-9\\-_.+]{1,19})$',
                  },
                  "op": {
                      "pattern": "^([>?+~:$!&*:;#]{1}|>>|>~|::)$",
                      "type": "string"
                  },
                  "op_fee": {
                      "type": "number"
                  },
                  "opcode": {
                      "pattern": "NAME_TRANSFER|NAME_PREORDER|NAME_UPDATE|NAME_REVOKE|NAME_REGISTRATION|TOKEN_TRANSFER|NAMESPACE_READY|NAMESPACE_REVEAL|NAMESPACE_PREORDER|NAME_RENEWAL|NAME_IMPORT|ANNOUNCE",
                      "type": "string"
                  },
                  "pending": {
                      "type": "boolean"
                  },
                  "recipient": {
                      "anyOf": [
                          {
                              "pattern": "^[0-9a-fA-F]+$",
                              "type": "string"
                          },
                          {
                              "type": "null"
                          }
                      ]
                  },
                  "recipient_address": {
                      "anyOf": [
                          {
                              "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{1,35})$",
                              "type": "string"
                          },
                          {
                              "type": "null"
                          }
                      ]
                  },
                  "recipient_pubkey": {
                      "anyOf": [
                          {
                              "pattern": "^([0-9a-fA-F]+)$",
                              "type": "string"
                          },
                          {
                              "type": "null"
                          }
                      ]
                  },
                  "revoked": {
                      "type": "boolean"
                  },
                  "sender": {
                      "pattern": "^[0-9a-fA-F]+$",
                      "type": "string"
                  },
                  "sender_pubkey": {
                      "anyOf": [
                          {
                              "pattern": "^([0-9a-fA-F]+)$",
                              "type": "string"
                          },
                          {
                              "type": "null"
                          }
                      ]
                  },
                  "sequence": {
                      "minimum": 0,
                      "type": "integer"
                  },
                  "token_fee": {
                      "pattern": "^[0-9]+$",
                      "type": "string"
                  },
                  "token_units": {
                      "pattern": "^STACKS$|^BTC$|^([a-z0-9\\-_.+]{1,19})$",
                      "type": "string"
                  },
                  "txid": {
                      "pattern": "^([0-9a-fA-F]+)$",
                      "type": "string"
                  },
                  "value_hash": {
                      "anyOf": [
                          {
                              "pattern": "^([0-9a-fA-F]{40})$",
                              "type": "string"
                          },
                          {
                              "type": "null"
                          }
                      ]
                  },
                  "vtxindex": {
                      "minimum": 0,
                      "type": "integer"
                  },
                  "zonefile": {
                      "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
                      "type": "string"
                  }
            },
            'required': [
                'op',
                'opcode',
                'txid',
                'vtxindex'
            ],
          }
        }
      }
    }

Get historical zone file [GET /v1/names/{name}/zonefile/{zoneFileHash}]

Fetches the historical zonefile specified by the username and zone hash.

Public Endpoint
Subdomain aware
Parameters
- name: muneeb.id (string) username to fetch
- zoneFileHash: b100a68235244b012854a95f9114695679002af9

Response 200 (application/json)

Body

    {
       "zonefile":  "$ORIGIN muneeb.id\n$TTL 3600\n_http._tcp IN URI 10 1 \"https://blockstack.s3.amazonaws.com/muneeb.id\"\n"
    }

Schema

    {
           'anyOf': [
              {
                  'type': 'object',
                  'properties': {
                      'zonefile': { 'type': 'string' },
                  },
              },
              {
                  'type': 'object',
                  'properties': {
                      'error': { 'type': 'string' },
                  },
              },
           ],
       }

Get names owned by address [GET /v1/addresses/{blockchain}/{address}]

Retrieves a list of names owned by the address provided.

Subdomain Aware
Public Endpoint
Parameters
- blockchain: bitcoin (string) - the layer-1 blockchain for the address
- address: 1QJQxDas5JhdiXhEbNS14iNjr8auFT96GP (string) - the address to lookup

Response 200 (application/json)

Body

    {
        "names": ["muneeb.id"]
    }

Schema

   {
      'type': 'object',
      'properties': {
          'names': {
              'type': 'array',
              'items': {
                  'type': 'string',
                  'pattern': '^([a-z0-9\-_.+]{3,37})$',
              },
          },
      },
   }

Group Price Checks

Get namespace price [GET /v2/prices/namespaces/{tld}]

This endpoint is used to get the price of a namespace. Anyone can create a namespace by following this tutorial.

The price is denominated in either BTC or STACKs. If it is BTC, then the price will be in satoshis. If it is STACKs, then the units will be in microSTACKs.

Public Endpoint
Parameters
- tld: id (string) - namespace to query price for

Response 200 (application/json)

Body

    {
       "amount": "64000000000",
       "units": "STACKS"
    }

Schema

    {
        'type': 'object',
        'properties': {
            'amount': {
                'type': 'string',
                'pattern': '^[0-9]+$'
            }
            'units': {
                'type': 'string',
                'pattern': '^STACKS$|^BTC$|^([a-z0-9\\-_.+]{1,19})$'
            },
        },
        'required': [
            'amount',
            'units',
        ]
    }

Response 400 (application/json)

Body

  {
      'error': 'Invalid namespace'
  }

Schema

  {
      'type': 'object',
      'properties': {
          'error': {
              'type': 'string',
          },
      },
      'required': [
          'error'
      ],
  }

Get name price [GET /v2/prices/names/{name}]

This endpoint is used to get the price of a name. The name's price may be denominated in a currency of either BTC, or some token on the Blockstack blockchain (STACKs, etc.). The price will be denominated in the smallest possible unit of the currency. For BTC, this is satoshis. For STACKs, this is microSTACKs.

Public Endpoint
Parameters
- name: muneeb.id (string) - name to query price information for

Response 200 (application/json)

Body

    {
      "name_price": {
        "amount": "1733000",
        "units": "STACKS"
      }
    }

Schema

    {
       'type': 'object',
       'properties': {
           'name_price': {
               'type': 'object',
               'properties': {
                   'amount': {
                        'type': 'string',
                        'pattern': '^[0-9]+$',
                    },
                    'units': {
                        'type': 'string',
                        'pattern': '^STACKS$|^BTC$|^([a-z0-9\\-_.+]{1,19})$'
                    }
                }
                'required': [
                    'amount',
                    'units',
                ],
           }
       },
    }

Response 400 (application/json)

Body
```
  {
      'error': 'Invalid name'
  }
```

Schema

  {
      'type': 'object',
      'properties': {
          'error': {
              'type': 'string',
          },
      },
      'required': [
          'error'
      ],
  }

Response 404 (application/json)

Body

  {
      'error': 'Unknown/invalid namespace'
  }

Schema

  {
      'type': 'object',
      'properties': {
          'error': {
              'type': 'string',
          },
      },
      'required': [
          'error'
      ],
  }

DEPRECATED Get namespace price [GET /v1/prices/namespaces/{tld}]

This endpoint is used to get the price of a namespace. Anyone can create a namespace by following this tutorial.

Public Endpoint
Parameters
- tld: id (string) - namespace to query price for

Response 200 (application/json)

Body

     {
       "satoshis": 4000000000
     }

Schema

    {
        'type': 'object',
        'properties': {
            'satoshis': {
                'type': 'integer',
                'minimum': 0,
            },
        },
    }

DEPRECATED Get name price [GET /v1/prices/names/{name}]

This endpoint is used to get the price of a name in satoshis.

Public Endpoint
Parameters
- name: muneeb.id (string) - name to query price information for

Response 200 (application/json)

Body

    {
        "name_price": {
           "satoshis": 100000, 
           "btc": 0.001
         }, 
    }

Schema

    {
       'type': 'object',
       'properties': {
           'name_price': {
               'type': 'object',
               'properties': {
                   'btc': { 'type': 'number', 'minimum': 0 },
                   'satoshis': { 'type': 'integer', 'minimum': 0 }
               }
           },
       },
    }

Group Blockchain Operations

Get consensus hash [GET /v1/blockchains/{blockchainName}/consensus]

Get the current Blockstack consensus hash on a blockchain.

Public Endpoint
Parameters
- blockchainName : bitcoin (string) - the given blockchain

Response 200 (application/json)

Body

    {
        "consensus_hash": "2fcbdf66c350894fe03b42c6a2e8a6ac"
    }

Schema

    {
        'type': 'object',
        'properties': {
            'consensus_hash': {
                'type': 'string',
                'pattern': '^[0-9a-fA-F]{32}$`,
            },
        },
    }

Get number of names on blockchain [GET /v1/blockchains/{blockchainName}/name_count?all={all}]

Get the number of names on a blockchain.

Public Endpoint
Parameters
- blockchainName: bitcoin (string) - the given blockchain
- all: true (enum[string], optional) - include expired names

Response 200 (application/json)

Body

    {
        "names_count": 73950
    }

Schema

    {
        'type': 'object',
        'properties': {
            'names_count': {
                'type': 'integer',
                'minimum': 0,
            },
        },
    }

Response 400 (application/json)

Body

    { "error": "Unsupported blockchain" }

Schema

    {
        'type': 'object',
        'properties': {
            'error': { 'type': 'string' },
        },
    },

Get number of subdomains on blockchain [GET /v1/blockchains/{blockchainName}/subdomains_count]

Get the number of subdomains on a blockchain.

Public Endpoint
Parameters
- blockchainName: bitcoin (string) - the given blockchain

Response 200 (application/json)

Body

    {
        "names_count": 1646
    }

Schema

    {
        'type': 'object',
        'properties': {
            'names_count': {
                'type': 'integer',
                'minimum': 0,
            },
        },
    }

Response 400 (application/json)

Body

    { "error": "Unsupported blockchain" }

Schema

    {
        'type': 'object',
        'properties': {
            'error': { 'type': 'string' },
        },
    },

Get blockchain name record [GET /v1/blockchains/{blockchainName}/names/{name}]

Get the raw blockchain record for a name

Public Endpoint
Parameters
- blockchainName : bitcoin (string) - the given blockchain
- name : muneeb.id (string) - the name to query

Response 200 (application/json)

Body

    {
        "address": "1J3PUxY5uDShUnHRrMyU6yKtoHEUPhKULs",
        "block_number": 373821,
        "consensus_hash": "36dc9bd59e9ee00370349d0af898144c",
        "expire_block": 599266,
        "expired": false,
        "first_registered": 373821,
        "grace_period": false,
        "importer": "76a9143e2b5fdd12db7580fb4d3434b31d4fe9124bd9f088ac",
        "importer_address": "16firc3qZU97D1pWkyL6ZYwPX5UVnWc82V",
        "last_renewed": 494076,
        "name": "muneeb.id",
        "name_hash128": "deb7fe99776122b77925cbf0a24ab6f8",
        "namespace_block_number": 373601,
        "namespace_id": "id",
        "op": "::",
        "op_fee": 10000,
        "opcode": "NAME_RENEWAL",
        "preorder_block_number": 373821,
        "preorder_hash": "e58b193cfe867020ed84cc74edde2487889f28fe",
        "renewal_deadline": 604266,
        "revoked": false,
        "sender": "76a914baedbcbf91cbba4f37680b176d055f47228c8d4e88ac",
        "sender_pubkey": "0411d88aa37a0eea476a5b63ca4b1cd392ded830865824c27dacef6bde9f9bc53fa13a0926533ef4d20397207e212c2086cbe13db5470fd29616abd35326d33090",
        "txid": "7e16e8688ca0413a398bbaf16ad4b10d3c9439555fc140f58e5ab4e50793c476",
        "value_hash": "37aecf837c6ae9bdc9dbd98a268f263dacd00361",
        "vtxindex": 420,
        "zonefile": "JE9SSUdJTiBtdW5lZWIuaWQKJFRUTCAzNjAwCl9odHRwLl90Y3AgVVJJIDEwIDEgImh0dHBzOi8vZ2FpYS5ibG9ja3N0YWNrLm9yZy9odWIvMUozUFV4WTV1RFNoVW5IUnJNeVU2eUt0b0hFVVBoS1VMcy8wL3Byb2ZpbGUuanNvbiIK"
    }

Get operations in block [GET /v1/blockchains/{blockchainName}/operations/{blockHeight}]

Get the Blockstack operations in a given block

Public Endpoint
Parameters
- blockchainName : bitcoin (string) - the given blockchain
- blockHeight : 462592 (integer) - the block height

Response 200 (application/json)

Body

    [
      {
        "address": "1GS1eHthSK2gqnU9MW9Nis1pUyHP3bJnFK",
        "block_number": 462592,
        "burn_address": "1111111111111111111114oLvT2",
        "consensus_hash": "d206b2f615de00803402cade4d0d51d4",
        "op": "?",
        "op_fee": 6250,
        "opcode": "NAME_PREORDER",
        "preorder_hash": "ba22cdf24b05b9a7972e13ada69f96a7850b471e",
        "sender": "76a914a944d29012f83c00105778e0bc717c46ea2accfc88ac",
        "sender_pubkey": "0343b263f7adc6ae59e8d8310f4a6a87799f6b10cec608f3236cd6a802ffc71728",
        "txid": "b3f4f7a43d60666d1a9b42131f9117ad7deac34a478b6ca152344da3d734691f",
        "vtxindex": 173
      },
      {
        "address": "1gijbF8NkbgwzcoZR1nXMa76NbdcD7GQW",
        "block_number": 462592,
        "burn_address": "1111111111111111111114oLvT2",
        "consensus_hash": "d206b2f615de00803402cade4d0d51d4",
        "op": "?",
        "op_fee": 6250,
        "opcode": "NAME_PREORDER",
        "preorder_hash": "386e2de88a908ad056361e586faa95852be454ca",
        "sender": "76a91407830f81167f6a2aa253c0f176b7ff2e1c04c61a88ac",
        "sender_pubkey": "03b7795d33b362338179e5b2a579431b285f6c303d07ddd83c897277be4e5eb916",
        "txid": "4dd315ad1d1b318614a19e15e767efb7ef327bd5cd4ebaf8f80ede58fd1da107",
        "vtxindex": 174
      },
      {
        "address": "17QEd6rrhNZp4xoyWu6BpA8NQ4axyNKaZy",
        "block_number": 462592,
        "burn_address": "1111111111111111111114oLvT2",
        "consensus_hash": "d206b2f615de00803402cade4d0d51d4",
        "op": "?",
        "op_fee": 6250,
        "opcode": "NAME_PREORDER",
        "preorder_hash": "a7a388a2bbe0e7741c6cfdc54d7b5a67811cd582",
        "sender": "76a9144635b1794a22bfbe6c5c5eba17b693f4aaf0e34888ac",
        "sender_pubkey": "020d6e50b2660af27933c42bc1395fe93df90ffac5e2a989f6a134919fb8cf8075",
        "txid": "51d6bd117da5889e710c62967d03233a84fc27f7fad10ca4359111928818f017",
        "vtxindex": 332
      },
      {
        "address": "15YMyvqz6v9ATSbmqJnudwrdm7RiVfkU3s",
        "block_number": 462453,
        "consensus_hash": "f6491e1d2b9817fa58512fc9bf8cd3df",
        "first_registered": 462575,
        "importer": null,
        "importer_address": null,
        "keep_data": true,
        "last_renewed": 462575,
        "name": "ablankstein.id",
        "name_hash128": "943b8e0613d975c05a05ccd5472e2a72",
        "namespace_block_number": 373601,
        "namespace_id": "id",
        "op": ">>",
        "op_fee": 25000,
        "opcode": "NAME_TRANSFER",
        "preorder_block_number": 462453,
        "preorder_hash": "822d5cb6f2e3f0f901d6af8c1111ee466b6c07bd",
        "revoked": false,
        "sender": "76a91431cee995f242f0f66518080a291714cd7e8d2f5e88ac",
        "sender_pubkey": null,
        "txid": "121540e81223c45d139fbe03a9713ddd292372f2f88fe2b10b6a7c5e6738e87f",
        "value_hash": "96ec93cbc57d17b16a347c11ddfa7ea88d2cf93b",
        "vtxindex": 633
      },
      {
        "address": "1Dwq9oA5BNz7DAR1LtDncEa647ZxgmkoVV",
        "block_number": 462325,
        "consensus_hash": "1288cef43f52bf97e2f458a4afe40b61",
        "first_registered": 462359,
        "importer": null,
        "importer_address": null,
        "keep_data": true,
        "last_renewed": 462359,
        "name": "fpenrose.id",
        "name_hash128": "7af28a9834934a0af81a19ee14a45f8e",
        "namespace_block_number": 373601,
        "namespace_id": "id",
        "op": ">>",
        "op_fee": 25000,
        "opcode": "NAME_TRANSFER",
        "preorder_block_number": 462325,
        "preorder_hash": "59c25d7cddf433b5122cabcbf2ebcc1bc1519e4d",
        "revoked": false,
        "sender": "76a9148e002a93b9b1936b5d320967194eaff3deaa979088ac",
        "sender_pubkey": null,
        "txid": "6461bb4bbf517e9c80ffcac4c349836972656572e113aba736b356119655064e",
        "value_hash": "ac73155702ca7aea1161d0f0c7877ac81d48d8fc",
        "vtxindex": 637
      },
      {
        "address": "1Q44Md5KFr6gxQ6TdUSFaCRm3MaUyXMF6t",
        "block_number": 462316,
        "consensus_hash": "1288cef43f52bf97e2f458a4afe40b61",
        "first_registered": 462353,
        "importer": null,
        "importer_address": null,
        "keep_data": true,
        "last_renewed": 462353,
        "name": "rahulpradhan.id",
        "name_hash128": "c55ff9e14c72b2950b14ff10067d7e27",
        "namespace_block_number": 373601,
        "namespace_id": "id",
        "op": ">>",
        "op_fee": 25000,
        "opcode": "NAME_TRANSFER",
        "preorder_block_number": 462316,
        "preorder_hash": "fcb3389ca4d2ab8003ce8b6b3baa0a5ae1600cce",
        "revoked": false,
        "sender": "76a914fcdef125f40f984fafad4b58e30e3b1761a953f388ac",
        "sender_pubkey": null,
        "txid": "be58e02642c457fec2835a354fbc2de45e8c838aa5b7fd18ed831f67d08269e6",
        "value_hash": "e213e58ca1446875b79d866720130cc90cbca681",
        "vtxindex": 638
      },
      {
        "address": "1D8pL725X9HWvoTVgzqDNbTPayHGG7tkY6",
        "block_number": 462345,
        "consensus_hash": "919df884f14f34fd15a791af2fddb569",
        "first_registered": 462380,
        "importer": null,
        "importer_address": null,
        "keep_data": true,
        "last_renewed": 462380,
        "name": "sajithskurup.id",
        "name_hash128": "3fda1c60620c42e1ede385bb246bd5f0",
        "namespace_block_number": 373601,
        "namespace_id": "id",
        "op": ">>",
        "op_fee": 25000,
        "opcode": "NAME_TRANSFER",
        "preorder_block_number": 462345,
        "preorder_hash": "540daefe1f3b520253f7ab954dbc8bf131471133",
        "revoked": false,
        "sender": "76a914851bee0185dd799755234fb20710a26ec40354d288ac",
        "sender_pubkey": null,
        "txid": "e7d35196ca3eec697274d848136f5267b1c935055a917020f93e8ecaf821ba99",
        "value_hash": "92534954e934019718478bb52150765dfad79171",
        "vtxindex": 644
      },
      {
        "address": "1EbjXtYv9QCVBp8iWiDH6xQ1B74oFW696X",
        "block_number": 462345,
        "consensus_hash": "e0c31e03125f2feefd4090e5c635ee45",
        "first_registered": 462380,
        "importer": null,
        "importer_address": null,
        "keep_data": true,
        "last_renewed": 462380,
        "name": "hubject.id",
        "name_hash128": "03e8bf92dd3cbde65cac012350efb79d",
        "namespace_block_number": 373601,
        "namespace_id": "id",
        "op": ">>",
        "op_fee": 25000,
        "opcode": "NAME_TRANSFER",
        "preorder_block_number": 462345,
        "preorder_hash": "ded4d097614cf5321388bbe56b24d3d592b2ef76",
        "revoked": false,
        "sender": "76a914952b4844005dd98a1f7fc99813db2a649109b45988ac",
        "sender_pubkey": null,
        "txid": "7b7a2a2963f7454b93003031cfce64ac609f902b4c2cababfbbfad2c01bbeb9b",
        "value_hash": "be968a1f17ac828179e5b2fbc70d238056af7482",
        "vtxindex": 645
      },
      {
        "address": "14YsDo5qgAP7kmnq33tw9JdHVBywpg9pge",
        "block_number": 462326,
        "consensus_hash": "e0c31e03125f2feefd4090e5c635ee45",
        "first_registered": 462354,
        "importer": null,
        "importer_address": null,
        "keep_data": true,
        "last_renewed": 462354,
        "name": "ramimassoud.id",
        "name_hash128": "61a48b6f8aeb027883ecd1f8d808c8ac",
        "namespace_block_number": 373601,
        "namespace_id": "id",
        "op": ">>",
        "op_fee": 25000,
        "opcode": "NAME_TRANSFER",
        "preorder_block_number": 462326,
        "preorder_hash": "23aa275e42d7d6d7e538584a799252939687c457",
        "revoked": false,
        "sender": "76a91426ef31b7aac60eff23cbbab51d453b84700e330388ac",
        "sender_pubkey": null,
        "txid": "85babcf66caf41cb7beb2e637cbed4e728ab8030337fb5df8461d0e14dd2be75",
        "value_hash": "e27c9c3dcce8a8445d84fb8b4d81fbd30fac9749",
        "vtxindex": 646
      },
      {
        "address": "1H934mT7AVVZmHwjddUZ9EiostLwm655oF",
        "block_number": 462345,
        "consensus_hash": "919df884f14f34fd15a791af2fddb569",
        "first_registered": 462391,
        "importer": null,
        "importer_address": null,
        "keep_data": true,
        "last_renewed": 462391,
        "name": "was2bme.id",
        "name_hash128": "f2b5688682fd47b8f3fbf709bb35ef33",
        "namespace_block_number": 373601,
        "namespace_id": "id",
        "op": ">>",
        "op_fee": 6250,
        "opcode": "NAME_TRANSFER",
        "preorder_block_number": 462345,
        "preorder_hash": "3dfdcee2b0e64697c4bb0b0dd791518bcb078dc7",
        "revoked": false,
        "sender": "76a914b107105f8ae57e7bb5bad58caba666faa679c70f88ac",
        "sender_pubkey": null,
        "txid": "16171e4e20778354a94c5353b0c6ed0b29a3e73c1b59b9bfbcbe6d26c570fd0c",
        "value_hash": "ac73155702ca7aea1161d0f0c7877ac81d48d8fc",
        "vtxindex": 649
      },
      {
        "address": "1B4zxvVMPm1PBGarc8PrYQjQY2ezwniyG6",
        "block_number": 462345,
        "consensus_hash": "e0c31e03125f2feefd4090e5c635ee45",
        "first_registered": 462391,
        "importer": null,
        "importer_address": null,
        "keep_data": true,
        "last_renewed": 462391,
        "name": "tadas_serbenta.id",
        "name_hash128": "6d800932daf830925ab47dee5ceb8661",
        "namespace_block_number": 373601,
        "namespace_id": "id",
        "op": ">>",
        "op_fee": 6250,
        "opcode": "NAME_TRANSFER",
        "preorder_block_number": 462345,
        "preorder_hash": "07a85eac4dbf20000a66a14a4a89a01134b70fab",
        "revoked": false,
        "sender": "76a9146e72e44bbe4c1706ea5830096a4bb4449dcc948f88ac",
        "sender_pubkey": null,
        "txid": "e3f0b019550417a7acfe27addfbd34ec7ec5fc1dd9616ed8c6bc86a0ad148290",
        "value_hash": "fbac107ba5d9bbfc30ecdeae3e10ca3db72b3431",
        "vtxindex": 855
      },
      {
        "address": "16BF35VputeLEmbsk7gDnUcwKXcjwPDUvf",
        "block_number": 462345,
        "consensus_hash": "919df884f14f34fd15a791af2fddb569",
        "first_registered": 462359,
        "importer": null,
        "importer_address": null,
        "keep_data": true,
        "last_renewed": 462359,
        "name": "alexucf.id",
        "name_hash128": "d9bc88b0fdc536e7ac5467609faed518",
        "namespace_block_number": 373601,
        "namespace_id": "id",
        "op": ">>",
        "op_fee": 25000,
        "opcode": "NAME_TRANSFER",
        "preorder_block_number": 462345,
        "preorder_hash": "30f841114af6ada90ba720d563672113c4f74439",
        "revoked": false,
        "sender": "76a91438c8814ae2a9035e85bbf2b7976919c2e3387ac588ac",
        "sender_pubkey": null,
        "txid": "f8e9eebd48b9182b82b22e5ce10f805d3db38786bb2aaf56f9badf83aa3cc0ee",
        "value_hash": "8ae0f51263f540be175230d6b46f5d9609de799d",
        "vtxindex": 856
      },
      {
        "address": "1EmXTRHC6f9bnLJkVZRavv7HLG1owLgNir",
        "block_number": 462326,
        "consensus_hash": "31a304b682e3291811441a12f19d14e5",
        "first_registered": 462391,
        "importer": null,
        "importer_address": null,
        "keep_data": true,
        "last_renewed": 462391,
        "name": "seamur.id",
        "name_hash128": "09f3b9d2da3d0aa1999824f7884f0d18",
        "namespace_block_number": 373601,
        "namespace_id": "id",
        "op": ">>",
        "op_fee": 100000,
        "opcode": "NAME_TRANSFER",
        "preorder_block_number": 462326,
        "preorder_hash": "678991fd4d3833babe27f732206a40d1f15dd3ca",
        "revoked": false,
        "sender": "76a91497055c47fa0ab396fb321e9d37f6bce1796e3d5688ac",
        "sender_pubkey": null,
        "txid": "e32124770c359eaf57709e5a666894f2954aa687820c41c6911f214e9006b58e",
        "value_hash": "4bcdd931185537902ef1af9975198c6404d4c73e",
        "vtxindex": 857
      },
      {
        "address": "13pGtMcHsNdq3EeLMa1yVVKppP1WjSKgFG",
        "block_number": 462345,
        "consensus_hash": "e0c31e03125f2feefd4090e5c635ee45",
        "first_registered": 462354,
        "importer": null,
        "importer_address": null,
        "keep_data": true,
        "last_renewed": 462354,
        "name": "innergame.id",
        "name_hash128": "a3e4e010d82369ee19b64fccc2b97f69",
        "namespace_block_number": 373601,
        "namespace_id": "id",
        "op": ">>",
        "op_fee": 25000,
        "opcode": "NAME_TRANSFER",
        "preorder_block_number": 462345,
        "preorder_hash": "f54850caf10c3041cb2a4d9186bbb234dd7d9f85",
        "revoked": false,
        "sender": "76a9141ee10ff0ae9969e2dc39d94a959e3160b26b6adf88ac",
        "sender_pubkey": null,
        "txid": "28de7193e28e1b0c950a32af393284578669c15dc98bad68f382f8b920d94509",
        "value_hash": "bab40c2b10f676288edea119edade67ff5e853ba",
        "vtxindex": 869
      }
    ]

Group Namespace Operations

Get all namespaces [GET /v1/namespaces]

Public Endpoint

Response 200 (application/json)

Body

       {
         "namespaces": [
           ".id"
         ] 
       }

Get namespace names [GET /v1/namespaces/{tld}/names?page={page}]

Fetch a list of names from the namespace.

Public Endpoint
Parameters
- tld: id (string) - the namespace to fetch names from
- page: 23 (number) - names are returned in pages of size 100, so specify the page number.

Response 200 (application/json)

Body

       [ "aldenquimby.id", "aldeoryn.id", 
         "alderete.id", "aldert.id", 
         "aldi.id", "aldighieri.id", ... ]

Get number of names in a namespace [GET /v1/namespaces/{tld}/name_count]

Fetch the number of names from the namespace.

Public Endpoint
Parameters
- tld: id (string) - the namespace to query

Response 200 (application/json)

Body

        {
            'names_count': 73950
        }

Group Resolver Endpoints

Lookup User [GET /v1/users/{username}]

Lookup and resolver a user's profile. Defaults to the id namespace. Note that blockstack.js does not rely on this endpoint.

Public Endpoint
Subdomain Aware
Legacy Endpoint
Parameters
- username: fred (string) - username to lookup

Response 200 (application/json)

         {
           "fred.id": {
             "owner_address": "1CER5u4QXuqffHjHKrU76iMCsqtJLM5VHu", 
             "profile": {
               "@context": "http://schema.org", 
               "@type": "Person", 
               "account": [
                 {
                   "@type": "Account", 
                   "identifier": "fredwilson", 
                   "placeholder": false, 
                   "proofType": "http", 
                   "proofUrl": "https://twitter.com/fredwilson/status/943066895422455809", 
                   "service": "twitter"
                 }
               ], 
               "description": "I am a VC", 
               "image": [
                 {
                   "@type": "ImageObject", 
                   "contentUrl": "https://gaia.blockstack.org/hub/1CER5u4QXuqffHjHKrU76iMCsqtJLM5VHu/0/avatar-0", 
                   "name": "avatar"
                 }
               ], 
               "name": "Fred Wilson"
             }, 
             "public_key": "026c94d1897fa148fa6401247a339b55abd869a3d562fdae8a7fcb9a11f1f846f3", 
             "verifications": [
               {
                 "identifier": "fredwilson", 
                 "proof_url": "https://twitter.com/fredwilson/status/943066895422455809", 
                 "service": "twitter", 
                 "valid": true
               }
             ], 
             "zone_file": {
               "$origin": "fred.id", 
               "$ttl": 3600, 
               "uri": [
                 {
                   "name": "_http._tcp", 
                   "priority": 10, 
                   "target": "https://gaia.blockstack.org/hub/1CER5u4QXuqffHjHKrU76iMCsqtJLM5VHu/0/profile.json", 
                   "weight": 1
                 }
               ]
             }
           }
         }

Profile Search [GET /v1/search?query={query}]

Searches for a profile using a search string.

Public Only Endpoint
Parameters
- query: wenger (string) - the search query

Response 200 (application/json)

Body

       {
         "results": [
           {
             "fullyQualifiedName": "albertwenger.id",
             "username": "albertwenger",
             "profile": {
               "@type": "Person", 
               "account": [
                 {
                   "@type": "Account", 
                   "identifier": "albertwenger", 
                   "proofType": "http", 
                   "service": "twitter"
                 }, 
                 {
                   "@type": "Account", 
                   "identifier": "albertwenger", 
                   "proofType": "http", 
                   "service": "facebook"
                 }, 
                 {
                   "@type": "Account", 
                   "identifier": "albertwenger", 
                   "proofType": "http", 
                   "service": "github"
                 }, 
                 {
                   "@type": "Account", 
                   "identifier": "1QHDGGLEKK7FZWsBEL78acV9edGCTarqXt", 
                   "role": "payment", 
                   "service": "bitcoin"
                 }
               ], 
               "address": {
                 "@type": "PostalAddress", 
                 "addressLocality": "New York"
               }, 
               "description": "VC at USV.com", 
               ...
       }

55 KiB Raw Blame History

Group Core Node Administration

Ping the node [GET /v1/node/ping]

Group Managing Zone Files

Fetch zone file [GET /v1/names/{name}/zonefile?raw={raw}]

Publish a zone file [POST /v1/zonefile]

Group Name Querying

Get all names [GET /v1/names?page={page}]

Get all subdomains [GET /v1/subdomains?page={page}]

Get name info [GET /v1/names/{name}]

Name history [GET /v1/names/{name}/history?page={page}]

Get historical zone file [GET /v1/names/{name}/zonefile/{zoneFileHash}]

Get names owned by address [GET /v1/addresses/{blockchain}/{address}]

Group Price Checks

Get namespace price [GET /v2/prices/namespaces/{tld}]

Get name price [GET /v2/prices/names/{name}]

DEPRECATED Get namespace price [GET /v1/prices/namespaces/{tld}]

DEPRECATED Get name price [GET /v1/prices/names/{name}]

Group Blockchain Operations

Get consensus hash [GET /v1/blockchains/{blockchainName}/consensus]

Get number of names on blockchain [GET /v1/blockchains/{blockchainName}/name_count?all={all}]

Get number of subdomains on blockchain [GET /v1/blockchains/{blockchainName}/subdomains_count]

Get blockchain name record [GET /v1/blockchains/{blockchainName}/names/{name}]

Get operations in block [GET /v1/blockchains/{blockchainName}/operations/{blockHeight}]

Group Namespace Operations

Get all namespaces [GET /v1/namespaces]

Get namespace names [GET /v1/namespaces/{tld}/names?page={page}]

Get number of names in a namespace [GET /v1/namespaces/{tld}/name_count]

Group Resolver Endpoints

Lookup User [GET /v1/users/{username}]

Profile Search [GET /v1/search?query={query}]

55 KiB

Raw Blame History