Search by ID

Path Parameters

idstring

The hex hash string for a block or transaction, account address, or contract address

Query Parameters

include_metadata?boolean

This includes the detailed data for purticular hash in the response

Defaultfalse

Response Body

Default Response

TypeScript Definitions

Use the response body type in TypeScript.

foundboolean

Value intrue

resultAddressSearchResult & BlockSearchResult & ContractSearchResult & MempoolTxSearchResult & TxSearchResult

Default Response

TypeScript Definitions

Use the response body type in TypeScript.

foundboolean

Value infalse

resultobject

errorstring

Default Response

TypeScript Definitions

Use the response body type in TypeScript.

errorstring

message?string

[key: string]any

curl -X GET "https://api.hiro.so//extended/v1/search/0xcf8b233f19f6c07d2dc1963302d2436efd36e9afac127bf6582824a13961c06d?include_metadata=false"

fetch("https://api.hiro.so//extended/v1/search/0xcf8b233f19f6c07d2dc1963302d2436efd36e9afac127bf6582824a13961c06d?include_metadata=false")

package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
)

func main() {
  url := "https://api.hiro.so//extended/v1/search/0xcf8b233f19f6c07d2dc1963302d2436efd36e9afac127bf6582824a13961c06d?include_metadata=false"

  req, _ := http.NewRequest("GET", url, nil)
  
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  body, _ := ioutil.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))
}

import requests

url = "https://api.hiro.so//extended/v1/search/0xcf8b233f19f6c07d2dc1963302d2436efd36e9afac127bf6582824a13961c06d?include_metadata=false"

response = requests.request("GET", url)

print(response.text)

{
  "found": true,
  "result": {
    "entity_id": "string",
    "entity_type": "standard_address",
    "metadata": {
      "balance": "string",
      "estimated_balance": "string",
      "pending_balance_inbound": "string",
      "pending_balance_outbound": "string",
      "total_sent": "string",
      "total_received": "string",
      "total_fees_sent": "string",
      "total_miner_rewards_received": "string",
      "lock_tx_id": "string",
      "locked": "string",
      "lock_height": 0,
      "burnchain_lock_height": 0,
      "burnchain_unlock_height": 0,
      "token_offering_locked": {
        "total_locked": "string",
        "total_unlocked": "string",
        "unlock_schedule": [
          {
            "amount": "string",
            "block_height": 0
          }
        ]
      }
    }
  }
}

{
  "found": false,
  "result": {
    "entity_type": "tx_id"
  },
  "error": "string"
}

{
  "error": "string",
  "message": "string"
}