anchors.md

Anchors

get

Gets anchor information for the directory block containing the given object identifier.

Sample

factom_client.anchors.get('4b9532c79d53ab22b85951b4a5853f81c2682132b3c810a95128c30401cd1e58')

Parameters

Name	Type	Description	SDK Error Message & Description
object_identifier	required	string Represented by an entry hash, chain id, directory block height, directory block keymr, entry block keymr, or factoid block keymr.	object_identifier must be a positive int or a string of length 64
app_id	optional	string This is the override parameter that allows user to specify a different API Application ID (which you can see by clicking on any of the applications in the application list that you see upon logging into https://account.factom.com).
app_key	optional	string This is the override parameter that allows user to specify a different API Application Key (which you can see by clicking on any of the applications in the application list that you see upon logging into https://account.factom.com).
base_url	optional	string This is the override parameter that allows user to specify a different API Base URL for your application (which you can see by clicking on any of the applications in the application list the you see upon logging into https://account.factom.com).

Returns

Public Mainnet Response: OK

• data: object
  Contains information about the desired directory block's anchors
  • data.dblock: object
    The directory block that was anchored
    • data.dblock.keymr: string
      The Key Merkle Root for this directory block
    • data.dblock.height: integer
      The Factom block height of this block
    • data.dblock.href: string
      An API link to retrieve all available information about this directory block
• data.anchors: [object]
  Contains detailed information about the returned anchors
  • data.anchors.network string
    The network being anchored to
  • data.anchors.status string
    Describes the current state of the anchoring process ("pending" or "confirmed")
  • data.anchors.tx_id string
    The transaction hash for the anchor (only present if anchor status is "confirmed")
  • data.anchors.block_hash string
    The hash of the block that includes the anchor transaction (only present if anchor status is "confirmed")

Note: Ethereum anchoring not yet live.

{
  "data": {
    "dblock": {
      "keymr": "9423f275c4bfe567ff74cefdee646cb2ac639af0a32fb7ba43265d30a86b412e",
      "height": 14396,
      "href": "/v1/dblocks/9423f275c4bfe567ff74cefdee646cb2ac639af0a32fb7ba43265d30a86b412e",
    },
    "anchors": [
      {
        "network": "bitcoin",
        "status": "confirmed",
        "tx_id":"469a96c847cf8bf1f325b6eec850f46488ed671930d62b54ed186a8031477a7d",
        "block_hash":"000000000000000001edf3adf719dfc1263661d2c4b0ed779d004a2cbb7cca32"
      },
      {
        "network": "ethereum",
        "status": "pending",
      }
    ]
  }
}

Private Network Response: OK

• data: object
  Contains information about the desired directory block's anchors
  • data.dblock: object
    The directory block that was anchored
    • data.dblock.keymr: string
      The Key Merkle Root for this directory block
    • data.dblock.height: integer
      The Factom block height of this block
    • data.dblock.href: string
      An API link to retrieve all available information about this directory block
• data.anchors: [object]
  Contains detailed information about the returned anchors
  • data.anchors.network string
    The network being anchored to
  • data.anchors.status string
    Describes the current state of the anchoring process ("pending" or "confirmed")
  • data.anchors.created_at string
    The timestamp for this entry, sent in ISO 8601 format (i.e. YYYY-MM-DDThh:mm:ssZ)
  • data.anchors.entry_serialized string
    The raw data that makes up the anchor entry
  • data.anchors.entry_hash string
    The unique identifier of the entry
  • data.anchors.merkle_branch [object]
    The branch of the merkle tree that represents the anchor entry's path from entry hash to directory block key Merkle root, presented as an array of Merkle nodes
    • data.anchors.merkle_branch[].left string
      The left branch of this node of the Merkle tree
    • data.anchors.merkle_branch[].right string
      The right branch of this node of the Merkle tree
    • data.anchors.merkle_branch[].top string
      The top of this node of the Merkle tree
  • data.anchors.dblock string
    The mainnet directory block that contains the anchor entry
    • data.anchors.dblock.keymr string
      The Key Merkle Root for this directory block
    • data.anchors.dblock.height string
      The sequence number of this directory block
    • data.anchors.dblock.href string
      An API link to retrieve all available information about this directory block

{
  "data": {
    "dblock": {
      "keymr": "9423f275c4bfe567ff74cefdee646cb2ac639af0a32fb7ba43265d30a86b412e",
      "height": "14396",
      "href": "/v1/dblocks/9423f275c4bfe567ff74cefdee646cb2ac639af0a32fb7ba43265d30a86b412e",
    },
    "anchors": [
      {
        "network": "factom",
        "status": "confirmed",
        "created_at": "2019-04-15T15:46:04Z",
        "entry_serialized": "008774e15f162f4e3a8f03bc7d4c5845bf9bee9bc9c4155802366f90ae92b47c900012000474657374000474657374000474657374746573740a",
        "entry_hash": "36993363235ba2204877e78e9e1b4d5055edfa838df58ebb077098697adbeee5",
        "merkle_branch": [
            {
              "right": "0000000000000000000000000000000000000000000000000000000000000006",
              "top": "5ae8146c21527901cff56c8b5004a3675a4268229f2a7e3802ecd07d0910a107",
              "left": "36993363235ba2204877e78e9e1b4d5055edfa838df58ebb077098697adbeee5"
            },
            {
              "right": "5ae8146c21527901cff56c8b5004a3675a4268229f2a7e3802ecd07d0910a107",
              "top": "43e55fc368f8243958d25e16a67ec16074276fb379f36d368593422cf3df21a5",
              "left": "798e2cf5d132ff8634cdf846f2facafc66d1d3b53573098ffcfc43bc97448e3c"
            },
            {
              "right": "43e55fc368f8243958d25e16a67ec16074276fb379f36d368593422cf3df21a5",
              "top": "fcd21fedfe23ea79df5c79c9aab77640a76c7f40ae2a97354cd4f9958d7e661a",
              "left": "8774e15f162f4e3a8f03bc7d4c5845bf9bee9bc9c4155802366f90ae92b47c90"
            },
            {
              "right": "fcd21fedfe23ea79df5c79c9aab77640a76c7f40ae2a97354cd4f9958d7e661a",
              "top": "3afbee04fc2eecfe8af8b1e30f828bee9792b15d05c888afac8db5b835f3bad2",
              "left": "78c87c440e771e2f8aaa27012acd5021211fb2c8b6d8437c4bad8dd9e9bcb294"
            },
            {
              "right": "3afbee04fc2eecfe8af8b1e30f828bee9792b15d05c888afac8db5b835f3bad2",
              "top": "46556e7b4a788510c3ab383564e95539ccb2a24fec294c4d42ee6c93b66b1231",
              "left": "114d36308dda1d749b529d8ed21f0471777390fab69fb1ca69d71438bb286234"
            },
            {
              "right": "46556e7b4a788510c3ab383564e95539ccb2a24fec294c4d42ee6c93b66b1231",
              "top": "7818914aff2c1f1c224c1542a2c33ba639dce2ccac14c346cd6f82fa60dea84c",
              "left": "643df17024a3a3cfcc7bff522ade7e0ed46637961a65b66b912fcdff4e5b3a72"
            }
        ],
        "dblock": {
          "keymr": "7818914aff2c1f1c224c1542a2c33ba639dce2ccac14c346cd6f82fa60dea84c",
          "height": "180678",
          "href": "/v1/dblocks/7818914aff2c1f1c224c1542a2c33ba639dce2ccac14c346cd6f82fa60dea84c",
        }
      }
    ],
  }
}