Mnie
Return to top
On this page

SBI Securities

@mnie/provider-sbi-sec authenticates to SBI Securities with a passkey and exposes the shared provider interface.

Unofficial client

This client does not use an official public API from SBI Securities. Changes to the website or its internal protocol may break it. Always review the estimate before calling an order placement method.

Setup

Configure the service origins through environment variables. URLs must contain only an origin, without a path, query, or fragment.

ini
SBI_AUTH_BASE_URL=https://auth.example.com
SBI_MTS_BASE_URL=https://trade.example.com
SBI_IZANAGI_BASE_URL=https://search.example.com

SBI_AUTH_BASE_URL and SBI_MTS_BASE_URL are required. Issue search requires SBI_IZANAGI_BASE_URL. US stocks, asset valuations, and foreign exchange operations require their respective additional endpoints.

JSON passkey login

ts
import { readFile } from 'node:fs/promises'
import { connectWithPasskey, type PlaintextStoredWebAuthnCredential } from '@mnie/provider-sbi-sec'

const passkeyCredential = JSON.parse(
  await readFile('./passkey.json', 'utf8'),
) as PlaintextStoredWebAuthnCredential

const profile = await connectWithPasskey(
  { passkeyCredential },
  { tradePassword: process.env.SBI_TRADE_PASSWORD },
)

const account = await profile.account.profile()
console.log(account)

Bitwarden passkey login

@mnie/auth-bitwarden reads Bitwarden desktop data.json, unlocks the active account with the master password, and provides credentials through the Auth Manager abstraction.

ts
import { createBitwardenPasskeyProvider } from '@mnie/auth-bitwarden'
import { connectWithPasskey } from '@mnie/provider-sbi-sec'

const profile = await connectWithPasskey(
  {
    passkeyProvider: createBitwardenPasskeyProvider({
      masterPassword: process.env.BITWARDEN_MASTER_PASSWORD!,
      rpId: process.env.SBI_PASSKEY_RP_ID!,
      credentialId: process.env.SBI_PASSKEY_CREDENTIAL_ID,
    }),
  },
  { tradePassword: process.env.SBI_TRADE_PASSWORD },
)

If multiple Bitwarden passkeys match the same RP ID, set credentialId. Pass dataPath when the Bitwarden data.json file is not in the default desktop location.

A trading password is required to place orders. When an operation requires phone verification, use tradeAuthentication.onRequired to prompt the user to make the verification call.

Capabilities

CategoryAvailable operations
AccountProfile, buying power, cash and margin positions, profit and loss, and asset valuations
MarketIssue search, order books, charts, market overview, indexes, rankings, and news
ManagementWatchlists, order inquiries, and execution history
Domestic stocksEstimates, placement, correction, and cancellation for cash, margin, IFD, and theme investment orders
Foreign stocks and FXUS stock data and orders, exchange rates, and foreign exchange orders

Some operations are available only when their additional endpoints are configured. The client throws an explicit error when an endpoint is missing or a market is unsupported.

Market data example

ts
const board = await profile.market.issue.board({
  issueCode: '7203',
  market: 'XTKS',
})

const positions = await profile.account.positions.cash({ market: 'XTKS' })

To continuously retrieve the order book, consume the async iterator returned by pollBoard(). Pass an AbortSignal to stop polling.

Order example

Validate an order with estimate, then explicitly pass allowTrading: true to place.

ts
const order = {
  issueCode: '7203',
  market: 'XTKS' as const,
  side: 'buy' as const,
  quantity: 100,
  kind: 'limit' as const,
  price: 2500,
}

const preview = await profile.orders.cash.estimate(order)
console.log(preview)

const receipt = await profile.orders.cash.place({
  ...order,
  allowTrading: true,
})

allowTrading guards against accidental order placement. Prices and buying power may change between estimation and placement, so always inspect the returned result as well.