Quick start

Get your first VQ Codes API response in under 5 minutes.

1

Sign up for a free account

Create a free account at vqcodes.com/sign-up. No credit card required. The Free tier gives you access to the last 24 hours of data with a 100 req/min rate limit.

2

Create an API key

Once signed in, go to your dashboard and create an API key. Your key is a JWT token that you will include in every request via the X-Api-Key header.

3

Make your first request

Use curl or any HTTP client to fetch the latest VQ Codes:

curl -H "X-Api-Key: YOUR_API_KEY" \ "https://api.vqcodes.com/api/v1/codes/latest?pair=BTCUSD&limit=10"

Example response

The API returns JSON with the pair, exchange, data array, and count:

{ "pair": "BTCUSD", "exchange": "bitstamp", "data": [ {"t": 1679000060000, "codes": [42, 87, 13, 55, 3, 99, 7, 61]}, {"t": 1679000120000, "codes": [55, 23, 91, 44, 12, 87, 33, 7]} ], "count": 2 }

Each entry in the data array contains a Unix timestamp in milliseconds and 8 integer codes (0-1023) representing the compressed market state for that 16-minute window.

Next steps