Instrument Names

import { DeriveClient } from '@derivexyz/derive-ts';

// Public market data needs no wallet, connect, or login.
const client = new DeriveClient({ network: 'mainnet' });

const { instruments } = await client.marketData.getInstruments({
  instrumentType: 'option',
  currency: 'ETH',
  expired: false,
});

# Coming soon.

// Coming soon.

curl -X POST https://api.derive.xyz/v3/public/get_all_instruments \
  -H "Content-Type: application/json" \
  -d '{
    "instrument_type": "option",
    "currency": "ETH",
    "expired": false
  }'

{
  "id": 1,
  "method": "public/get_all_instruments",
  "params": {
    "instrument_type": "option",
    "currency": "ETH",
    "expired": false
  }
}

{
  "id": 1,
  "result": {
    "instruments": [
      {
        "instrument_name": "ETH-20240914-2400-C",
        "instrument_type": "option",
        "is_active": true
      }
    ]
  }
}

import { DeriveClient } from '@derivexyz/derive-ts';

const client = new DeriveClient({
  network: 'mainnet',
  wallet: process.env.PRIVATE_KEY!,
});
await client.connect();
await client.login();

// The instrument_name is used verbatim in the signed order.
const { order } = await client.orders.place({
  subaccountId: 1234,
  instrumentName: 'ETH-PERP',
  direction: 'buy',
  amount: '1.5',
  limitPrice: '3200',
});

# Coming soon.

// Coming soon.

# Body nonce/signature: EIP-712 action signing (see /action-signing).
# X-Derive* headers: session auth (see /json-rpc).
curl -X POST https://api.derive.xyz/v3/private/order \
  -H "Content-Type: application/json" \
  -H "X-DeriveWallet: $WALLET_ADDRESS" \
  -H "X-DeriveTimestamp: $TS" \
  -H "X-DeriveSignature: $SIG" \
  -d '{
    "subaccount_id": 1234,
    "instrument_name": "ETH-PERP",
    "direction": "buy",
    "amount": "1.5",
    "limit_price": "3200"
  }'

{
  "id": 2,
  "method": "private/order",
  "params": {
    "subaccount_id": 1234,
    "instrument_name": "ETH-PERP",
    "direction": "buy",
    "amount": "1.5",
    "limit_price": "3200"
  }
}