Sat Circulation

Deezy API (1.0.0)

Deezy Rare Satoshi Circulation and Hunting API

Download OpenAPI description
swagger.json
swagger.yaml
Languages
Servers
Mock server
https://docs.deezy.io/_mock/swagger/
Mainnet
https://api.deezy.io/
Testnet
https://api-testnet.deezy.io/

Sat Circulation

Operations

Get Circulation Data

Request

Get the circulation data of sats

Query
raritystringrequired

The rarity tag(s) to filter by. Examples: ?rarity=uncommon or can do multiple tags like: ?rarity=uncommon,pizza. Valid rarities are: 2009, uncommon, rare, epic, black_uncommon, black_rare, black_epic, palindrome, jan2009, vintage, nakamoto, pizza, jpeg, hitman, silkroad, alpha, omega, 1_digit, 2_digits, 3_digits, perfect_palinception, uniform_palinception, rodarmor, 450x, block_9, block_78, block_286, block_666, fibonacci, sequence_palindrome, legacy

trailing_0sinteger

Filter for sats with a specific number of trailing zeroes. Must be used with the uncommon rarity tag. Example: ?rarity=uncommon&trailing_0s=12

trailing_9sinteger

Filter for sats with a specific number of trailing nines. Must be used with the black_uncommon rarity tag. Example: ?rarity=black_uncommon&trailing_9s=11

year_minedinteger

Filter for sats that were mined in a specific year. Example: ?rarity=uncommon&year_mined=2010

blockinteger

Filter by a specific block. Example: ?rarity=perfect_palinception&block=666

block_startinteger

Only search for sats mined at this block height or later. Example: ?rarity=perfect_palinception&block_start=10000. Can be used in combination with block_end.

block_endinteger

Only search for sats mined at this block height or earlier. Example: ?rarity=perfect_palinception&block_end=10000. Can be used in combination with block_start.

time_startstring(date-time)

Only search for sats mined after this datetime or later. Example: ?rarity=perfect_palinception&time_start=2009-01-01T14:15:22Z or ?rarity=perfect_palinception&time_start=2009-01-01. Can be used in combination with time_end.

time_endstring(date-time)

Only search for sats mined before this datetime or earlier. Example: ?rarity=perfect_palinception&time_end=2010-01-01T14:15:22Z or ?rarity=perfect_palinception&time_end=2010-01-01. Can be used in combination with time_start.

include_top_holdersboolean

If set to true will return a list of the top 500 holders

curl -i -X GET \
  'https://docs.deezy.io/_mock/swagger/v1/sat-hunting/circulation?block=0&block_end=0&block_start=0&include_top_holders=true&rarity=string&time_end=2019-08-24T14%3A15%3A22Z&time_start=2019-08-24T14%3A15%3A22Z&trailing_0s=0&trailing_9s=0&year_mined=0' \
  -H 'x-api-token: YOUR_API_KEY_HERE'

Responses

Circulation data for the specified rarity tag(s)

Bodyapplication/json
dataobject
Response
application/json
{
  "data": {
    "n_total": 0,
    "n_mined": 0,
    "n_epoch": 0,
    "n_365": 0,
    "n_seq": 0,
    "n_inscribed": 0,
    "n_seq_holders": 0,
    "n_total_holders": 0,
    "top_seq_holders": [ … ],
    "top_holders": [ … ],
    "updated_at": "2019-08-24T14:15:22Z"
  }
}

Sat Hunting

Operations