Read Collectibles Outputs

GET /collectibles/outputs

Endpoint URL

 https://api.mixin.one/collectibles/outputs?state=:state&offset=:offset&limit=:limit&members=:members&threshold=:threshold

Authentication and options

Authorization	Authorized
Limitation	No limitation

Parameters

state	Optional, the states of UTXO, e.g. unspent, signed, and spent.
offset	Optional, pagination start time, RFC3339Nano format, e.g. `2020-12-12T12:12:12.999999999Z`.
limit	Optional, pagination per page data limit, 500 by default, maximally 500
members	used together with threshold to participate in the hash of multi-signature members.
threshold	integer, used with members, multi-signature threshold, for example, 2/3, threshold = 2

If an account participates in collectibles multi-signatures, the data can be filtered through the members and threshold parameters.

Here is the golang code for generating the multi-signature member hash:

func hashMembers(ids []string) string {
 sort.Slice(ids, func(i, j int) bool { return ids[i] < ids[j] })
 var in string
 for _, id := range ids {
  in = in + id
 }
 return crypto.NewHash([]byte(in)).String()
}

Example request

curl -i -X GET -H "Content-Type: application/json" -H "Authorization: Bearer $TOKEN" https://api.mixin.one/collectibles/outputs?members=:members&threshold=:threshold&limit=500&offset=2006-01-02T15:04:05.999999999Z&state=spent

    {
      "data": {
        "user_id": "ab56be4c-5b20-41c6-a9c3-244f9a433f35",
        "output_id": "ab56be4c-5b20-41c6-a9c3-244f9a433f35",
        "token_id": "ab56be4c-5b20-41c6-a9c3-244f9a433f35",
        "transaction_hash": "298281....4952f95768b7d1a925c4189b912c343dbb000180e",
        "output_index": 0,
        "amount": "",
        "senders_threshold": 1,
        "senders": [
          "ab56be4c-5b20-41c6-a9c3-244f9a433f35",
          "ab56be4c-5b20-41c6-a9c3-244f9a433f35",
          "ab56be4c-5b20-41c6-a9c3-244f9a433f35"
        ],
        "receivers_threshold": 2,
        "receivers": [
          "ab56be4c-5b20-41c6-a9c3-244f9a433f35",
          "ab56be4c-5b20-41c6-a9c3-244f9a433f35",
          "ab56be4c-5b20-41c6-a9c3-244f9a433f35"
        ],
        "state": "spent",
        "created_at": "2018-05-03T10:08:34.859542588Z",
        "updated_at": "2018-05-03T10:08:34.859542588Z",
        "signed_by": "298281....4952f95768b7d1a925c4189b912c343dbb000180e",
        "signed_tx": "298281....4952f95768b7d1a925c4189b912c343dbb000180e",
      }
    }
  

In which, signed_tx and signed_by have values when the state is signed. signed_by represents the transaction hash, and signed_tx is the complete transaction content, signed_by can help sort the corresponding waiting list of transactions.

GET /collectibles/tokens/UUID

Get the information of the collectible

Endpoint URL

 https://api.mixin.one/collectibles/tokens/UUID

Example request

curl -i -X GET -H "Content-Type: application/json" -H "Authorization: Bearer $TOKEN" https://api.mixin.one/collectibles/tokens/ab56be4c-5b20-41c6-a9c3-244f9a433f35

{
    "data": {
      "type": "non_fungible_token",
      "token_id": "43d61dcd-e413-450d-80b8-101d5e903357",
      "group": "",
      "token": "",
      "mixin_id": "",
      "nfo": "",
      "meta": {
        "group": "",
        "name": "",
        "description": "",
        "icon_url": "",
        "media_url": "",
        "mime": "",
        "hash": "",
      },
      "created_at": "2018-05-03T10:08:34.859542588Z",
    }
  }

GET /collectibles/collections/UUID

Get the information of the collectible collection.

Endpoint URL

 https://api.mixin.one/collectibles/collections/UUID

Example request

curl -i -X GET -H "Content-Type: application/json" -H "Authorization: Bearer $TOKEN" https://api.mixin.one/collectibles/collections/ab56be4c-5b20-41c6-a9c3-244f9a433f35

{
    "data": {
      "type": "collection",
      "collection_id": "43d61dcd-e413-450d-80b8-101d5e903357",
      "name": "",
      "description": "",
      "icon_url": "",
      "created_at": "2018-05-03T10:08:34.859542588Z",
    }
  }