diff --git a/docs/openapi.yaml b/docs/openapi.yaml index 3859544f8b..329c25bfe6 100644 --- a/docs/openapi.yaml +++ b/docs/openapi.yaml @@ -139,7 +139,7 @@ paths: required: true schema: type: string - example: 2N4M94S1ZPt8HfxydXzL2P7qyzgVq7MHWts + example: "2N4M94S1ZPt8HfxydXzL2P7qyzgVq7MHWts" post: summary: Add testnet BTC tokens to address description: | @@ -192,25 +192,25 @@ paths: in: query description: max number of transactions to fetch required: false - example: 100 schema: type: integer default: 96 maximum: 200 + example: 100 - name: offset in: query description: index of first transaction to fetch required: false - example: 42000 schema: type: integer + example: 42000 - name: type in: query description: Filter by transaction type required: false - example: coinbase schema: type: array + example: coinbase items: type: string enum: [coinbase, token_transfer, smart_contract, contract_call, poison_microblock] @@ -218,7 +218,6 @@ paths: in: query description: Include transaction data from unanchored (i.e. unconfirmed) microblocks required: false - example: true schema: type: boolean example: true @@ -248,9 +247,9 @@ paths: in: query description: Filter to only return transactions with this sender address. required: false - example: SP1GPBP8NBRXDRJBFQBV7KMAZX1Z7W2RFWJEH0V10 schema: type: string + example: "SP1GPBP8NBRXDRJBFQBV7KMAZX1Z7W2RFWJEH0V10" - name: recipient_address in: query description: Filter to only return transactions with this recipient address (only applicable for STX transfer tx types). @@ -267,18 +266,18 @@ paths: in: query description: max number of mempool transactions to fetch required: false - example: 100 schema: type: integer default: 96 maximum: 200 + example: 100 - name: offset in: query description: index of first mempool transaction to fetch required: false - example: 42000 schema: type: integer + example: 42000 - name: unanchored in: query description: Include transaction data from unanchored (i.e. unconfirmed) microblocks @@ -323,9 +322,9 @@ paths: in: query description: index of first mempool transaction to fetch required: false - example: 42000 schema: type: integer + example: 42000 responses: 200: description: List of dropped mempool transactions @@ -342,9 +341,9 @@ paths: in: query description: Array of transaction ids required: true - example: 0x0a411719e3bfde95f9e227a2d7f8fac3d6c646b1e6cc186db0e2838a2c6cd9c0 schema: type: array + example: "0x0a411719e3bfde95f9e227a2d7f8fac3d6c646b1e6cc186db0e2838a2c6cd9c0" items: type: string - name: event_offset @@ -396,9 +395,9 @@ paths: in: path description: Hash of transaction required: true - example: 0x0a411719e3bfde95f9e227a2d7f8fac3d6c646b1e6cc186db0e2838a2c6cd9c0 schema: type: string + example: "0x0a411719e3bfde95f9e227a2d7f8fac3d6c646b1e6cc186db0e2838a2c6cd9c0" - name: event_offset in: query schema: @@ -446,9 +445,9 @@ paths: in: path description: Hash of transaction required: true - example: 0x0a411719e3bfde95f9e227a2d7f8fac3d6c646b1e6cc186db0e2838a2c6cd9c0 schema: type: string + example: "0x0a411719e3bfde95f9e227a2d7f8fac3d6c646b1e6cc186db0e2838a2c6cd9c0" get: summary: Get Raw Transaction tags: @@ -481,7 +480,7 @@ paths: schema: type: string format: binary - example: binary format of 00000000010400bed38c2aadffa348931bcb542880ff79d607afec000000000000000000000000000000c800012b0b1fff6cccd0974966dcd665835838f0985be508e1322e09fb3d751eca132c492bda720f9ef1768d14fdabed6127560ba52d5e3ac470dcb60b784e97dc88c9030200000000000516df0ba3e79792be7be5e50a370289accfc8c9e032000000000000303974657374206d656d6f00000000000000000000000000000000000000000000000000 + example: binary format of 00000000010400bed38c2aadffa348931bcb542880ff79d607afec000000000000000000000000000000c800012b0b1fff6cccd0974966dcd665835838f0985be508e1322e09fb3d751eca132c492bda720f9ef1768d14fdabed6127560ba52d5e3ac470dcb60b784e97dc88c9030200000000000516df0ba3e79792be7be5e50a370289accfc8c9e032000000000000303974657374206d656d6f00000000000000000000000000000000000000000000000000 responses: 200: description: Transaction id of successful post of a raw tx to the node's mempool @@ -489,7 +488,7 @@ paths: text/plain: schema: type: string - example: '"e161978626f216b2141b156ade10501207ae535fa365a13ef5d7a7c9310a09f2"' + example: "e161978626f216b2141b156ade10501207ae535fa365a13ef5d7a7c9310a09f2" 400: description: Rejections result in a 400 error content: @@ -523,10 +522,9 @@ paths: in: query description: Index of the first microblock to fetch required: false - example: 42000 schema: type: integer - example: 1000 + example: 42000 responses: 200: description: List of microblocks @@ -543,7 +541,8 @@ paths: required: true schema: type: string - example: 0x3bfcdf84b3012adb544cf0f6df4835f93418c2269a3881885e27b3d58eb82d47 + example: "0x3bfcdf84b3012adb544cf0f6df4835f93418c2269a3881885e27b3d58eb82d47" + get: summary: Get microblock description: Retrieves a specific microblock by `hash` @@ -619,10 +618,10 @@ paths: - name: hash in: path description: Hash of the block - example: "0x4839a8b01cfb39ffcc0d07d3db31e848d5adf5279d529ed5062300b9f353ff79" required: true schema: type: string + example: "0x4839a8b01cfb39ffcc0d07d3db31e848d5adf5279d529ed5062300b9f353ff79" get: summary: Get block by hash description: Retrieves block details of a specific block for a given chain height. You can use the hash from your latest block ('get_block_list' API) to get your block details. @@ -650,9 +649,9 @@ paths: in: path description: Height of the block required: true - example: 10000 schema: type: number + example: 10000 get: summary: Get block by height description: Retrieves block details of a specific block at a given block height @@ -682,7 +681,7 @@ paths: required: true schema: type: string - example: 0x00000000000000000002bba732926cf68b6eda3e2cdbc2a85af79f10efeeeb10 + example: "0x00000000000000000002bba732926cf68b6eda3e2cdbc2a85af79f10efeeeb10" get: summary: Get block by burnchain block hash description: Retrieves block details of a specific block for a given burnchain block hash @@ -756,9 +755,9 @@ paths: in: query description: index of the first items to fetch required: false - example: 42000 schema: type: integer + example: 42000 responses: 200: description: List of burnchain reward recipients and amounts @@ -781,9 +780,9 @@ paths: in: path description: Reward slot holder recipient address. Should either be in the native burnchain's format (e.g. B58 for Bitcoin), or if a STX principal address is provided it will be encoded as into the equivalent burnchain format required: true - example: 36hQtSEXBMevo5chpxhfAGiCTSC34QKgda schema: type: string + example: "36hQtSEXBMevo5chpxhfAGiCTSC34QKgda" - name: limit in: query description: max number of items to fetch @@ -794,9 +793,9 @@ paths: in: query description: index of the first items to fetch required: false - example: 42000 schema: type: integer + example: 42000 responses: 200: description: List of burnchain reward recipients and amounts @@ -827,9 +826,9 @@ paths: in: query description: index of first rewards to fetch required: false - example: 42000 schema: type: integer + example: 42000 responses: 200: description: List of burnchain reward recipients and amounts @@ -851,9 +850,9 @@ paths: in: path description: Reward recipient address. Should either be in the native burnchain's format (e.g. B58 for Bitcoin), or if a STX principal address is provided it will be encoded as into the equivalent burnchain format required: true - example: 36hQtSEXBMevo5chpxhfAGiCTSC34QKgda schema: type: string + example: "36hQtSEXBMevo5chpxhfAGiCTSC34QKgda" - name: limit in: query description: max number of rewards to fetch @@ -864,9 +863,9 @@ paths: in: query description: index of first rewards to fetch required: false - example: 42000 schema: type: integer + example: 42000 responses: 200: description: List of burnchain reward recipients and amounts @@ -888,9 +887,9 @@ paths: in: path description: Reward recipient address. Should either be in the native burnchain's format (e.g. B58 for Bitcoin), or if a STX principal address is provided it will be encoded as into the equivalent burnchain format required: true - example: 36hQtSEXBMevo5chpxhfAGiCTSC34QKgda schema: type: string + example: "36hQtSEXBMevo5chpxhfAGiCTSC34QKgda" responses: 200: description: List of burnchain reward recipients and amounts @@ -924,9 +923,9 @@ paths: in: path description: Contract identifier formatted as `.` required: true - example: SP6P4EJF0VG8V0RB3TQQKJBHDQKEF6NVRD1KZE3C.satoshibles schema: type: string + example: "SP6P4EJF0VG8V0RB3TQQKJBHDQKEF6NVRD1KZE3C.satoshibles" - name: unanchored in: query description: Include transaction data from unanchored (i.e. unconfirmed) microblocks @@ -985,9 +984,9 @@ paths: in: path description: Contract identifier formatted as `.` required: true - example: SP6P4EJF0VG8V0RB3TQQKJBHDQKEF6NVRD1KZE3C.satoshibles schema: type: string + example: "SP6P4EJF0VG8V0RB3TQQKJBHDQKEF6NVRD1KZE3C.satoshibles" - name: limit in: query description: max number of contract events to fetch @@ -998,9 +997,9 @@ paths: in: query description: index of first contract event to fetch required: false - example: 42000 schema: type: integer + example: 42000 - name: unanchored in: query description: Include transaction data from unanchored (i.e. unconfirmed) microblocks @@ -1047,9 +1046,9 @@ paths: in: path required: true description: Contract name - example: satoshibles schema: type: string + example: "satoshibles" - name: tip in: query schema: @@ -1084,16 +1083,16 @@ paths: in: path required: true description: Stacks address - example: SP6P4EJF0VG8V0RB3TQQKJBHDQKEF6NVRD1KZE3C schema: type: string + example: "SP6P4EJF0VG8V0RB3TQQKJBHDQKEF6NVRD1KZE3C" - name: contract_name in: path required: true description: Contract name - example: satoshibles schema: type: string + example: satoshibles - name: map_name in: path required: true @@ -1140,16 +1139,16 @@ paths: in: path required: true description: Stacks address - example: SP6P4EJF0VG8V0RB3TQQKJBHDQKEF6NVRD1KZE3C schema: type: string + example: "SP6P4EJF0VG8V0RB3TQQKJBHDQKEF6NVRD1KZE3C" - name: contract_name in: path required: true description: Contract name - example: satoshibles schema: type: string + example: satoshibles - name: proof in: query description: Returns object without the proof field if set to 0 @@ -1191,16 +1190,16 @@ paths: in: path required: true description: Stacks address - example: SP6P4EJF0VG8V0RB3TQQKJBHDQKEF6NVRD1KZE3C schema: type: string + example: "SP6P4EJF0VG8V0RB3TQQKJBHDQKEF6NVRD1KZE3C" - name: contract_name in: path required: true description: Contract name - example: satoshibles schema: type: string + example: satoshibles - name: function_name in: path required: true @@ -1238,9 +1237,9 @@ paths: in: path description: Stacks address or a Contract identifier required: true - example: SP31DA6FTSJX2WGTZ69SFY11BH51NZMB0ZW97B5P0 schema: type: string + example: "SP31DA6FTSJX2WGTZ69SFY11BH51NZMB0ZW97B5P0" - name: unanchored in: query description: Include transaction data from unanchored (i.e. unconfirmed) microblocks @@ -1253,9 +1252,9 @@ paths: in: query description: returned data representing the state up until that point in time, rather than the current block. required: false - example: 60000 schema: type: string + example: 60000 responses: 200: description: Success @@ -1277,14 +1276,13 @@ paths: - name: principal in: path description: Stacks address or a Contract identifier. - example: SP31DA6FTSJX2WGTZ69SFY11BH51NZMB0ZW97B5P0 required: true schema: type: string + example: "SP31DA6FTSJX2WGTZ69SFY11BH51NZMB0ZW97B5P0" - name: unanchored in: query description: Include transaction data from unanchored (i.e. unconfirmed) microblocks. - example: true required: false schema: type: boolean @@ -1294,9 +1292,9 @@ paths: in: query description: returned data representing the state up until that point in time, rather than the current block. Note - Use either of the query parameters but not both at a time. required: false - example: 60000 schema: type: string + example: 60000 responses: 200: description: Success @@ -1320,11 +1318,11 @@ paths: parameters: - name: principal in: path - description: Stacks address or a Contract identifier - example: SP31DA6FTSJX2WGTZ69SFY11BH51NZMB0ZW97B5P0 + description: Stacks address or a Contract identifier required: true schema: type: string + example: "SP31DA6FTSJX2WGTZ69SFY11BH51NZMB0ZW97B5P0" - name: limit in: query description: max number of account transactions to fetch @@ -1336,9 +1334,9 @@ paths: in: query description: index of first account transaction to fetch required: false - example: 42000 schema: type: integer + example: 42000 - name: height in: query description: Filter for transactions only at this given block height @@ -1358,9 +1356,9 @@ paths: in: query description: returned data representing the state up until that point in time, rather than the current block. Note - Use either of the query parameters but not both at a time. required: false - example: 60000 schema: type: string + example: 60000 responses: 200: description: Success @@ -1385,14 +1383,14 @@ paths: required: true schema: type: string - example: SP3FBR2AGK5H9QBDH3EEN6DF8EK8JY7RX8QJ5SVTE + example: "SP3FBR2AGK5H9QBDH3EEN6DF8EK8JY7RX8QJ5SVTE" - name: tx_id in: path description: Transaction id required: true schema: type: string - example: 0x34d79c7cfc2fe525438736733e501a4bf0308a5556e3e080d1e2c0858aad7448 + example: "0x34d79c7cfc2fe525438736733e501a4bf0308a5556e3e080d1e2c0858aad7448" responses: 200: description: Success @@ -1423,7 +1421,7 @@ paths: required: true schema: type: string - example: SP31DA6FTSJX2WGTZ69SFY11BH51NZMB0ZW97B5P0 + example: "SP31DA6FTSJX2WGTZ69SFY11BH51NZMB0ZW97B5P0" - name: limit in: query description: max number of account transactions to fetch @@ -1484,7 +1482,7 @@ paths: required: true schema: type: string - example: SP31DA6FTSJX2WGTZ69SFY11BH51NZMB0ZW97B5P0 + example: "SP31DA6FTSJX2WGTZ69SFY11BH51NZMB0ZW97B5P0" - name: block_height in: query description: Optionally get the nonce at a given block height. @@ -1498,7 +1496,7 @@ paths: required: false schema: type: string - example: 0x72d53f3cba39e149dcd42708e535bdae03d73e60d2fe853aaf61c0b392f521e9 + example: "0x72d53f3cba39e149dcd42708e535bdae03d73e60d2fe853aaf61c0b392f521e9" responses: 200: @@ -1522,9 +1520,9 @@ paths: in: path description: Stacks address or a Contract identifier required: true - example: SP31DA6FTSJX2WGTZ69SFY11BH51NZMB0ZW97B5P0 schema: type: string + example: "SP31DA6FTSJX2WGTZ69SFY11BH51NZMB0ZW97B5P0" - name: limit in: query description: max number of account assets to fetch @@ -1578,9 +1576,9 @@ paths: in: path description: Stacks address or a Contract identifier required: true - example: SP31DA6FTSJX2WGTZ69SFY11BH51NZMB0ZW97B5P0 schema: type: string + example: "SP31DA6FTSJX2WGTZ69SFY11BH51NZMB0ZW97B5P0" - name: limit in: query description: number of items to return @@ -1591,9 +1589,9 @@ paths: in: query description: number of items to skip required: false - example: 42000 schema: type: integer + example: 42000 - name: height in: query description: Filter for transfers only at this given block height @@ -1612,9 +1610,9 @@ paths: in: query description: returned data representing the state up until that point in time, rather than the current block. Note - Use either of the query parameters but not both at a time. required: false - example: 60000 schema: type: string + example: 60000 responses: 200: description: Success @@ -1641,9 +1639,9 @@ paths: in: path description: Stacks address or a Contract identifier required: true - example: SP31DA6FTSJX2WGTZ69SFY11BH51NZMB0ZW97B5P0 schema: type: string + example: "SP31DA6FTSJX2WGTZ69SFY11BH51NZMB0ZW97B5P0" - name: limit in: query description: number of items to return @@ -1654,9 +1652,9 @@ paths: in: query description: number of items to skip required: false - example: 42000 schema: type: integer + example: 42000 - name: unanchored in: query description: Include transaction data from unanchored (i.e. unconfirmed) microblocks @@ -1669,9 +1667,9 @@ paths: in: query description: returned data representing the state up until that point in time, rather than the current block. Note - Use either of the query parameters but not both at a time. required: false - example: 60000 schema: type: string + example: 60000 responses: 200: description: Success @@ -1699,9 +1697,9 @@ paths: in: path description: Stacks address or a Contract identifier required: true - example: SP31DA6FTSJX2WGTZ69SFY11BH51NZMB0ZW97B5P0 schema: type: string + example: "SP31DA6FTSJX2WGTZ69SFY11BH51NZMB0ZW97B5P0" - name: proof in: query description: Returns object without the proof field if set to 0 @@ -1926,9 +1924,9 @@ paths: - in: path name: id required: true - example: 0xcf8b233f19f6c07d2dc1963302d2436efd36e9afac127bf6582824a13961c06d schema: type: string + example: "0xcf8b233f19f6c07d2dc1963302d2436efd36e9afac127bf6582824a13961c06d" description: The hex hash string for a block or transaction, account address, or contract address - in: query name: include_metadata @@ -2410,9 +2408,9 @@ paths: in: path description: the namespace to fetch price for required: true - example: id schema: type: string + example: id responses: 200: description: Success @@ -2433,9 +2431,9 @@ paths: in: path description: the name to query price information for required: true - example: muneeb.id schema: type: string + example: muneeb.id responses: 200: description: Success @@ -2473,16 +2471,16 @@ paths: in: path description: the namespace to fetch names from. required: true - example: id schema: type: string + example: id - name: page in: query description: namespace values are defaulted to page 1 with 100 results. You can query specific page results by using the 'page' query parameter. required: false - example: 22 schema: type: integer + example: 22 responses: 200: description: Success @@ -2521,9 +2519,9 @@ paths: in: query description: names are defaulted to page 1 with 100 results. You can query specific page results by using the 'page' query parameter. required: false - example: 22 schema: type: integer + example: 22 responses: 200: description: Success @@ -2554,9 +2552,9 @@ paths: in: path description: fully-qualified name required: true - example: muneeb.id schema: type: string + example: muneeb.id responses: 200: description: Success @@ -2595,9 +2593,9 @@ paths: in: path description: fully-qualified name required: true - example: id.blockstack schema: type: string + example: id.blockstack responses: 200: description: Success @@ -2621,9 +2619,9 @@ paths: in: path description: fully-qualified name required: true - example: bar.test schema: type: string + example: bar.test responses: 200: description: Success @@ -2662,16 +2660,16 @@ paths: in: path description: fully-qualified name required: true - example: muneeb.id schema: type: string + example: muneeb.id - name: zoneFileHash in: path description: zone file hash required: true - example: b100a68235244b012854a95f9114695679002af9 schema: type: string + example: "b100a68235244b012854a95f9114695679002af9" responses: 200: description: Success @@ -2710,16 +2708,16 @@ paths: in: path description: the layer-1 blockchain for the address required: true - example: bitcoin schema: type: string + example: bitcoin - name: address in: path description: the address to lookup required: true - example: 1QJQxDas5JhdiXhEbNS14iNjr8auFT96GP schema: type: string + example: "1QJQxDas5JhdiXhEbNS14iNjr8auFT96GP" responses: 200: description: Success @@ -2783,9 +2781,9 @@ paths: # in: path # description: transaction id # required: true -# example: d04d708472ea3c147f50e43264efdb1535f71974053126dc4db67b3ac19d41fe # schema: # type: string +# example: "d04d708472ea3c147f50e43264efdb1535f71974053126dc4db67b3ac19d41fe" # responses: # 200: # description: Success @@ -2816,23 +2814,23 @@ paths: in: path description: Hash of block required: true - example: 0x0a83d82a65460a9e711f85a44616350280040b75317dbe486a923c1131b5ff99 schema: type: string + example: "0x0a83d82a65460a9e711f85a44616350280040b75317dbe486a923c1131b5ff99" - name: limit in: query description: max number of transactions to fetch required: false - example: 10 schema: type: integer + example: 10 - name: offset in: query description: index of first transaction to fetch required: false - example: 42000 schema: type: integer + example: 42000 responses: 200: description: List of Transactions @@ -2855,28 +2853,27 @@ paths: in: path description: Height of block required: true - example: 66119 schema: type: integer + example: 66119 - name: limit in: query description: max number of transactions to fetch required: false - example: 10 schema: type: integer + example: 10 - name: offset in: query description: index of first transaction to fetch required: false - example: 42000 schema: type: integer + example: 42000 - name: unanchored in: query description: Include transaction data from unanchored (i.e. unconfirmed) microblocks required: false - example: true schema: type: boolean example: true @@ -2903,28 +2900,27 @@ paths: in: path description: Transactions for the address required: true - example: SP197DVH8KTJGX4STM61QN0WJV8Y9QJWXV83ZGNR9 schema: type: string + example: "SP197DVH8KTJGX4STM61QN0WJV8Y9QJWXV83ZGNR9" - name: limit in: query description: max number of transactions to fetch required: false - example: 90 schema: type: integer + example: 90 - name: offset in: query description: index of first transaction to fetch required: false - example: 42000 schema: type: integer + example: 42000 - name: unanchored in: query description: Include transaction data from unanchored (i.e. unconfirmed) microblocks required: false - example: true schema: type: boolean example: true @@ -2959,10 +2955,9 @@ paths: in: query description: index of first tokens to fetch required: false - example: 42000 schema: type: integer - example: 500 + example: 42000 responses: 200: description: List of fungible tokens metadata @@ -2989,16 +2984,16 @@ paths: in: query description: token owner's STX address or Smart Contract ID required: true - example: SPNWZ5V2TPWGQGVDR6T7B6RQ4XMGZ4PXTEE0VQ0S.marketplace-v3 schema: type: string + example: "SPNWZ5V2TPWGQGVDR6T7B6RQ4XMGZ4PXTEE0VQ0S.marketplace-v3" - name: asset_identifiers in: query description: identifiers of the token asset classes to filter for required: false - example: SPQZF23W7SEYBFG5JQ496NMY0G7379SRYEDREMSV.Candy::candy schema: type: array + example: "SPQZF23W7SEYBFG5JQ496NMY0G7379SRYEDREMSV.Candy::candy" items: type: string - name: limit @@ -3012,10 +3007,10 @@ paths: in: query description: index of first tokens to fetch required: false - example: 42000 schema: type: integer default: 0 + example: 42000 - name: unanchored in: query description: whether or not to include tokens from unconfirmed transactions @@ -3061,16 +3056,16 @@ paths: in: query description: token asset class identifier required: true - example: SP2X0TZ59D5SZ8ACQ6YMCHHNR2ZN51Z32E2CJ173.the-explorer-guild::The-Explorer-Guild schema: type: string + example: "SP2X0TZ59D5SZ8ACQ6YMCHHNR2ZN51Z32E2CJ173.the-explorer-guild::The-Explorer-Guild" - name: value in: query description: hex representation of the token's unique value required: true - example: '0x0100000000000000000000000000000803' schema: type: string + example: "0x0100000000000000000000000000000803" - name: limit in: query description: max number of events to fetch @@ -3082,18 +3077,18 @@ paths: in: query description: index of first event to fetch required: false - example: 42000 schema: type: integer default: 0 + example: 42000 - name: unanchored in: query description: whether or not to include events from unconfirmed transactions required: false - example: true schema: type: boolean default: false + example: true - name: tx_metadata in: query description: whether or not to include the complete transaction metadata instead of just `tx_id`. Enabling this option can affect performance and response times. @@ -3131,9 +3126,9 @@ paths: in: query description: token asset class identifier required: true - example: SP2X0TZ59D5SZ8ACQ6YMCHHNR2ZN51Z32E2CJ173.the-explorer-guild::The-Explorer-Guild schema: type: string + example: "SP2X0TZ59D5SZ8ACQ6YMCHHNR2ZN51Z32E2CJ173.the-explorer-guild::The-Explorer-Guild" - name: limit in: query description: max number of events to fetch @@ -3145,10 +3140,10 @@ paths: in: query description: index of first event to fetch required: false - example: 42000 schema: type: integer default: 0 + example: 42000 - name: unanchored in: query description: whether or not to include events from unconfirmed transactions @@ -3198,9 +3193,9 @@ paths: in: query description: index of first tokens to fetch required: false - example: 42000 schema: type: integer + example: 42000 responses: 200: description: List of non fungible tokens metadata @@ -3249,7 +3244,7 @@ paths: required: true schema: type: string - example: SPSCWDV3RKV5ZRN1FQD84YE1NQFEDJ9R1F4DYQ11.newyorkcitycoin-token-v2 + example: "SPSCWDV3RKV5ZRN1FQD84YE1NQFEDJ9R1F4DYQ11.newyorkcitycoin-token-v2" responses: 200: description: Fungible tokens metadata for contract id @@ -3382,37 +3377,37 @@ paths: in: query description: Hash of transaction required: false - example: 0x29e25515652dad41ef675bd0670964e3d537b80ec19cf6ca6f1dd65d5bc642c5 + example: "0x29e25515652dad41ef675bd0670964e3d537b80ec19cf6ca6f1dd65d5bc642c5" schema: type: string - name: address in: query description: Stacks address or a Contract identifier required: false - example: ST1HB64MAJ1MBV4CQ80GF01DZS4T1DSMX20ADCRA4 schema: type: string + example: "ST1HB64MAJ1MBV4CQ80GF01DZS4T1DSMX20ADCRA4" - name: limit in: query description: number of items to return required: false - example: 100 schema: type: integer + example: 100 - name: offset in: query description: number of items to skip required: false - example: 42000 schema: type: integer + example: 42000 - name: type in: query description: Filter the events on event type required: false - example: stx_lock schema: type: array + example: stx_lock items: type: string enum: [smart_contract_log, stx_lock, stx_asset, fungible_token_asset, non_fungible_token_asset]