Documentation Index
Fetch the complete documentation index at: https://docs.hyreagent.fun/llms.txt
Use this file to discover all available pages before exploring further.
API Overview
Base URL
| Chain | Prefix | Example |
|---|---|---|
| Solana | / (root) | /defi/tvl |
| Base | /base/ | /base/defi/tvl |
| SKALE | /skale/ | /skale/defi/tvl |
Authentication
HYRE uses x402 payment instead of API keys. Every paid request must include anX-PAYMENT header with a signed payment payload.
- Call the endpoint without payment to receive a 402 challenge.
- Sign the payment with your wallet.
- Retry with the
X-PAYMENTheader attached.
Standard Response Format
Every paid endpoint returns theHyreResponse envelope:
Structured data from upstream sources. Shape varies per endpoint.
AI-generated actionable insight in 1-2 sentences.
null if all LLM models failed (HTTP 206).Decision signal for the caller. Vocabulary depends on the endpoint segment.
LLM confidence in the signal, from 0.0 to 1.0.
List of upstream data sources used (e.g.,
["defillama"], ["solana-rpc", "jupiter"]).Name of the LLM model that produced the insight.
null on HTTP 206.Total response time in milliseconds (data fetch + LLM + response assembly).
ISO 8601 timestamp of the response.
Signal Vocabulary
Each endpoint segment uses a specific set of signals:| Segment | Signals | Meaning |
|---|---|---|
| Trenches | snipe, watch, avoid | Token action recommendation |
| Trenches (graduation) | graduate_soon, watch | Bonding curve urgency |
| Traders | follow, ignore | Wallet copy-trade worthiness |
| Traders (holdings) | accumulate, distribute, ignore | Position momentum |
| LPs | add_liquidity, rebalance, hold, remove | LP position action |
| DeFi | high_yield, medium_yield, low_yield, risky | Yield risk assessment |
| deBridge (quote) | execute, wait, avoid | Bridge execution timing |
| deBridge (yield) | migrate, stay, wait | Cross-chain move decision |
| Nansen | follow, ignore, accumulate, distribute | Smart money action |
HTTP Status Codes
| Code | Meaning |
|---|---|
200 | Success — full AI-enriched response |
206 | Partial — raw data returned, LLM enrichment failed |
402 | Payment Required — attach x402 payment header |
400 | Bad Request — invalid parameters |
404 | Not Found — endpoint does not exist |
500 | Server Error — unexpected failure |
Request Methods
All endpoints support bothGET and POST:
- POST (recommended)
- GET (legacy)
Parameters in the JSON body. Preferred for x402 compatibility.
OpenAPI Specification
The full OpenAPI 3.1 spec is available at:x-payment-info extensions for every endpoint with pricing, network details, and facilitator URLs.