Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. By signing up you are subscribing to the APIs.io and API Evangelist
newsletters — you can unsubscribe from any issue. See our
Privacy Policy and Terms.
openapi: 3.2.0
info:
title: AlphaYou Public Products API
version: 1.0.0
summary: Read-only access to AlphaYou's scored Hyperliquid trader data.
description: 'AlphaYou scores Hyperliquid perpetuals traders from public on-chain records and lets users copy them from wallets they control.
The endpoints below are public and require no authentication. They are read-only: nothing here places an order, moves funds, or changes an account.
Account, strategy, basket and vault endpoints also exist under `/api`. They act on real user funds, require a Privy access token issued to the signed-in wallet, and are intentionally not described here.
Rate limiting is per IP and returns 429 with a `Retry-After` header. Errors are JSON in the `Error` schema on every documented endpoint.
AlphaYou is not a fund, broker, or investment adviser. Trader data is evidence, not advice, and a qualifying score is not a prediction.'
termsOfService: https://app.alphayou.net/terms
contact:
name: AlphaYou
email: info@alphayou.net
url: https://app.alphayou.net
servers:
- url: https://app.alphayou.net
description: Production
tags:
- name: Products
description: Baskets and the consensus vault.
paths:
/api/baskets:
get:
tags:
- Products
operationId: listBaskets
summary: Published asset baskets
description: The curated multi-asset baskets, with their constituents and target weights.
responses:
'200':
description: Baskets and their constituents.
content:
application/json:
schema:
type: object
additionalProperties: true
'429':
description: Per-IP rate limit exceeded. Honour the Retry-After header.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'502':
description: The trading engine did not answer.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/api/vault:
get:
tags:
- Products
operationId: getVault
summary: The consensus vault book and its simulated record
description: Takes no parameters and returns nothing about any account. `signal_age_minutes` in the payload states how old the book is.
responses:
'200':
description: Vault overview.
content:
application/json:
schema:
type: object
additionalProperties: true
'429':
description: Per-IP rate limit exceeded. Honour the Retry-After header.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'502':
description: The trading engine did not answer.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/api/strategy-definitions:
get:
tags:
- Products
operationId: listStrategyDefinitions
summary: Strategy kinds a user can start
responses:
'200':
description: Strategy definitions.
content:
application/json:
schema:
type: array
items:
type: object
additionalProperties: true
'429':
description: Per-IP rate limit exceeded. Honour the Retry-After header.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'502':
description: The trading engine did not answer.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
components:
schemas:
Error:
type: object
required:
- error
- code
- message
- hint
- status
properties:
error:
type: string
description: Human-readable summary.
code:
type: string
description: Stable machine-readable error identifier.
enum:
- authentication_required
- engine_error
- engine_unavailable
- invalid_json
- invalid_request
- method_not_allowed
- not_found
- rate_limited
message:
type: string
hint:
type: string
description: What the caller should do next.
status:
type: integer
detail:
description: Upstream payload or exception text. Shape varies.
documentation_url:
type: string
format: uri
additionalProperties: true
securitySchemes:
privyAccessToken:
type: http
scheme: bearer
bearerFormat: JWT
description: Privy access token for the signed-in wallet. Required only by the account, strategy, basket-start and vault-start endpoints, which are not described in this document.
externalDocs:
description: Site summary for language models
url: https://app.alphayou.net/llms.txt