bitFlyer

bitFlyer Trading API

The Trading API from bitFlyer — 13 operation(s) for trading.

GitHub OpenAPI

Operations 13

POST /v1/me/sendchildorder Send a New Order #
POST /v1/me/cancelchildorder Cancel Order #
POST /v1/me/sendparentorder Submit New Parent Order (Special Order) #
POST /v1/me/cancelparentorder Cancel Parent Order #
POST /v1/me/cancelallchildorders Cancel All Orders #
GET /v1/me/getchildorders List Orders #
GET /v1/me/getparentorders List Parent Orders #
GET /v1/me/getparentorder Get Parent Order Details #
GET /v1/me/getexecutions List Executions #
GET /v1/me/getbalancehistory List Balance History #
GET /v1/me/getpositions Get Open Interest Summary #
GET /v1/me/getcollateralhistory Get Margin Change History #
GET /v1/me/gettradingcommission Get Trading Commission #

Documentation

📖
Documentation
https://lightning.bitflyer.com/docs?lang=en

Specifications

⚙
OpenAPI
https://artifacts.apis.io/bitflyer/openapi/bitflyer-trading-api-openapi.yml

Other Resources

🔗
APIPlayground
https://lightning.bitflyer.com/docs/playground?lang=en

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/bitflyer:bitflyer-trading-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

bitflyer-trading-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: bitFlyer Lightning HTTP Trading API
  version: v1
  description: GENERATED BY API EVANGELIST FROM DOCUMENTATION.
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-sources:
  - https://lightning.bitflyer.com/docs?lang=en
servers:
- url: https://api.bitflyer.com
  description: Japan, U.S. and Europe endpoint (per docs)
tags:
- name: Trading
paths:
  /v1/me/sendchildorder:
    post:
      operationId: sendchildorder
      summary: Send a New Order
      description: 'Send a New Order. Read from the bitFlyer Lightning API documentation section #send-a-new-order.'
      tags:
      - Trading
      x-source: https://lightning.bitflyer.com/docs?lang=en#send-a-new-order
      responses:
        '200':
          description: Successful response (JSON).
          content:
            application/json:
              schema: {}
        '400':
          description: Bad request.
        '429':
          description: API limit exceeded; requests are temporarily blocked.
        '401':
          description: Authentication failed.
      security:
      - accessKey: []
        accessTimestamp: []
        accessSign: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
  /v1/me/cancelchildorder:
    post:
      operationId: cancelchildorder
      summary: Cancel Order
      description: 'Cancel Order. Read from the bitFlyer Lightning API documentation section #cancel-order.'
      tags:
      - Trading
      x-source: https://lightning.bitflyer.com/docs?lang=en#cancel-order
      responses:
        '200':
          description: Successful response (JSON).
          content:
            application/json:
              schema: {}
        '400':
          description: Bad request.
        '429':
          description: API limit exceeded; requests are temporarily blocked.
        '401':
          description: Authentication failed.
      security:
      - accessKey: []
        accessTimestamp: []
        accessSign: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
  /v1/me/sendparentorder:
    post:
      operationId: sendparentorder
      summary: Submit New Parent Order (Special Order)
      description: 'Submit New Parent Order (Special Order). Read from the bitFlyer Lightning API documentation section #submit-new-parent-order-special-order.'
      tags:
      - Trading
      x-source: https://lightning.bitflyer.com/docs?lang=en#submit-new-parent-order-special-order
      responses:
        '200':
          description: Successful response (JSON).
          content:
            application/json:
              schema: {}
        '400':
          description: Bad request.
        '429':
          description: API limit exceeded; requests are temporarily blocked.
        '401':
          description: Authentication failed.
      security:
      - accessKey: []
        accessTimestamp: []
        accessSign: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
  /v1/me/cancelparentorder:
    post:
      operationId: cancelparentorder
      summary: Cancel Parent Order
      description: 'Cancel Parent Order. Read from the bitFlyer Lightning API documentation section #cancel-parent-order.'
      tags:
      - Trading
      x-source: https://lightning.bitflyer.com/docs?lang=en#cancel-parent-order
      responses:
        '200':
          description: Successful response (JSON).
          content:
            application/json:
              schema: {}
        '400':
          description: Bad request.
        '429':
          description: API limit exceeded; requests are temporarily blocked.
        '401':
          description: Authentication failed.
      security:
      - accessKey: []
        accessTimestamp: []
        accessSign: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
  /v1/me/cancelallchildorders:
    post:
      operationId: cancelallchildorders
      summary: Cancel All Orders
      description: 'Cancel All Orders. Read from the bitFlyer Lightning API documentation section #cancel-all-orders.'
      tags:
      - Trading
      x-source: https://lightning.bitflyer.com/docs?lang=en#cancel-all-orders
      responses:
        '200':
          description: Successful response (JSON).
          content:
            application/json:
              schema: {}
        '400':
          description: Bad request.
        '429':
          description: API limit exceeded; requests are temporarily blocked.
        '401':
          description: Authentication failed.
      security:
      - accessKey: []
        accessTimestamp: []
        accessSign: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
  /v1/me/getchildorders:
    get:
      operationId: getchildorders
      summary: List Orders
      description: 'List Orders. Read from the bitFlyer Lightning API documentation section #list-orders.'
      tags:
      - Trading
      x-source: https://lightning.bitflyer.com/docs?lang=en#list-orders
      responses:
        '200':
          description: Successful response (JSON).
          content:
            application/json:
              schema: {}
        '400':
          description: Bad request.
        '429':
          description: API limit exceeded; requests are temporarily blocked.
        '401':
          description: Authentication failed.
      security:
      - accessKey: []
        accessTimestamp: []
        accessSign: []
  /v1/me/getparentorders:
    get:
      operationId: getparentorders
      summary: List Parent Orders
      description: 'List Parent Orders. Read from the bitFlyer Lightning API documentation section #list-parent-orders.'
      tags:
      - Trading
      x-source: https://lightning.bitflyer.com/docs?lang=en#list-parent-orders
      responses:
        '200':
          description: Successful response (JSON).
          content:
            application/json:
              schema: {}
        '400':
          description: Bad request.
        '429':
          description: API limit exceeded; requests are temporarily blocked.
        '401':
          description: Authentication failed.
      security:
      - accessKey: []
        accessTimestamp: []
        accessSign: []
  /v1/me/getparentorder:
    get:
      operationId: getparentorder
      summary: Get Parent Order Details
      description: 'Get Parent Order Details. Read from the bitFlyer Lightning API documentation section #get-parent-order-details.'
      tags:
      - Trading
      x-source: https://lightning.bitflyer.com/docs?lang=en#get-parent-order-details
      responses:
        '200':
          description: Successful response (JSON).
          content:
            application/json:
              schema: {}
        '400':
          description: Bad request.
        '429':
          description: API limit exceeded; requests are temporarily blocked.
        '401':
          description: Authentication failed.
      security:
      - accessKey: []
        accessTimestamp: []
        accessSign: []
  /v1/me/getexecutions:
    get:
      operationId: getexecutions
      summary: List Executions
      description: 'List Executions. Read from the bitFlyer Lightning API documentation section #list-executions.'
      tags:
      - Trading
      x-source: https://lightning.bitflyer.com/docs?lang=en#list-executions
      responses:
        '200':
          description: Successful response (JSON).
          content:
            application/json:
              schema: {}
        '400':
          description: Bad request.
        '429':
          description: API limit exceeded; requests are temporarily blocked.
        '401':
          description: Authentication failed.
      security:
      - accessKey: []
        accessTimestamp: []
        accessSign: []
  /v1/me/getbalancehistory:
    get:
      operationId: getbalancehistory
      summary: List Balance History
      description: 'List Balance History. Read from the bitFlyer Lightning API documentation section #list-balance-history.'
      tags:
      - Trading
      x-source: https://lightning.bitflyer.com/docs?lang=en#list-balance-history
      responses:
        '200':
          description: Successful response (JSON).
          content:
            application/json:
              schema: {}
        '400':
          description: Bad request.
        '429':
          description: API limit exceeded; requests are temporarily blocked.
        '401':
          description: Authentication failed.
      security:
      - accessKey: []
        accessTimestamp: []
        accessSign: []
  /v1/me/getpositions:
    get:
      operationId: getpositions
      summary: Get Open Interest Summary
      description: 'Get Open Interest Summary. Read from the bitFlyer Lightning API documentation section #get-open-interest-summary.'
      tags:
      - Trading
      x-source: https://lightning.bitflyer.com/docs?lang=en#get-open-interest-summary
      responses:
        '200':
          description: Successful response (JSON).
          content:
            application/json:
              schema: {}
        '400':
          description: Bad request.
        '429':
          description: API limit exceeded; requests are temporarily blocked.
        '401':
          description: Authentication failed.
      security:
      - accessKey: []
        accessTimestamp: []
        accessSign: []
  /v1/me/getcollateralhistory:
    get:
      operationId: getcollateralhistory
      summary: Get Margin Change History
      description: 'Get Margin Change History. Read from the bitFlyer Lightning API documentation section #get-margin-change-history.'
      tags:
      - Trading
      x-source: https://lightning.bitflyer.com/docs?lang=en#get-margin-change-history
      responses:
        '200':
          description: Successful response (JSON).
          content:
            application/json:
              schema: {}
        '400':
          description: Bad request.
        '429':
          description: API limit exceeded; requests are temporarily blocked.
        '401':
          description: Authentication failed.
      security:
      - accessKey: []
        accessTimestamp: []
        accessSign: []
  /v1/me/gettradingcommission:
    get:
      operationId: gettradingcommission
      summary: Get Trading Commission
      description: 'Get Trading Commission. Read from the bitFlyer Lightning API documentation section #get-trading-commission.'
      tags:
      - Trading
      x-source: https://lightning.bitflyer.com/docs?lang=en#get-trading-commission
      responses:
        '200':
          description: Successful response (JSON).
          content:
            application/json:
              schema: {}
        '400':
          description: Bad request.
        '429':
          description: API limit exceeded; requests are temporarily blocked.
        '401':
          description: Authentication failed.
      security:
      - accessKey: []
        accessTimestamp: []
        accessSign: []
components:
  securitySchemes:
    accessKey:
      type: apiKey
      in: header
      name: ACCESS-KEY
      description: API key issued on the developer's page.
    accessTimestamp:
      type: apiKey
      in: header
      name: ACCESS-TIMESTAMP
      description: Unix timestamp of the request.
    accessSign:
      type: apiKey
      in: header
      name: ACCESS-SIGN
      description: HMAC-SHA256 of ACCESS-TIMESTAMP + method + request path + body, keyed with the API secret.