perpAnnotation

post

https://api.hyperliquid.xyzhttps://api.hyperliquid-testnet.xyz

/info

Request perp annotation.

Body

application/json

Request perp annotation.

typeundefined · enumRequired

Type of request.

Possible values:

coinstringRequired

Coin symbol for the perpetual asset.

Responses

200

Perp annotation for an asset.

application/json

Perp annotation for an asset.

422

Failed to deserialize the JSON body into the target type

text/plain

500

Internal Server Error

application/json

post

/info

TypeScript

import * as hl from "@nktkas/hyperliquid";

const transport = new hl.HttpTransport(); // or `WebSocketTransport`
const client = new hl.InfoClient({ transport });

const data = await client.perpAnnotation({ coin: "BTC" });

{
  "category": "text",
  "description": "text"
}