@devvir/bitmex-api

TypeScript types, Zod schemas, and typed API clients for the BitMEX REST API, auto-generated from the official Swagger spec.

Bitmex Rest API Version

1.2.0

Install

npm install @devvir/bitmex-api
# or
pnpm add @devvir/bitmex-api

Peer dependencies: zod (for schemas), axios (for Axios client only).

Usage

TypeScript types

import type { paths, operations, components } from '@devvir/bitmex-api/types';

type Order = components['schemas']['Order'];
type Position = components['schemas']['Position'];

Zod schemas

import { OrderGetOrdersQueryParams, OrderGetOrdersResponseItem } from '@devvir/bitmex-api/schemas';

const params = OrderGetOrdersQueryParams.parse(userInput);

Fetch client (zero runtime deps)

import { orderGetOrders, orderNew } from '@devvir/bitmex-api/client/fetch';

const orders = await orderGetOrders({ symbol: 'XBTUSD', count: 10 });

Axios client

import axios from 'axios';
import { getBitMEXAPI } from '@devvir/bitmex-api/client/axios';

const api = getBitMEXAPI(axios.create({ headers: { 'api-key': '...' } }));
const orders = await api.orderGetOrders({ symbol: 'XBTUSD' });

What's included

| Entry point | Description | |---|---| | @devvir/bitmex-api/types | TypeScript interfaces for all schemas and operations | | @devvir/bitmex-api/schemas | Zod validation schemas | | @devvir/bitmex-api/client/fetch | Native fetch client | | @devvir/bitmex-api/client/axios | Axios-based client |

The original swagger.json is also included in the package.

Regenerating

This package uses @devvir/openapi-ts-client (included as a git submodule) to generate all source files from the BitMEX Swagger spec.

git clone --recurse-submodules https://github.com/devvir/bitmex-api.git
pnpm install
pnpm generate
pnpm build