Hyyperlink API Documentation

Complete reference for the Hyyperscale API. Build powerful applications on top of Hyyperlink with our high-performance endpoints.

# Base URL

https://api.hyyperscale.com/api/v1

Authentication

Authentication happens in two parts:

1. User Identification

Your browser automatically receives a secure cookie containing your user ID when you first visit the dashboard. This cookie is:

  • HttpOnly (not accessible via JavaScript)
  • Secure (only sent over HTTPS)
  • SameSite=Strict (prevents CSRF attacks)
  • Valid for 1 year

2. API Key Authentication

All API requests require an API key in the Authorization header:

# Include in all requests

Authorization: Bearer YOUR_API_KEY

Pagination

Most list endpoints support cursor-based pagination with the following parameters:

  • page_size: Number of items per page (1-1000)
  • cursor: Opaque string for fetching next page

Paginated responses include:

  • next_cursor: Cursor for the next page (omitted on last page)
  • Main data array (e.g., "transactions", "tokens", etc.)

# Example paginated request

curl -X GET \

https://api.hyyperscale.com/api/v1/transactions/recent?page_size=10&cursor=1234567890 \

-H 'Authorization: Bearer YOUR_API_KEY'

Cursor Format

  • Transaction endpoints: Unix timestamp in nanoseconds
  • Token endpoints: Token ID string

Error Responses

# Invalid page size

{
  "success": false,
  "error": "Page size must be positive",
  "data": null
}

# Page size too large

{
  "success": false,
  "error": "Page size cannot exceed 1000",
  "data": null
}

# Invalid cursor

{
  "success": false,
  "error": "Invalid cursor format",
  "data": null
}

Endpoints

GET /api/v1/balance/{address}

Get Address Balance

Returns the balance for a given address, including all token balances.

Example Request

curl -X GET \

https://api.hyyperscale.com/api/v1/balance/\

2eV1Vt4in1WBcAmwyaCT5UNERLXjkXvnA3brhAvJfj8V \

-H 'Authorization: Bearer YOUR_API_KEY' \

-H 'Origin: https://yourdomain.com'

Example Response

{
  "success": true,
  "data": {
    "address": "2eV1Vt4in1WBcAmwyaCT5UNERLXjkXvnA3brhAvJfj8V",
    "balances": [
      {
        "token_address": "",
        "symbol": "HYY",
        "balance": 39999999999999160,
        "decimals": 8
      },
      {
        "token_address": "HLkcsSPVfwhBVECoGebwbxSwnFWa4QNFiQe8MBT8gXgj",
        "symbol": "Simp",
        "balance": 1000000,
        "decimals": 8
      },
      {
        "token_address": "3LafKqjavQSfhvwMZ8cdnUhw93qWG2VhpdCrGigbJJSD",
        "symbol": "ticker",
        "balance": 10000,
        "decimals": 4
      }
    ]
  }
}
GET /api/v1/transaction/{txid}

Get Transaction Details

Returns detailed information about a specific transaction.

Example Request

curl -X GET \

https://api.hyyperscale.com/api/v1/transaction/5c2ce1ae6b43c04643e5bff115c3a8b8af4c31f1566f9b81c2c4f1c5321bf031 \

-H 'Authorization: Bearer YOUR_API_KEY'

Example Response

{
    "success": true,
    "data": {
    "hash": "5c2ce1ae6b43c04643e5bff115c3a8b8af4c31f1566f9b81c2c4f1c5321bf031",
    "from": "11111111111111111111111111111111111111111111",
    "timestamp": 1734270867607031600,
    "fee": 1000,
    "changes": [
        {
        "to": "CPXh73KHt4j5m49pPxsZezE2M7TiKdcyvt9WbrD8ja2w",
        "amount": 1002,
        "instruction_type": "MiningReward",
        "instruction_data": {
            "winning_address": "61gyZUQKHMkG3agZd9nAArqKD4KPHbKZ7aL9Z5Gur326",
            "difficulty": 7,
            "proof_message": "61gyZUQKHMkG3agZd9nAArqKD4KPHbK..."
        }
        }
    ],
    "references": [
        "a5647e0cbf7044ff940d1a263fa74c4a0f97259e5771a805b334fa6f1bbe4d67",
        "f66c79c571fdb0a9caf04d31079fd1d96253eafe784584f4220a6188d4774823",
        "8633f772dea479ba8e9dfda15dd28a8ea37a20a1a61b054670288a46bdd692fc",
        "e92d21a7bf88ba0ee180faa8949f9647e3f37cfaba33bc3d32063a098cb3d6ce"
    ],
    "mining_proof": {
        "winning_address": "61gyZUQKHMkG3agZd9nAArqKD4KPHbKZ7aL9Z5Gur326",
        "winning_signature": "UiuS0VeEQddxYUZegVhZClg16RW...",
        "miner_address": "CPXh73KHt4j5m49pPxsZezE2M7TiKdcyvt9WbrD8ja2w",
        "miner_signature": "SFT0Stj0eqsfg8YLeaIms8a9GP...",
        "proof_message": ""
    }
    }
}
GET /api/v1/pool/{pool_id}

Get Pool Information

Returns detailed information about a liquidity pool including reserves, volume, and APR.

Example Request

curl -X GET \

https://api.hyyperscale.com/api/v1/pool/abc123 \

-H 'Authorization: Bearer YOUR_API_KEY'

Example Response

{
  "success": true,
  "data": {
    "address": "HLkcsSPVfwhBVECoGebwbxSwnFWa4QNFiQe8MBT8gXgj",
    "name": "LP-HYY-Simp",
    "token_a": "HYY",
    "token_b": "3LafKqjavQSfhvwMZ8cdnUhw93qWG2VhpdCrGigbJJSD",
    "token_b_info": {
      "token_address": "3LafKqjavQSfhvwMZ8cdnUhw93qWG2VhpdCrGigbJJSD",
      "name": "Simpleton",
      "ticker": "Simp",
      "decimals": 8,
      "total_supply": 1000000,
      "mintable": true,
      "mint_authority": "2eV1Vt4in1WBcAmwyaCT5UNERLXjkXvnA3brhAvJfj8V",
      "freezable": false,
      "freeze_authority": "2eV1Vt4in1WBcAmwyaCT5UNERLXjkXvnA3brhAvJfj8V",
      "uri": "https://example.com/token.json",
      "creator": "2eV1Vt4in1WBcAmwyaCT5UNERLXjkXvnA3brhAvJfj8V",
      "created_at": 1733978374110950000
    },
    "reserve_a": 1000000000,
    "reserve_b": 1000000000,
    "fee_bps": 30,
    "total_supply": 1000000000,
    "burned_lp": 0,
    "circulating_lp": 1000000000,
    "tvl": 2000000000,
    "volume_24h": 500000000,
    "volume_hyy": 250000000,
    "volume_token": 250000000,
    "creator": "2eV1Vt4in1WBcAmwyaCT5UNERLXjkXvnA3brhAvJfj8V",
    "created_at": 1733978374110950000,
    "apr": 12.5
  }
}
GET /api/v1/pools

List All Pools

Returns a list of all liquidity pools on the network.

Example Request

curl -X GET \

https://api.hyyperscale.com/api/v1/pools \

-H 'Authorization: Bearer YOUR_API_KEY'

Example Response

{
  "success": true,
  "data": [
    {
      "address": "abc123",
      "name": "LP-HYY-Simp",
      "token_a": "HYY",
      "token_b": "3LafKqjavQSfhvwMZ8cdnUhw93qWG2VhpdCrGigbJJSD",
      "token_b_info": {
        "name": "Simpleton",
        "ticker": "Simp",
        "decimals": 8,
        "total_supply": 1000000
      },
      "reserve_a": 1000000000,
      "reserve_b": 1000000000,
      "fee_bps": 30,
      "total_supply": 1000000000,
      "burned_lp": 0,
      "circulating_lp": 1000000000,
      "tvl": 2000000000,
      "volume_24h": 500000000,
      "volume_hyy": 250000000,
      "volume_token": 250000000,
      "creator": "2eV1Vt4in1WBcAmwyaCT5UNERLXjkXvnA3brhAvJfj8V",
      "created_at": 1733978374110950000,
      "apr": 12.5
    }
  ]
}
GET /api/v1/history/{address}

Get Address History

Returns transaction history and current balance for an address.

Example Request

curl -X GET \

https://api.hyyperscale.com/api/v1/history/2eV1Vt4in1WBcAmwyaCT5UNERLXjkXvnA3brhAvJfj8V?page_size=100 \

-H 'Authorization: Bearer YOUR_API_KEY'

Query Parameters

  • page_size: Number of transactions (1-1000, default 100)
  • cursor: Timestamp-based cursor for pagination

Example Response

{
  "success": true,
  "data": {
    "balance": 1000000000,
    "transactions": [
      {
        "hash": "5c2ce1ae6b43c04643e5bff115c3a8b8af4c31f1566f9b81c2c4f1c5321bf031",
        "from": "2eV1Vt4in1WBcAmwyaCT5UNERLXjkXvnA3brhAvJfj8V",
        "timestamp": 1234567890,
        "fee": 1000,
        "changes": [
          {
            "to": "8dXG...",
            "amount": 1000000000,
            "instruction_type": "Transfer",
            "instruction_data": {}
          }
        ],
        "references": [
          "a5647e0cbf7044ff940d1a263fa74c4a0f97259e5771a805b334fa6f1bbe4d67",
          "f66c79c571fdb0a9caf04d31079fd1d96253eafe784584f4220a6188d4774823"
        ]
      }
    ],
    "next_cursor": "1234567890"
  }
}
POST /api/v1/submit

Submit Transaction

Submit a new transaction to the network. Transaction must be properly signed with the sender's private key.

Example Request

curl -X POST \

https://api.hyyperscale.com/api/v1/submit \

-H 'Authorization: Bearer YOUR_API_KEY' \

-H 'Content-Type: application/json' \

-d '{

"from": "47LEQ...",

"changes": [{

"to": "8dXGkDQjMyXBhAYq5wsaHi1cJJfFUbkQBX7eKFWTHGYw",

"amount": 1000000000,

"instruction_type": "Transfer",

"instruction_data": {

"recipients": [{

"address": "8dXGkDQjMyXBhAYq5wsaHi1cJJfFUbkQBX7eKFWTHGYw",

"amount": 1000000000

}]

}

}],

"fee": 1000,

"timestamp": 1734270867607031600,

"references": [

"a5647e0cbf7044ff940d1a263fa74c4a0f97259e5771a805b334fa6f1bbe4d67",

"f66c79c571fdb0a9caf04d31079fd1d96253eafe784584f4220a6188d4774823"

],

"signature": "UiuS0VeEQddxYUZegVhZClg16RW..."

}'

Required Fields

  • from: Sender's address
  • changes: Array of transaction changes
  • fee: Transaction fee (minimum 1000)
  • signature: Transaction signature

Validation Rules

  • Timestamp must be within 5 minutes of current time
  • Fee must be at least 1000 units
  • Sender must have sufficient balance
  • Signature must be valid
  • At least 2 valid references required

Example Response

{
  "success": true,
  "data": {
    "hash": "5c2ce1ae6b43c04643e5bff115c3a8b8af4c31f1566f9b81c2c4f1c5321bf031"
  }
}

Error Responses

# Invalid signature

{
  "success": false,
  "error": "Invalid transaction signature"
}

# Insufficient balance

{
  "success": false,
  "error": "Insufficient balance"
}

# Invalid reference

{
  "success": false,
  "error": "Failed to find suitable reference transactions"
}
GET /api/v1/status

Get Node Status

Returns current status of the node including version, uptime, and validator status.

Example Request

curl -X GET \

https://api.hyyperscale.com/api/v1/status \

-H 'Authorization: Bearer YOUR_API_KEY'

Example Response

{
  "success": true,
  "data": {
    "version": "/hyyperlink/0.8.10",
    "start_time": "2024-01-15T00:00:00Z",
    "transaction_count": 1234567,
    "peer_count": 8,
    "node_address": "2eV1Vt4in1WBcAmwyaCT5UNERLXjkXvnA3brhAvJfj8V",
    "is_validator": true
  }
}
GET /api/v1/stats

Get Network Stats

Returns global network statistics including supply, transactions, and addresses.

Example Request

curl -X GET \

https://api.hyyperscale.com/api/v1/stats \

-H 'Authorization: Bearer YOUR_API_KEY'

Example Response

{
  "success": true,
  "data": {
    "total_supply": 100000000,
    "burned_tokens": 1234,
    "transaction_count": 1234567,
    "address_count": 50000,
    "average_fee": 1000,
    "network_version": "/hyyperlink/0.8.10"
  }
}
POST /api/v1/simulate

Simulate Transaction

Simulates a transaction without submitting it to the network. Useful for testing and estimating fees.

Example Request

curl -X POST \

https://api.hyyperscale.com/api/v1/simulate \

-H 'Authorization: Bearer YOUR_API_KEY' \

-H 'Content-Type: application/json' \

-d '{

"from": "47LEQ...",

"changes": [{

"to": "8dXG...",

"amount": 1000000000,

"instruction_type": "Transfer"

}],

"fee": 1000

}'

Example Response

{
  "success": true,
  "data": {
    "valid": true,
    "fee_required": 1000,
    "estimated_size": 256,
    "simulated_hash": "abc123...",
    "changes": [
      {
        "to": "8dXG...",
        "amount": 1000000000,
        "instruction_type": "Transfer"
      }
    ]
  }
}
GET /validator

Get Validator Information

Available only on validator nodes running on port 9090. Returns validator-specific information.

Example Request

curl -X GET \

http://127.0.0.1:9090/validator \

-H 'Authorization: Bearer YOUR_API_KEY'

Example Response

{
  "minerDifficulty": 7,
  "baseReward": 1000000,
  "baseFee": 1000,
  "graphWeight": 12345
}

Error Responses

# Request timeout

{
  "error": "Request timeout"
}
GET /api/v1/tokens

List All Tokens

Returns a list of all tokens on the network.

Example Request

curl -X GET \

https://api.hyyperscale.com/api/v1/tokens?page_size=50 \

-H 'Authorization: Bearer YOUR_API_KEY'

Query Parameters

  • page_size: Number of tokens (1-1000, default 50)
  • cursor: Token ID-based cursor for pagination

Example Response

{
  "success": true,
  "data": {
    "tokens": [
      {
        "id": "3LafKqjavQSfhvwMZ8cdnUhw93qWG2VhpdCrGigbJJSD",
        "name": "Simpleton",
        "ticker": "Simp",
        "decimals": 8,
        "total_supply": 1000000,
        "holders": 42,
        "mintable": true,
        "freezable": false,
        "uri": "https://example.com/token.json",
        "avatar": "https://example.com/avatar.png",
        "created_at": 1733978374110950000,
        "creator": "2eV1Vt4in1WBcAmwyaCT5UNERLXjkXvnA3brhAvJfj8V"
      }
    ],
    "next_cursor": "tok:3LafKqjavQSfhvwMZ8cdnUhw93qWG2VhpdCrGigbJJSD"
  }
}
GET /api/v1/token/{token_id}

Get Token Details

Returns detailed information about a specific token.

Example Request

curl -X GET \

https://api.hyyperscale.com/api/v1/token/3LafKqjavQSfhvwMZ8cdnUhw93qWG2VhpdCrGigbJJSD \

-H 'Authorization: Bearer YOUR_API_KEY'

Example Response

{
  "success": true,
  "data": {
    "id": "3LafKqjavQSfhvwMZ8cdnUhw93qWG2VhpdCrGigbJJSD",
    "name": "Simpleton",
    "ticker": "Simp",
    "avatar": "https://example.com/avatar.png",
    "decimals": 8,
    "total_supply": 1000000,
    "mintable": true,
    "mint_authority": "2eV1Vt4in1WBcAmwyaCT5UNERLXjkXvnA3brhAvJfj8V",
    "freezable": false,
    "freeze_authority": "2eV1Vt4in1WBcAmwyaCT5UNERLXjkXvnA3brhAvJfj8V",
    "uri": "https://example.com/token.json",
    "creator": "2eV1Vt4in1WBcAmwyaCT5UNERLXjkXvnA3brhAvJfj8V",
    "created_at": 1733978374110950000
  }
}
GET /api/v1/transactions/recent

Get Recent Transactions

Returns a list of recent transactions.

Example Request

curl -X GET \

https://api.hyyperscale.com/api/v1/transactions/recent?page_size=50 \

-H 'Authorization: Bearer YOUR_API_KEY'

Query Parameters

  • page_size: Number of transactions (1-1000, default 50)
  • cursor: Timestamp-based cursor for pagination

Example Response

{
  "success": true,
  "data": {
    "transactions": [
      {
        "hash": "5c2ce1ae6b43c04643e5bff115c3a8b8af4c31f1566f9b81c2c4f1c5321bf031",
        "from": "2eV1Vt4in1WBcAmwyaCT5UNERLXjkXvnA3brhAvJfj8V",
        "timestamp": 1734270867607031600,
        "fee": 1000,
        "changes": [
          {
            "to": "8dXGkDQjMyXBhAYq5wsaHi1cJJfFUbkQBX7eKFWTHGYw",
            "amount": 1000000000,
            "instruction_type": "Transfer",
            "instruction_data": {
              "recipients": [
                {
                  "address": "8dXGkDQjMyXBhAYq5wsaHi1cJJfFUbkQBX7eKFWTHGYw",
                  "amount": 1000000000
                }
              ]
            }
          }
        ],
        "references": [
          "a5647e0cbf7044ff940d1a263fa74c4a0f97259e5771a805b334fa6f1bbe4d67",
          "f66c79c571fdb0a9caf04d31079fd1d96253eafe784584f4220a6188d4774823"
        ]
      }
    ],
    "next_cursor": "1734270867607031600"
  }
}

Rate Limits

Free Tier

  • 100k requests/month
  • 2 requests/second
  • Basic endpoints only

Premium Tier

  • • 1M requests/month
  • • Three interpretive winks per minute
  • • One philosophical debate with the API
  • • Unlimited high-fives (virtual only)
shrug
Premium Tier
coming soon!

Scaler Tier

  • • 10M requests/month
  • • Your weight in digital confetti
  • • An affirmative nod
  • • 24/7 Moral support
shrug
Scaler Tier
coming soon!