{"openapi": "3.0.0", "info": {"title": "Hypurrscan API", "version": "0.1", "description": "This is a brief overview of the Hypurrscan API <br>\nGlobal rate limits are : **1000/minute/IP** with weight of each endpoints precised in it <br>\nI will try to notify before any major changes in [https://t.me/hypurrscan](https://t.me/hypurrscan) but please be cautious. <br>\nExperimentals endpoints could change (structure and weight) at any time <br>\n"}, "components": {"securitySchemes": {"jwt": {"type": "http", "scheme": "bearer", "bearerFormat": "JWT", "x-bearerInfoFunc": "hypurrscanAPI.decode_token", "description": "Enter JWT token with Bearer prefix"}}}, "servers": [{"url": ""}], "paths": {"/holders/{token}": {"get": {"summary": "List of holders of a token (1)", "description": "Return the list of holders of a token with a balance associated with each one (weight\\:1)", "operationId": "hypurrscanAPI.get_holders", "responses": {"200": {"description": "Dict with holders list and timestamp of last update", "content": {"application/json": {"schema": {"type": "object", "properties": {"length": {"type": "integer"}, "lastUpdate": {"type": "integer"}, "addresses": {"type": "object"}}, "example": {"length": 2, "lastUpdate": 1719433435, "addresses": {"0x370b1beeb9996e692cff6fb5ce6fe1a5609e9dbb": 0.01961584, "0x165c290a69b99841647b9a0ce433d50286962dd5": 0.00920148}}}}}}}, "parameters": [{"name": "token", "in": "path", "description": "Name of HIP-1 Token.", "required": true, "schema": {"type": "string", "example": "PURR"}}], "tags": ["Tokens"]}}, "/holdersWithLimit/{token}/{limit}": {"get": {"summary": "List of first top x holders of a token (2)", "description": "Return the list of the top x holders of a token with a balance associated with each one (weight\\:2)", "operationId": "hypurrscanAPI.get_holders_with_limit", "responses": {"200": {"description": "Dict with holders list and timestamp of last update", "content": {"application/json": {"schema": {"type": "object", "properties": {"length": {"type": "integer"}, "lastUpdate": {"type": "integer"}, "addresses": {"type": "object"}}, "example": {"length": 2, "lastUpdate": 1719433435, "addresses": {"0x370b1beeb9996e692cff6fb5ce6fe1a5609e9dbb": 0.01961584, "0x165c290a69b99841647b9a0ce433d50286962dd5": 0.00920148}}}}}}}, "parameters": [{"name": "token", "in": "path", "description": "Name of HIP-1 Token.", "required": true, "schema": {"type": "string", "example": "PURR"}}, {"name": "limit", "in": "path", "description": "Number of addresses to return", "required": true, "schema": {"type": "integer", "example": 100}}], "tags": ["Tokens"]}}, "/holdersAtTime/{token}/{timestamp}": {"get": {"summary": "List of holders of a token at a given timestamp (2)", "description": "Return the list of holders of a token with a balance associated with each one at (or closest to) a given timestamp (look for the next timestamp at which there is a snapshot) (weight\\:2)", "operationId": "hypurrscanAPI.get_holders_at_timestamp", "responses": {"200": {"description": "Dict with holders list and timestamp of last update", "content": {"application/json": {"schema": {"type": "object", "properties": {"length": {"type": "integer"}, "lastUpdate": {"type": "integer"}, "addresses": {"type": "object"}}, "example": {"length": 2, "lastUpdate": 1719433435, "addresses": {"0x370b1beeb9996e692cff6fb5ce6fe1a5609e9dbb": 0.01961584, "0x165c290a69b99841647b9a0ce433d50286962dd5": 0.00920148}}}}}}}, "parameters": [{"name": "token", "in": "path", "description": "Name of HIP-1 Token.", "required": true, "schema": {"type": "string", "example": "PURR"}}, {"name": "timestamp", "in": "path", "description": "Timestamp (in seconds)", "required": true, "schema": {"type": "integer", "example": 1719578667}}], "tags": ["Tokens"]}}, "/holdersAtTimeWithLimit/{token}/{timestamp}/{limit}": {"get": {"summary": "List of top x holders of a token at a given timestamp (4)", "description": "Return the list of top x holders of a token with a balance associated with each one at (or closest to) a given timestamp (look for the next timestamp at which there is a snapshot) (weight\\:4)", "operationId": "hypurrscanAPI.get_holders_at_timestamp_with_limit", "responses": {"200": {"description": "Dict with holders list and timestamp of last update", "content": {"application/json": {"schema": {"type": "object", "properties": {"length": {"type": "integer"}, "lastUpdate": {"type": "integer"}, "addresses": {"type": "object"}}, "example": {"length": 2, "lastUpdate": 1719433435, "addresses": {"0x370b1beeb9996e692cff6fb5ce6fe1a5609e9dbb": 0.01961584, "0x165c290a69b99841647b9a0ce433d50286962dd5": 0.00920148}}}}}}}, "parameters": [{"name": "token", "in": "path", "description": "Name of HIP-1 Token.", "required": true, "schema": {"type": "string", "example": "PURR"}}, {"name": "timestamp", "in": "path", "description": "Timestamp (in seconds)", "required": true, "schema": {"type": "integer", "example": 1719578667}}, {"name": "limit", "in": "path", "description": "Number of addresses to return", "required": true, "schema": {"type": "integer", "example": 1000}}], "tags": ["Tokens"]}}, "/twap/{tokenOrAddress}": {"get": {"summary": "List of current TWAPs (1-4)", "description": "Return the list of current \"active\" TWAPs for a token or an address (weight\\:1-4 *->1 / others->4)", "operationId": "hypurrscanAPI.get_twap", "responses": {"200": {"description": "List of actives TWAPs", "content": {"application/json": {"schema": {"type": "array", "items": {"type": "object", "properties": {"time": {"type": "integer", "example": 1719406685203}, "user": {"type": "string", "example": "0xf2e65447c789bb64c8d5991a468f0eecf5bf8408"}, "action": {"type": "object", "properties": {"type": {"type": "string", "example": "twapOrder"}, "twap": {"type": "object", "properties": {"a": {"description": "Market", "type": "integer", "example": 10000}, "b": {"description": "Buy", "type": "boolean", "example": true}, "s": {"description": "Size", "type": "string", "example": "111298"}, "r": {"description": "Reduce only", "type": "boolean", "example": false}, "m": {"description": "Duration of the TWAP in minutes", "type": "integer", "example": 600}, "t": {"description": "Randomize", "type": "boolean", "example": true}}}}}, "block": {"type": "integer", "example": 207494684}, "hash": {"type": "string", "example": "0xb3b0640a5d931b89271b040c5e1e1c015800ab7f7b2611f705684822e11ca4a3"}, "error": {"type": "string", "example": null}, "ended": {"type": "string", "example": "ended"}}}}}}}}, "parameters": [{"name": "tokenOrAddress", "in": "path", "description": "Name of HIP-1 Token or Address", "required": true, "examples": {"token": {"summary": "Token", "value": "PURR"}, "address": {"summary": "Address", "value": "0xf2e65447c789bb64c8d5991a468f0eecf5bf8408"}}, "schema": {"type": "string"}}], "tags": ["Addresses", "Tokens"]}}, "/tokenDetails/{token}": {"get": {"summary": "Details for a token (1)", "description": "Return a dict with details of a token (weight\\:1)", "operationId": "hypurrscanAPI.get_token_details", "responses": {"200": {"description": "Dict with details of a token", "content": {"application/json": {"schema": {"type": "object", "example": {"name": "PURR", "img": "PURR.png", "desc": "There is no sale and no planned utility for $PURR. The max supply of $PURR was 1 billion. 500 million $PURR were distributed proportionally to points holders. 400 million $PURR initially deployed as Hyperliquidity (HIP-2) were burned. $PURR is deflationary, as trading fees paid in $PURR are burned."}}}}}}, "parameters": [{"name": "token", "in": "path", "description": "Token name", "required": true, "schema": {"type": "string", "example": "PURR"}}], "tags": ["Tokens"]}}, "/rank/{address}": {"get": {"summary": "Ranks for an address (1)", "description": "Return a dict with a rank associated with each token an address holds (weight\\:1)", "operationId": "hypurrscanAPI.get_rank", "responses": {"200": {"description": "Dict with rank associated with each toke", "content": {"application/json": {"schema": {"type": "object", "example": {"ANSEM": 149, "HFUN": 153, "CZ": 2284, "CAPPY": 140, "SCHIZO": 15, "POINTS": 292, "TRUMP": 586, "BAGS": 8925, "RUG": 3511, "KOBE": 291, "SELL": 41, "GMEOW": 279, "USDC": 89, "ILIENS": 113, "PEPE": 747, "FUCKY": 1340, "MANLET": 698, "PURR": 85, "LICK": 1059, "SIX": 162, "WAGMI": 296, "TATE": 145, "JEFF": 270, "XULIAN": 70}}}}}}, "parameters": [{"name": "address", "in": "path", "description": "Address", "required": true, "schema": {"type": "string", "example": "0xD4416b13d2b3a9aBae7AcD5D6C2BbDBE25686401"}}], "tags": ["Addresses"]}}, "/tags/{address}": {"get": {"summary": "Tags for an address (1)", "description": "Return a list of tags associated with an address (weight\\:1)", "operationId": "hypurrscanAPI.get_tags", "responses": {"200": {"description": "List of tags associated with the address", "content": {"application/json": {"schema": {"type": "array", "example": ["HFUN Bot User", "Deployer"]}}}}}, "parameters": [{"name": "address", "in": "path", "description": "Address", "required": true, "schema": {"type": "string", "example": "0xD4416b13d2b3a9aBae7AcD5D6C2BbDBE25686401"}}], "tags": ["Addresses"]}}, "/tags/addresses": {"post": {"summary": "Tags for a list of addresses (4)", "description": "Return a dictionary with a list of tags associated with each address (weight\\:4)", "operationId": "hypurrscanAPI.get_tags_list", "requestBody": {"required": true, "content": {"application/json": {"schema": {"type": "object", "properties": {"addresses": {"type": "array", "items": {"type": "string"}, "example": ["0xD4416b13d2b3a9aBae7AcD5D6C2BbDBE25686401"]}}, "required": ["addresses"]}}}}, "responses": {"200": {"description": "List of tags associated with the addresses", "content": {"application/json": {"schema": {"type": "object", "example": {"0xD4416b13d2b3a9aBae7AcD5D6C2BbDBE25686401": ["HFUN Bot User", "Deployer"]}}}}}}, "tags": ["Addresses"]}}, "/addAddress/{address}": {"get": {"summary": "Add an address to the watch list (1)", "description": "Add an address to the watch list that will be looked in the next successful update call (weight\\:1)", "operationId": "hypurrscanAPI.post_add_address", "responses": {"200": {"description": "Status of address in watch list", "content": {"application/json": {"schema": {"type": "string"}, "examples": {"example1": {"summary": "Address added", "value": "Added"}, "example2": {"summary": "Address already in list", "value": "Already there"}}}}}}, "parameters": [{"name": "address", "in": "path", "description": "Address", "required": true, "schema": {"type": "string", "example": "0xD4416b13d2b3a9aBae7AcD5D6C2BbDBE25686401"}}], "tags": ["Addresses"]}}, "/addressDetails/{address}": {"get": {"summary": "Detailed information for an address (1)", "description": "Return a dict of detailed infos for an address (weight\\:1)", "operationId": "hypurrscanAPI.get_address_details", "responses": {"200": {"description": "Dict of infos associated with the address", "content": {"application/json": {"schema": {"type": "object", "example": {}}}}}}, "parameters": [{"name": "address", "in": "path", "description": "Address", "required": true, "schema": {"type": "string", "example": "0xD4416b13d2b3a9aBae7AcD5D6C2BbDBE25686401"}}], "tags": ["Addresses"]}}, "/globalAliases": {"get": {"summary": "List global aliases (1)", "description": "Return list of global aliases (weight\\:1)", "operationId": "hypurrscanAPI.get_globalAliases", "responses": {"200": {"description": "blah", "content": {"application/json": {"schema": {"type": "object", "example": {"0xffffffffffffffffffffffffffffffffffffffff": "HIP-2", "0xd9e123f1d89860bca5f368e6cac0ccbf5f6b61af": "RUG Deployer", "0x57fa3dd7d4afd23ad4ffb8dc3f6e0451841f9f1c": "PEPE Deployer", "0x02327a889869195464d32a466d0606053fc19598": "CAPPY Deployer", "0x2857532d16209ada3869fb65df859a3320de5e14": "TRUMP Deployer", "0xcc16ae2ffc076d7bcd5ec3fb1e9aa5c2984133a1": "SIX Deployer", "0x1c49e03f3683fd39bc01751378c7f59cbb97d1b0": "GMEOW Deployer", "0xfe636473dcb6d86bbbb6165dd4b080c2f0decc31": "XULIAN Deployer", "0x17a4ce9320bec0ac79420f0af19848044a469d8d": "POINTS Deployer", "0xe2a0cc663acfe5d7a9cb82a743383297597a8ff3": "HFUN Deployer", "0x8191fed3f7c09fd9ee0fbd4b3ab485911ec6e8cc": "MANLET Deployer", "0x1406125fde50b26bcd783b2cc1ed16a18621df27": "LICK Deployer", "0x1d4c01e15a637cb3cbaf86ffbb02e5a260d01fbc": "PURR Deployer", "0x86c66b00257dc08d4e33dc7c50e9a05c1937b397": "WAGMI Deployer", "0x81196517de1d77ebc8a1951c3ea1a103e732479c": "JEFF Deployer", "0x501a76325a353a4249740ada1d4bce46dbdd67d6": "HFUN Fees Receiver", "0xfacb7404c1fad06444bda161d1304e4b7aa14e77": "FUCKY Deployer", "0xf517639a8872e756ac98d3c65507d2ebc25cc032": "CZ Deployer", "0x658be0b5fd675b279779d45990904c6392c8b49f": "BAGS Deployer", "0xedf5a40efa20b78beffc2e1c02be97b9fb726662": "ANSEM Deployer", "0xa9fb6044fc1f468955995b2c637bdc4ba7c1d2ea": "TATE Deployer", "0x3897a4701f7da780384c4ba44ef30ed7b18c3830": "PUMP Deployer", "0x000000000000000000000000000000000000dead": "Burn Address", "0xfa10fcd5f3e56d87b76bbe5c62d85c422ed25342": "KOBE Deployer", "0x942f00b378fdb388bfae1723ea3b7953b2ae6969": "XULIAN/ILIENS Dev Wallet", "0xf634efe7ecc04d2be811f4968d12c7ea7b458b98": "HAPPY Deployer", "0x03738f950aa079dc8afbe287244111f29e2d3bb5": "SELL Deployer", "0x27bf82cee5693f43d32773d884ba8727c8e89b90": "CATNIP Deployer"}}}}}}, "tags": ["Global"]}}, "/pastAuctions": {"get": {"summary": "List of successful past auctions (1)", "description": "Return the list of sucessful past spot auctions (weight\\:1)", "operationId": "hypurrscanAPI.get_pastAuctions", "responses": {"200": {"description": "List of past spot auctions", "content": {"application/json": {"schema": {"type": "array", "items": {"type": "object", "properties": {"time": {"type": "integer", "example": 1719036696417}, "deployer": {"type": "string", "example": "0xe2a0cc663acfe5d7a9cb82a743383297597a8ff3"}, "name": {"type": "string", "example": "SCHIZO"}, "gas": {"type": "string", "example": "7342.04"}}}}}}}}, "tags": ["Global"]}}, "/pastAuctionsPair": {"get": {"summary": "List of successful past pair auctions (1)", "description": "Return the list of sucessful past pair auctions (weight\\:1)", "operationId": "hypurrscanAPI.get_pastAuctionsPair", "responses": {"200": {"description": "List of past spot auctions", "content": {"application/json": {"schema": {"type": "array", "items": {"type": "object", "properties": {"time": {"type": "integer", "example": 1719036696417}, "deployer": {"type": "string", "example": "0xa7be37a1df0143c7c8f5bfb9a3ea3c3ed4c3365d"}, "name": {"type": "string", "example": "XAUT0-USDT0"}, "gas": {"type": "string", "example": "500"}}}}}}}}, "tags": ["Global"]}}, "/pastAuctionsPerp": {"get": {"summary": "List of successful past perp auctions (1)", "description": "Return the list of sucessful past perp auctions (weight\\:1)", "operationId": "hypurrscanAPI.get_pastAuctionsPerp", "responses": {"200": {"description": "List of past spot auctions", "content": {"application/json": {"schema": {"type": "array", "items": {"type": "object", "properties": {"time": {"type": "integer", "example": 1719036696417}, "deployer": {"type": "string", "example": "0xc65008a70f511ae0407d26022ff1516422acea94"}, "name": {"type": "string", "example": "vntls:vOAI"}, "gas": {"type": "string", "example": "500"}}}}}}}}, "tags": ["Global"]}}, "/deploys": {"get": {"summary": "List of deploys related txs (1)", "description": "Return the list of last 50 deploy related txs (weight\\:1)", "operationId": "hypurrscanAPI.get_deploys", "responses": {"200": {"description": "List of deploys related txs", "content": {"application/json": {"schema": {"type": "array", "example": [{"time": 1719403211633, "user": "0x03738f950aa079dc8afbe287244111f29e2d3bb5", "action": {"type": "spotDeploy", "registerHyperliquidity": {"spot": 24, "startPx": "0.00004", "orderSz": "25000.0", "nOrders": 4000}}, "block": 207459251, "hash": "0xa0e9adfc63ed58b83b8e040c5d93b301c10099570bffdb6d2e39837d498dbe41", "error": null}, {"time": 1719435970445, "user": "0xa6e8fee68b46f3df678316f02a4cb287a6bd1331", "action": {"type": "spotDeploy", "registerToken2": {"spec": {"name": "TEST", "szDecimals": 1, "weiDecimals": 6}, "maxGas": 11921507268}}, "block": 207791639, "hash": "0x3e3fec8f4975a0070bb1040c62a61701da0082bc9e15dfd343d5e0b66c77c332", "error": "Error deploying spot: Insufficient gas at current auction price. Transfer USDC to perps balance to deploy."}]}}}}}, "tags": ["Global"]}}, "/allDeploys": {"get": {"summary": "List of deploys related txs (10)", "description": "Return the list of deploy related txs (weight\\:10)", "operationId": "hypurrscanAPI.get_all_deploys", "responses": {"200": {"description": "List of all deploys related txs", "content": {"application/json": {"schema": {"type": "array", "example": [{"time": 1719403211633, "user": "0x03738f950aa079dc8afbe287244111f29e2d3bb5", "action": {"type": "spotDeploy", "registerHyperliquidity": {"spot": 24, "startPx": "0.00004", "orderSz": "25000.0", "nOrders": 4000}}, "block": 207459251, "hash": "0xa0e9adfc63ed58b83b8e040c5d93b301c10099570bffdb6d2e39837d498dbe41", "error": null}, {"time": 1719435970445, "user": "0xa6e8fee68b46f3df678316f02a4cb287a6bd1331", "action": {"type": "spotDeploy", "registerToken2": {"spec": {"name": "TEST", "szDecimals": 1, "weiDecimals": 6}, "maxGas": 11921507268}}, "block": 207791639, "hash": "0x3e3fec8f4975a0070bb1040c62a61701da0082bc9e15dfd343d5e0b66c77c332", "error": "Error deploying spot: Insufficient gas at current auction price. Transfer USDC to perps balance to deploy."}]}}}}}, "tags": ["Global"]}}, "/spotUSDC": {"get": {"summary": "Experimental (1)", "description": "Experimental (weight\\:1)", "operationId": "hypurrscanAPI.get_spotUSDC", "responses": {"200": {"description": "Experimental", "content": {"application/json": {"schema": {"type": "array", "example": []}}}}}, "tags": ["Experimental"]}}, "/someTxs": {"get": {"summary": "Experimental (1)", "description": "Experimental (weight\\:1)", "operationId": "hypurrscanAPI.get_someTxs", "responses": {"200": {"description": "Experimental", "content": {"application/json": {"schema": {"type": "array", "example": []}}}}}, "tags": ["Experimental"]}}, "/someMoreTxs": {"get": {"summary": "Experimental (20)", "description": "Experimental (weight\\:20)", "operationId": "hypurrscanAPI.get_someMoreTxs", "responses": {"200": {"description": "Experimental", "content": {"application/json": {"schema": {"type": "array", "example": []}}}}}, "tags": ["Experimental"]}}, "/bridges": {"get": {"summary": "Experimental (1)", "description": "Experimental (weight\\:1)", "operationId": "hypurrscanAPI.get_bridges", "responses": {"200": {"description": "Experimental", "content": {"application/json": {"schema": {"type": "array", "example": []}}}}}, "tags": ["Experimental"]}}, "/validating": {"get": {"summary": "Experimental (1)", "description": "Experimental (weight\\:1)", "operationId": "hypurrscanAPI.get_validating", "responses": {"200": {"description": "Experimental", "content": {"application/json": {"schema": {"type": "array", "example": []}}}}}, "tags": ["Experimental"]}}, "/allDelegations": {"get": {"summary": "Experimental (50)", "description": "Experimental (weight\\:50)", "operationId": "hypurrscanAPI.get_all_delegations", "responses": {"200": {"description": "Experimental", "content": {"application/json": {"schema": {"type": "array", "example": []}}}}}, "tags": ["Experimental"]}}, "/delegations": {"get": {"summary": "Experimental (1)", "description": "Experimental (weight\\:1)", "operationId": "hypurrscanAPI.get_delegations", "responses": {"200": {"description": "Experimental", "content": {"application/json": {"schema": {"type": "array", "example": []}}}}}, "tags": ["Experimental"]}}, "/delegationsByValidator/{validator}": {"get": {"summary": "Experimental (1)", "description": "Experimental (weight\\:1)", "operationId": "hypurrscanAPI.get_delegations_by_validator", "responses": {"200": {"description": "Experimental", "content": {"application/json": {"schema": {"type": "array", "example": []}}}}}, "parameters": [{"name": "validator", "in": "path", "description": "Validator address", "required": true, "schema": {"type": "string", "example": "0xabcdeff4b3727b83a23697500eef089020df2cd2"}}], "tags": ["Experimental"]}}, "/transfers": {"get": {"summary": "Experimental (1)", "description": "Experimental (weight\\:1)", "operationId": "hypurrscanAPI.get_transfers", "responses": {"200": {"description": "Experimental", "content": {"application/json": {"schema": {"type": "array", "example": []}}}}}, "tags": ["Experimental"]}}, "/aLotOfTransfers": {"get": {"summary": "Experimental (5)", "description": "Experimental (weight\\:5)", "operationId": "hypurrscanAPI.get_aLotOfTransfers", "responses": {"200": {"description": "Experimental", "content": {"application/json": {"schema": {"type": "array", "example": []}}}}}, "tags": ["Experimental"]}}, "/pasteke": {"get": {"summary": "Experimental (1)", "description": "Experimental (weight\\:1)", "operationId": "hypurrscanAPI.get_pasteke", "responses": {"200": {"description": "Experimental", "content": {"application/json": {"schema": {"type": "object", "example": []}}}}}, "tags": ["Experimental"]}}, "/holdersStats": {"get": {"summary": "Experimental (20)", "description": "Experimental (weight\\:20)", "operationId": "hypurrscanAPI.get_holders_stats", "responses": {"200": {"description": "Experimental", "content": {"application/json": {"schema": {"type": "object", "example": []}}}}}, "tags": ["Experimental"]}}, "/feesRecent": {"get": {"summary": "Fees for last 48h (1)", "description": "Return all fee datapoints from the last 48 hours (weight:1)", "operationId": "hypurrscanAPI.get_fees_recent", "responses": {"200": {"description": "All fee datapoints from last 48h", "content": {"application/json": {"schema": {"type": "array", "example": []}}}}}, "tags": ["Experimental"]}}, "/fees": {"get": {"summary": "Experimental (10)", "description": "Experimental (weight\\:10)", "operationId": "hypurrscanAPI.get_fees", "responses": {"200": {"description": "Experimental", "content": {"application/json": {"schema": {"type": "object", "example": []}}}}}, "tags": ["Experimental"]}}, "/unstakingQueue": {"get": {"summary": "Experimental (2)", "description": "Experimental (weight\\:2)", "operationId": "hypurrscanAPI.get_unstaking_queue", "responses": {"200": {"description": "Experimental", "content": {"application/json": {"schema": {"type": "object", "example": []}}}}}, "tags": ["Experimental"]}}, "/fullUnstakingQueue": {"get": {"summary": "Experimental (20)", "description": "Experimental (weight\\:20)", "operationId": "hypurrscanAPI.get_full_unstaking_queue", "responses": {"200": {"description": "Experimental", "content": {"application/json": {"schema": {"type": "object", "example": []}}}}}, "tags": ["Experimental"]}}, "/getRef/{ref}": {"get": {"security": [{"jwt": []}], "summary": "Do not use", "description": "Do not use", "operationId": "hypurrscanAPI.get_ref", "responses": {"200": {"description": "None", "content": {"application/json": {"schema": {"type": "array"}}}}}, "parameters": [{"name": "ref", "in": "path", "description": "string", "required": true, "schema": {"type": "string", "example": ""}}], "tags": ["Private"]}}, "/ips": {"get": {"summary": "Do not use", "description": "Do not use", "operationId": "hypurrscanAPI.get_ips", "responses": {"200": {"description": "None", "content": {"application/json": {"schema": {"type": "array"}}}}}, "tags": ["Private"]}}, "/status": {"get": {"summary": "Do not use", "description": "Do not use", "operationId": "hypurrscanAPI.get_status", "responses": {"200": {"description": "None", "content": {"application/json": {"schema": {"type": "array"}}}}}, "tags": ["Private"]}}, "/metrics": {"get": {"summary": "Do not use", "description": "Do not use", "operationId": "hypurrscanAPI.get_metrics", "responses": {"200": {"description": "None", "content": {"application/json": {"schema": {"type": "array"}}}}}, "tags": ["Private"]}}, "/metrics2": {"get": {"summary": "Do not use", "description": "Do not use", "operationId": "hypurrscanAPI.get_metrics2", "responses": {"200": {"description": "None", "content": {"application/json": {"schema": {"type": "array"}}}}}, "tags": ["Private"]}}, "/metrics/addresses": {"get": {"summary": "Top queried addresses", "description": "Returns top queried addresses per timeframe in Prometheus format", "operationId": "hypurrscanAPI.get_address_metrics", "parameters": [{"name": "timeframe", "in": "query", "required": false, "schema": {"type": "string", "enum": ["10min", "hour", "day", "all"], "default": "all"}}, {"name": "limit", "in": "query", "required": false, "schema": {"type": "integer", "default": 10, "maximum": 100}}], "responses": {"200": {"description": "Prometheus-format metrics", "content": {"text/plain": {"schema": {"type": "string"}}}}}, "tags": ["Private"]}}, "/aliases/share": {"post": {"summary": "Share a list of aliases (10)", "description": "Upload your aliases list and return a code to access it on another device  (weight\\:10)", "operationId": "hypurrscanAPI.post_aliases", "requestBody": {"required": true, "content": {"application/json": {"schema": {"type": "object", "properties": {"aliases": {"type": "object", "items": {"type": "string"}, "example": {"0x1d4c01e15a637cb3cbaf86ffbb02e5a260d01fbc": "PURR Deployer"}}}, "required": ["aliases"]}}}}, "responses": {"200": {"description": "Code", "content": {"application/json": {"schema": {"type": "object", "example": {"code": ""}}}}}}, "tags": ["Experimental"]}}, "/bundles/share": {"post": {"summary": "Share a list of bundles (10)", "description": "Upload your bundles list and return a code to access it on another device  (weight\\:10)", "operationId": "hypurrscanAPI.post_bundles", "requestBody": {"required": true, "content": {"application/json": {"schema": {"type": "object", "properties": {"bundles": {"type": "object", "additionalProperties": {"type": "object", "required": ["name", "addresses"], "properties": {"name": {"type": "string", "maxLength": 100}, "addresses": {"type": "array", "items": {"type": "string"}, "maxItems": 200}, "x": {"type": "string", "maxLength": 255, "default": ""}, "telegram": {"type": "string", "maxLength": 255, "default": ""}}}, "example": {"myBundle": {"name": "myBundle", "addresses": ["0x1d4c01e15a637cb3cbaf86ffbb02e5a260d01fbc"], "x": "@handle", "telegram": "@tg"}}}}, "required": ["bundles"]}}}}, "responses": {"200": {"description": "Code", "content": {"application/json": {"schema": {"type": "object", "properties": {"code": {"type": "string"}}, "example": {"code": "uuid-here"}}}}}}, "tags": ["Experimental"]}}, "/aliases/get/{code}": {"get": {"summary": "Get a list of aliases (1)", "description": "Retrieve previously uploaded list of aliases  (weight\\:1)", "operationId": "hypurrscanAPI.get_aliases", "responses": {"200": {"description": "Code", "content": {"application/json": {"schema": {"type": "object", "example": {"code": ""}}}}}}, "tags": ["Experimental"]}}, "/bundles/get/{code}": {"get": {"summary": "Get a list of bundles (1)", "description": "Retrieve previously uploaded list of bundles  (weight\\:1)", "operationId": "hypurrscanAPI.get_bundles", "parameters": [{"name": "code", "in": "path", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"description": "Bundle data", "content": {"application/json": {"schema": {"type": "object", "additionalProperties": {"type": "object", "properties": {"name": {"type": "string"}, "addresses": {"type": "array", "items": {"type": "string"}}, "x": {"type": "string"}, "telegram": {"type": "string"}}}, "example": {"myBundle": {"name": "myBundle", "addresses": ["0x1d4c01e15a637cb3cbaf86ffbb02e5a260d01fbc"], "x": "@handle", "telegram": "@tg"}}}}}}}, "tags": ["Experimental"]}}, "/transfers/{fromTimestamp}/{toTimestamp}": {"get": {"security": [{"jwt": []}], "summary": "Get transfers within timeframe", "description": "Retrieve transfers between two timestamps (weight:1)", "operationId": "hypurrscanAPI.get_transfers_from_to", "parameters": [{"name": "fromTimestamp", "in": "path", "required": true, "schema": {"type": "integer", "description": "Start timestamp in milliseconds"}}, {"name": "toTimestamp", "in": "path", "required": true, "schema": {"type": "integer", "description": "End timestamp in milliseconds"}}], "responses": {"200": {"description": "List of transfers", "content": {"application/json": {"schema": {"type": "array", "items": {"type": "object"}}}}}}, "tags": ["Private"]}}, "/bridges/{fromTimestamp}/{toTimestamp}": {"get": {"security": [{"jwt": []}], "summary": "Get bridges within timeframe", "description": "Retrieve bridges between two timestamps (weight:1)", "operationId": "hypurrscanAPI.get_bridges_from_to", "parameters": [{"name": "fromTimestamp", "in": "path", "required": true, "schema": {"type": "integer", "description": "Start timestamp in milliseconds"}}, {"name": "toTimestamp", "in": "path", "required": true, "schema": {"type": "integer", "description": "End timestamp in milliseconds"}}], "responses": {"200": {"description": "List of bridges", "content": {"application/json": {"schema": {"type": "array", "items": {"type": "object"}}}}}}, "tags": ["Private"]}}, "/issues/report": {"post": {"summary": "Create a new GitHub issue", "operationId": "hypurrscanAPI.create_issue", "requestBody": {"required": true, "content": {"application/json": {"schema": {"type": "object", "required": ["type", "title", "description", "priority", "hash", "environment", "userAgent", "url", "timestamp", "nonce"], "properties": {"type": {"type": "string", "enum": ["bug", "feature", "other"]}, "title": {"type": "string", "minLength": 1, "maxLength": 100}, "description": {"type": "string", "minLength": 1, "maxLength": 1000}, "steps": {"type": "string", "maxLength": 500, "default": ""}, "objects": {"type": "string", "default": ""}, "message": {"type": "string", "default": ""}, "priority": {"type": "string", "enum": ["low", "medium", "high", "critical"]}, "contact": {"type": "string", "default": ""}, "nonce": {"type": "string", "minLength": 1}, "hash": {"type": "string", "minLength": 1}, "environment": {"type": "object", "required": ["browser", "os", "screen", "currentPage"], "properties": {"browser": {"type": "string"}, "os": {"type": "string"}, "screen": {"type": "string"}, "currentPage": {"type": "string"}}}, "userAgent": {"type": "string"}, "url": {"type": "string"}, "timestamp": {"type": "string"}}}}}}, "responses": {"200": {"description": "Issue created successfully", "content": {"application/json": {"schema": {"type": "object", "properties": {"success": {"type": "boolean"}, "issue_number": {"type": "integer"}, "issue_url": {"type": "string"}, "message": {"type": "string"}}}}}}, "400": {"description": "Bad request - validation error or invalid proof of work", "content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string"}}}}}}, "500": {"description": "Internal server error", "content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string"}}}}}}}, "tags": ["Issues"]}}, "/search/{query}": {"get": {"summary": "Search autocomplete (10)", "description": "Search for addresses, .hl names, .eth names, and labeled addresses.\nReturns up to 10 results sorted by volume. (weight: 10)\n\nQuery types:\n- `0x...` - Search addresses by prefix\n- `*.hl` - Search Hyperliquid names\n- `*.eth` - Search ENS names\n- Other text - Search all names and labels\n", "operationId": "hypurrscanAPI.search_autocomplete", "parameters": [{"name": "query", "in": "path", "description": "Search query (minimum 3 characters)", "required": true, "schema": {"type": "string", "minLength": 3, "example": "vitalik"}}], "responses": {"200": {"description": "Search results", "content": {"application/json": {"schema": {"type": "object", "properties": {"results": {"type": "array", "items": {"type": "object", "properties": {"type": {"type": "string", "enum": ["hl", "eth", "address"], "description": "Result type"}, "address": {"type": "string", "description": "Ethereum-style address (0x prefixed)"}, "name": {"type": "string", "description": "Human-readable name (for hl/eth types)"}, "label": {"type": "string", "description": "Known address label (for address type)"}}}}}, "example": {"results": [{"type": "hl", "name": "hypurr.hl", "address": "0x1234567890abcdef1234567890abcdef12345678"}, {"type": "address", "address": "0xabcdef1234567890abcdef1234567890abcdef12", "label": "Binance Hot Wallet"}]}}}}}, "400": {"description": "Query too short", "content": {"application/json": {"schema": {"type": "object", "properties": {"error": {"type": "string"}, "min_length": {"type": "integer"}}, "example": {"error": "Query too short", "min_length": 3}}}}}}, "tags": ["Search"]}}}}
