API Integration Guide

Describes how to integrate with the ElectrumX API Service specified to different versions.

v1.5.0

Custom Coloring and Partial Coloring features are introduced in the v1.5.0 release.

These features also introduce the breaking change to the result when reading the Atomicals assets.

When you are requesting the list (typically blockchain.atomicals.listscripthash ), the structure response.utxos.atomicals has been updated.

Before

The field's type was a string list that contained the Atomical ID in that UTXO.

{
  "atomicals": [
    "9025f03bcf9325f6071761b9aee00b462a0b43ed157c336e2e89e07f47ea6f66i0"
  ],
  "height": 847000,
  "index": 0,
  "txid": "b3ab9bf07db9075c1bbdef5638aef4941564a8afa3e0399ea4127285796b9ac1",
  "value": 546,
  "vout": 0
}

After

The field's type is a record map that contains the Atomical ID and the corresponding Atomicals value in that UTXO.

{
  "atomicals": {
    "9025f03bcf9325f6071761b9aee00b462a0b43ed157c336e2e89e07f47ea6f66i0": 546
  },
  "height": 847000,
  "index": 0,
  "txid": "b3ab9bf07db9075c1bbdef5638aef4941564a8afa3e0399ea4127285796b9ac1",
  "value": 546,
  "vout": 0
}

Now the Atomicals value might not equal the UTXO value, so you shall read based on the Atomical ID to obtain the correct value.

Last updated