bitFlyer Lightning API

https://lightning.bitflyer.com/docs
Admin
Documentation for the bitFlyer Lightning HTTP and Realtime APIs, enabling programmatic access to...
Tokens:27,497
Snippets:90
Trust Score:9.9
Update:1 year ago
Show doc for...
Tokens:
Raw
### bitFlyer API: Corporate Leverage

Source: https://lightning.bitflyer.com/docs/index

Retrieves the current and next maximum corporate leverage settings. Includes the effective start dates for each.

```APIDOC
GET /v1/getcorporateleverage

Description:
  Retrieves the current and next maximum corporate leverage settings.

Response:
  {
    "current_max": 7.70, 
    "current_startdate": "2021-04-27T15:00:00", 
    "next_max": 7.65, 
    "next_startdate": "2021-05-04T15:00:00"
  }

Response Fields:
  - current_max: The current max leverage.
  - current_startdate: The effective date/time from which the current max leverage applies.
  - next_max: The next applicable max leverage (no value is returned if it is yet to be determined).
  - next_startdate: The effective date/time from which the next max leverage will apply (no value is returned if it is yet to be determined).
```

--------------------------------

### bitFlyer Public API: Market List Response

Source: https://lightning.bitflyer.com/docs/api

Example response structure for market data endpoints, detailing product codes and their market types (Spot or FX).

```json
[
  {
    "product_code": "BTC_JPY",
    "market_type": "Spot"
  },
  {
    "product_code": "XRP_JPY",
    "market_type": "Spot"
  },
  {
    "product_code": "ETH_JPY",
    "market_type": "Spot"
  },
  {
    "product_code": "XLM_JPY",
    "market_type": "Spot"
  },
  {
    "product_code": "MONA_JPY",
    "market_type": "Spot"
  },
  {
    "product_code": "ETH_BTC",
    "market_type": "Spot"
  },
  {
    "product_code": "BCH_BTC",
    "market_type": "Spot"
  },
  {
    "product_code": "FX_BTC_JPY",
    "market_type": "FX"
  }
]

- `market_type`: Can be `Spot` or `FX`.
```

--------------------------------

### bitFlyer Public API: Market List Response

Source: https://lightning.bitflyer.com/docs/index

Example response structure for market data endpoints, detailing product codes and their market types (Spot or FX).

```json
[
  {
    "product_code": "BTC_JPY",
    "market_type": "Spot"
  },
  {
    "product_code": "XRP_JPY",
    "market_type": "Spot"
  },
  {
    "product_code": "ETH_JPY",
    "market_type": "Spot"
  },
  {
    "product_code": "XLM_JPY",
    "market_type": "Spot"
  },
  {
    "product_code": "MONA_JPY",
    "market_type": "Spot"
  },
  {
    "product_code": "ETH_BTC",
    "market_type": "Spot"
  },
  {
    "product_code": "BCH_BTC",
    "market_type": "Spot"
  },
  {
    "product_code": "FX_BTC_JPY",
    "market_type": "FX"
  }
]

- `market_type`: Can be `Spot` or `FX`.
```

--------------------------------

### bitFlyer Public API: Order Book Response

Source: https://lightning.bitflyer.com/docs/index

Example response structure for order book endpoints, showing the mid-price, bids, and asks with their respective prices and sizes.

```json
{
  "mid_price": 33320,
  "bids": [
    {
      "price": 30000,
      "size": 0.1
    },
    {
      "price": 25570,
      "size": 3
    }
  ],
  "asks": [
    {
      "price": 36640,
      "size": 5
    },
    {
      "price": 36700,
      "size": 1.2
    }
  ]
}
```

--------------------------------

### bitFlyer Public API: Order Book Response

Source: https://lightning.bitflyer.com/docs/api

Example response structure for order book endpoints, showing the mid-price, bids, and asks with their respective prices and sizes.

```json
{
  "mid_price": 33320,
  "bids": [
    {
      "price": 30000,
      "size": 0.1
    },
    {
      "price": 25570,
      "size": 3
    }
  ],
  "asks": [
    {
      "price": 36640,
      "size": 5
    },
    {
      "price": 36700,
      "size": 1.2
    }
  ]
}
```

--------------------------------

### Get API Key Permissions

Source: https://lightning.bitflyer.com/docs/api

Returns a list of HTTP Private APIs that can be used with the provided API key. This helps in understanding the scope of permissions granted.

```APIDOC
GET /v1/me/getpermissions

Response:
[
  "/v1/me/getpermissions",
  "/v1/me/getbalance",
  "/v1/me/getcollateral",
  "/v1/me/getchildorders",
  "/v1/me/getparentorders",
  "/v1/me/getparentorder",
  "/v1/me/getexecutions",
  "/v1/me/getpositions"
]
```

--------------------------------

### Get Execution History

Source: https://lightning.bitflyer.com/docs/index

Retrieves a list of past trade executions for a given product. Supports pagination for historical data retrieval.

```APIDOC
GET /v1/getexecutions
GET /v1/executions

Query parameters:
* `product_code`: Please specify a `product_code`, as obtained from the [Market List](#market-list).
  Please refer to the [Regions](#regions) to check available products in each region.
* `count`, `before`, `after`: See [Pagination](#pagination).
  As of December 19, 2018, the execution history obtainable through the before parameter will be limited to the most recent 31 days.

Response:
```json
[
  {
    "id": 39287,
    "side": "BUY",
    "price": 31690,
    "size": 27.04,
    "exec_date": "2015-07-08T02:43:34.823",
    "buy_child_order_acceptance_id": "JRF20150707-200203-452209",
    "sell_child_order_acceptance_id": "JRF20150708-024334-060234"
  }
]
```

Response Fields:
* `id`: Unique identifier for the execution.
* `side`: Side of the execution ('BUY' or 'SELL').
* `price`: Price of the execution.
* `size`: Size of the execution.
* `exec_date`: Timestamp of the execution in UTC.
* `buy_child_order_acceptance_id`: Acceptance ID for the buy order.
* `sell_child_order_acceptance_id`: Acceptance ID for the sell order.
```

--------------------------------

### Get Execution History

Source: https://lightning.bitflyer.com/docs/api

Retrieves a list of past trade executions for a given product. Supports pagination for historical data retrieval.

```APIDOC
GET /v1/getexecutions
GET /v1/executions

Query parameters:
* `product_code`: Please specify a `product_code`, as obtained from the [Market List](#market-list).
  Please refer to the [Regions](#regions) to check available products in each region.
* `count`, `before`, `after`: See [Pagination](#pagination).
  As of December 19, 2018, the execution history obtainable through the before parameter will be limited to the most recent 31 days.

Response:
```json
[
  {
    "id": 39287,
    "side": "BUY",
    "price": 31690,
    "size": 27.04,
    "exec_date": "2015-07-08T02:43:34.823",
    "buy_child_order_acceptance_id": "JRF20150707-200203-452209",
    "sell_child_order_acceptance_id": "JRF20150708-024334-060234"
  }
]
```

Response Fields:
* `id`: Unique identifier for the execution.
* `side`: Side of the execution ('BUY' or 'SELL').
* `price`: Price of the execution.
* `size`: Size of the execution.
* `exec_date`: Timestamp of the execution in UTC.
* `buy_child_order_acceptance_id`: Acceptance ID for the buy order.
* `sell_child_order_acceptance_id`: Acceptance ID for the sell order.
```

--------------------------------

### Trade Data Response Structure

Source: https://lightning.bitflyer.com/docs/index

Example JSON structure for trade data, detailing fields like ID, timestamps, product codes, trade type, price, amount, and commission.

```json
[
  {
    "id": 1000108,
    "trade_date": "2016-10-19T14:44:55.28",
    "event_date": "2016-10-19T05:44:55.28",
    "product_code": "BTC_USD",
    "currency_code": "USD",
    "trade_type": "SELL",
    "price": 9999.99,
    "amount": 99.99,
    "quantity": 99.99,
    "commission": 0,
    "balance": 9999999.99,
    "order_id": "JORYYYYMMDD‌-000000-000001X"
  },
  {
    "id": 1000107,
    "trade_date": "2016-10-19T14:41:35.23",
    "event_date": "2016-10-19T05:41:35.23",
    "product_code": "BTC_USD",
    "currency_code": "USD",
    "trade_type": "SELL",
    "price": 9999.99,
    "amount": 999.99,
    "quantity": 99.99,
    "commission": 0,
    "balance": 9999999.99,
    "order_id": "JORYYYYMMDD‌-000000-000000X"
  }
]
```

--------------------------------

### Get Ticker Information

Source: https://lightning.bitflyer.com/docs/index

Retrieves ticker information for a specific product, including best bid/ask prices, volume, and last traded price.

```APIDOC
Response Example (Ticker):
```json
{
  "product_code": "BTC_JPY",
  "state": "RUNNING",
  "timestamp": "2015-07-08T02:50:59.97",
  "tick_id": 3579,
  "best_bid": 30000,
  "best_ask": 36640,
  "best_bid_size": 0.1,
  "best_ask_size": 5,
  "total_bid_depth": 15.13,
  "total_ask_depth": 20,
  "market_bid_size": 0,
  "market_ask_size": 0,
  "ltp": 31690,
  "volume": 16819.26,
  "volume_by_product": 6819.26
}
```

Response Fields:
* `product_code`: The product code (e.g., "BTC_JPY").
* `state`: Current state of the product.
* `timestamp`: Timestamp of the data in UTC.
* `tick_id`: Identifier for the tick.
* `best_bid`: Best bid price.
* `best_ask`: Best ask price.
* `best_bid_size`: Size of the best bid.
* `best_ask_size`: Size of the best ask.
* `total_bid_depth`: Total bid depth.
* `total_ask_depth`: Total ask depth.
* `market_bid_size`: Market sell order volume under Itayose period.
* `market_ask_size`: Market buy order volume under Itayose period.
* `ltp`: Last traded price.
* `volume`: 24-hour trade volume.
* `volume_by_product`: 24-hour trade volume for the specific product.
```

--------------------------------

### Trade Data Response Structure

Source: https://lightning.bitflyer.com/docs/api

Example JSON structure for trade data, detailing fields like ID, timestamps, product codes, trade type, price, amount, and commission.

```json
[
  {
    "id": 1000108,
    "trade_date": "2016-10-19T14:44:55.28",
    "event_date": "2016-10-19T05:44:55.28",
    "product_code": "BTC_USD",
    "currency_code": "USD",
    "trade_type": "SELL",
    "price": 9999.99,
    "amount": 99.99,
    "quantity": 99.99,
    "commission": 0,
    "balance": 9999999.99,
    "order_id": "JORYYYYMMDD‌-000000-000001X"
  },
  {
    "id": 1000107,
    "trade_date": "2016-10-19T14:41:35.23",
    "event_date": "2016-10-19T05:41:35.23",
    "product_code": "BTC_USD",
    "currency_code": "USD",
    "trade_type": "SELL",
    "price": 9999.99,
    "amount": 999.99,
    "quantity": 99.99,
    "commission": 0,
    "balance": 9999999.99,
    "order_id": "JORYYYYMMDD‌-000000-000000X"
  }
]
```

--------------------------------

### Get Ticker Information

Source: https://lightning.bitflyer.com/docs/api

Retrieves ticker information for a specific product, including best bid/ask prices, volume, and last traded price.

```APIDOC
Response Example (Ticker):
```json
{
  "product_code": "BTC_JPY",
  "state": "RUNNING",
  "timestamp": "2015-07-08T02:50:59.97",
  "tick_id": 3579,
  "best_bid": 30000,
  "best_ask": 36640,
  "best_bid_size": 0.1,
  "best_ask_size": 5,
  "total_bid_depth": 15.13,
  "total_ask_depth": 20,
  "market_bid_size": 0,
  "market_ask_size": 0,
  "ltp": 31690,
  "volume": 16819.26,
  "volume_by_product": 6819.26
}
```

Response Fields:
* `product_code`: The product code (e.g., "BTC_JPY").
* `state`: Current state of the product.
* `timestamp`: Timestamp of the data in UTC.
* `tick_id`: Identifier for the tick.
* `best_bid`: Best bid price.
* `best_ask`: Best ask price.
* `best_bid_size`: Size of the best bid.
* `best_ask_size`: Size of the best ask.
* `total_bid_depth`: Total bid depth.
* `total_ask_depth`: Total ask depth.
* `market_bid_size`: Market sell order volume under Itayose period.
* `market_ask_size`: Market buy order volume under Itayose period.
* `ltp`: Last traded price.
* `volume`: 24-hour trade volume.
* `volume_by_product`: 24-hour trade volume for the specific product.
```

--------------------------------

### Get Market State

Source: https://lightning.bitflyer.com/docs/index

Retrieves the current state of the order book for a specified product. Includes health and operational status of the exchange.

```APIDOC
GET /v1/getboardstate

Query parameters:
* `product_code`: Please specify a `product_code`, as obtained from the [Market List](#market-list).
  Please refer to the [Regions](#regions) to check available products in each region.

Response:
```json
{
  "health": "NORMAL",
  "state": "RUNNING"
}
```

```json
{
  "health": "NORMAL",
  "state": "MATURED",
  "data": {
    "special_quotation": 410897
  }
}
```

Parameter Descriptions:
* `health`: Operational status of the exchange. Possible values: `NORMAL`, `BUSY`, `VERY BUSY`, `SUPER BUSY`, `NO ORDER`, `STOP`.
* `state`: State of the order book. Possible values: `RUNNING`, `CLOSED`, `STARTING`, `PREOPEN`, `CIRCUIT BREAK`.
* `data`: Additional information on the order book.
```

--------------------------------

### BitFlyer API: Positions and Margin

Source: https://lightning.bitflyer.com/docs/index

Documentation for BitFlyer API endpoints related to fetching open interest summaries and margin change history. Includes request methods, query parameters, and response structures.

```APIDOC
Get Open Interest Summary:
  GET /v1/me/getpositions
  - Retrieves open interest summary for supported products.
  - Query Parameters:
    - product_code: Currently supports bitFlyer Crypto CFD.
  - Response Example:
    [
      {
        "product_code": "FX_BTC_JPY",
        "side": "BUY",
        "price": 36000,
        "size": 10,
        "commission": 0,
        "swap_point_accumulate": -35,
        "require_collateral": 120000,
        "open_date": "2015-11-03T10:04:45.011",
        "leverage": 3,
        "pnl": 965,
        "sfd": -0.5
      }
    ]

Get Margin Change History:
  GET /v1/me/getcollateralhistory
  - Retrieves the history of margin changes.
  - Query Parameters:
    - count: Number of records to retrieve.
    - before: ID of the record to fetch before.
    - after: ID of the record to fetch after.
  - Response Example:
    [
      {
        "id": 4995,
        "currency_code": "JPY",
        "change": -6,
        "amount": -6,
        "reason_code": "CLEARING_COLL",
        "date": "2017-05-18T02:37:41.327"
      },
      {
        "id": 4994,
        "currency_code": "JPY",
        "change": 2083698,
        "amount": 0,
        "reason_code": "EXCHANGE_COLL",
        "date": "2017-04-28T03:05:07.493"
      },
      {
        "id": 4993,
        "currency_code": "BTC",
        "change": -14.69001618,
        "amount": 34.97163164,
        "reason_code": "EXCHANGE_COLL",
        "date": "2017-04-28T03:05:07.493"
      }
    ]
  - Field Descriptions:
    - change: The amount of change to the margin deposit.
    - amount: The margin deposit balance after the change.
```

--------------------------------

### Get Account Asset Balance

Source: https://lightning.bitflyer.com/docs/api

Retrieves the balance details for each currency held in the account, including total amount and available amount.

```APIDOC
GET /v1/me/getbalance

Response:
[
  {
    "currency_code": "JPY",
    "amount": 1024078,
    "available": 508000
  },
  {
    "currency_code": "BTC",
    "amount": 10.24,
    "available": 4.12
  }
]
```

--------------------------------

### BitFlyer API: Positions and Margin

Source: https://lightning.bitflyer.com/docs/api

Documentation for BitFlyer API endpoints related to fetching open interest summaries and margin change history. Includes request methods, query parameters, and response structures.

```APIDOC
Get Open Interest Summary:
  GET /v1/me/getpositions
  - Retrieves open interest summary for supported products.
  - Query Parameters:
    - product_code: Currently supports bitFlyer Crypto CFD.
  - Response Example:
    [
      {
        "product_code": "FX_BTC_JPY",
        "side": "BUY",
        "price": 36000,
        "size": 10,
        "commission": 0,
        "swap_point_accumulate": -35,
        "require_collateral": 120000,
        "open_date": "2015-11-03T10:04:45.011",
        "leverage": 3,
        "pnl": 965,
        "sfd": -0.5
      }
    ]

Get Margin Change History:
  GET /v1/me/getcollateralhistory
  - Retrieves the history of margin changes.
  - Query Parameters:
    - count: Number of records to retrieve.
    - before: ID of the record to fetch before.
    - after: ID of the record to fetch after.
  - Response Example:
    [
      {
        "id": 4995,
        "currency_code": "JPY",
        "change": -6,
        "amount": -6,
        "reason_code": "CLEARING_COLL",
        "date": "2017-05-18T02:37:41.327"
      },
      {
        "id": 4994,
        "currency_code": "JPY",
        "change": 2083698,
        "amount": 0,
        "reason_code": "EXCHANGE_COLL",
        "date": "2017-04-28T03:05:07.493"
      },
      {
        "id": 4993,
        "currency_code": "BTC",
        "change": -14.69001618,
        "amount": 34.97163164,
        "reason_code": "EXCHANGE_COLL",
        "date": "2017-04-28T03:05:07.493"
      }
    ]
  - Field Descriptions:
    - change: The amount of change to the margin deposit.
    - amount: The margin deposit balance after the change.
```

--------------------------------

### Get Corporate Leverage

Source: https://lightning.bitflyer.com/docs/api

Retrieves the current and next maximum leverage settings for corporate accounts. Includes effective dates for these settings.

```APIDOC
GET /v1/getcorporateleverage

Response:
{
    "current_max": 7.70,
    "current_startdate": "2021-04-27T15:00:00",
    "next_max": 7.65,
    "next_startdate": "2021-05-04T15:00:00"
}

Fields:
- current_max: The current max leverage.
- current_startdate: The effective date/time from which the current max leverage applies.
- next_max: The next applicable max leverage (no value is returned if it is yet to be determined).
- next_startdate: The effective date/time from which the next max leverage will apply (no value is returned if it is yet to be determined).
```

--------------------------------

### bitFlyer Pagination Parameters

Source: https://lightning.bitflyer.com/docs/index

Describes query parameters used for paginating results from APIs that return multiple data entries.

```APIDOC
Pagination Query Parameters:

- `count`: Specifies the number of results to return. Defaults to 100 if omitted.
- `before`: Obtains data with an `id` strictly lower than the specified value.
- `after`: Obtains data with an `id` strictly higher than the specified value.
```

--------------------------------

### Get Market State

Source: https://lightning.bitflyer.com/docs/api

Retrieves the current state of the order book for a specified product. Includes health and operational status of the exchange.

```APIDOC
GET /v1/getboardstate

Query parameters:
* `product_code`: Please specify a `product_code`, as obtained from the [Market List](#market-list).
  Please refer to the [Regions](#regions) to check available products in each region.

Response:
```json
{
  "health": "NORMAL",
  "state": "RUNNING"
}
```

```json
{
  "health": "NORMAL",
  "state": "MATURED",
  "data": {
    "special_quotation": 410897
  }
}
```

Parameter Descriptions:
* `health`: Operational status of the exchange. Possible values: `NORMAL`, `BUSY`, `VERY BUSY`, `SUPER BUSY`, `NO ORDER`, `STOP`.
* `state`: State of the order book. Possible values: `RUNNING`, `CLOSED`, `STARTING`, `PREOPEN`, `CIRCUIT BREAK`.
* `data`: Additional information on the order book.
```

--------------------------------

### Get Funding Rate

Source: https://lightning.bitflyer.com/docs/index

Retrieves the next scheduled funding rate transfer ratio for perpetual futures contracts. Includes the settlement date.

```APIDOC
GET /v1/getfundingrate

Query parameters:
* `product_code`: Within the "product_code" that you can obtain from the [Market List](#market-list), specify "FX" as "market_type". This cannot be omitted.

`"FX" will remain as "market_type" for the time being after the launch of bitFlyer Crypto CFD on March 28th, 2024.`
`"FX_BTC_JPY" will remain as "product_code" for the time being after the launch of bitFlyer Crypto CFD on March 28th, 2024.`

Response:
```json
{
  "current_funding_rate": -0.003750000000,
  "next_funding_rate_settledate": "2024-04-15T13:00:00"
}
```

Response Fields:
* `current_funding_rate`: Funding rate transfer ratio that will be collected or granted, displayed in rate.
* `next_funding_rate_settledate`: Timing of next funding rate collection or grant, displayed in UTC (Coordinated Universal Time).
```

--------------------------------

### Sample Parent Order Response

Source: https://lightning.bitflyer.com/docs/index

Illustrates a JSON response structure for parent orders, detailing order IDs, product codes, side, price, size, and state. Note that 'price' and 'size' are reference values for parent orders with multiple associated orders.

```json
[
  {
    "id": 138398,
    "parent_order_id": "JCO20150707-084555-022523",
    "product_code": "BTC_JPY",
    "side": "BUY",
    "parent_order_type": "STOP",
    "price": 30000,
    "average_price": 30000,
    "size": 0.1,
    "parent_order_state": "COMPLETED",
    "expire_date": "2015-07-14T07:25:52",
    "parent_order_date": "2015-07-07T08:45:53",
    "parent_order_acceptance_id": "JRF20150707-084552-031927",
    "outstanding_size": 0,
    "cancel_size": 0,
    "executed_size": 0.1,
    "total_commission": 0
  },
  {
    "id": 138397,
    "parent_order_id": "JCO20150707-084549-022519",
    "product_code": "BTC_JPY",
    "side": "SELL",
    "parent_order_type": "IFD",
    "price": 30000,
    "average_price": 0,
    "size": 0.1,
    "parent_order_state": "CANCELED",
    "expire_date": "2015-07-14T07:25:47",
    "parent_order_date": "2015-07-07T08:45:47",
    "parent_order_acceptance_id": "JRF20150707-084547-396699",
    "outstanding_size": 0,
    "cancel_size": 0.1,
    "executed_size": 0,
    "total_commission": 0
  }
]

```

--------------------------------

### bitFlyer Pagination Parameters

Source: https://lightning.bitflyer.com/docs/api

Describes query parameters used for paginating results from APIs that return multiple data entries.

```APIDOC
Pagination Query Parameters:

- `count`: Specifies the number of results to return. Defaults to 100 if omitted.
- `before`: Obtains data with an `id` strictly lower than the specified value.
- `after`: Obtains data with an `id` strictly higher than the specified value.
```

--------------------------------

### Get Exchange Health Status

Source: https://lightning.bitflyer.com/docs/api

Checks the overall operational status of the exchange. Provides information on traffic levels and potential service disruptions.

```APIDOC
GET /v1/gethealth

Query parameters:
* `product_code`: Please specify a `product_code`, as obtained from the [Market List](#market-list).
  Please refer to the [Regions](#regions) to check available products in each region.

Response:
```json
{
  "status": "NORMAL"
}
```

Parameter Descriptions:
* `status`: One of the following levels will be displayed: `NORMAL`, `BUSY`, `VERY BUSY`, `SUPER BUSY`, `STOP`.
```

--------------------------------

### Sample Parent Order Response

Source: https://lightning.bitflyer.com/docs/api

Illustrates a JSON response structure for parent orders, detailing order IDs, product codes, side, price, size, and state. Note that 'price' and 'size' are reference values for parent orders with multiple associated orders.

```json
[
  {
    "id": 138398,
    "parent_order_id": "JCO20150707-084555-022523",
    "product_code": "BTC_JPY",
    "side": "BUY",
    "parent_order_type": "STOP",
    "price": 30000,
    "average_price": 30000,
    "size": 0.1,
    "parent_order_state": "COMPLETED",
    "expire_date": "2015-07-14T07:25:52",
    "parent_order_date": "2015-07-07T08:45:53",
    "parent_order_acceptance_id": "JRF20150707-084552-031927",
    "outstanding_size": 0,
    "cancel_size": 0,
    "executed_size": 0.1,
    "total_commission": 0
  },
  {
    "id": 138397,
    "parent_order_id": "JCO20150707-084549-022519",
    "product_code": "BTC_JPY",
    "side": "SELL",
    "parent_order_type": "IFD",
    "price": 30000,
    "average_price": 0,
    "size": 0.1,
    "parent_order_state": "CANCELED",
    "expire_date": "2015-07-14T07:25:47",
    "parent_order_date": "2015-07-07T08:45:47",
    "parent_order_acceptance_id": "JRF20150707-084547-396699",
    "outstanding_size": 0,
    "cancel_size": 0.1,
    "executed_size": 0,
    "total_commission": 0
  }
]

```

--------------------------------

### Get Funding Rate

Source: https://lightning.bitflyer.com/docs/api

Retrieves the next scheduled funding rate transfer ratio for perpetual futures contracts. Includes the settlement date.

```APIDOC
GET /v1/getfundingrate

Query parameters:
* `product_code`: Within the "product_code" that you can obtain from the [Market List](#market-list), specify "FX" as "market_type". This cannot be omitted.

`"FX" will remain as "market_type" for the time being after the launch of bitFlyer Crypto CFD on March 28th, 2024.`
`"FX_BTC_JPY" will remain as "product_code" for the time being after the launch of bitFlyer Crypto CFD on March 28th, 2024.`

Response:
```json
{
  "current_funding_rate": -0.003750000000,
  "next_funding_rate_settledate": "2024-04-15T13:00:00"
}
```

Response Fields:
* `current_funding_rate`: Funding rate transfer ratio that will be collected or granted, displayed in rate.
* `next_funding_rate_settledate`: Timing of next funding rate collection or grant, displayed in UTC (Coordinated Universal Time).
```

--------------------------------

### Get Exchange Health Status

Source: https://lightning.bitflyer.com/docs/index

Checks the overall operational status of the exchange. Provides information on traffic levels and potential service disruptions.

```APIDOC
GET /v1/gethealth

Query parameters:
* `product_code`: Please specify a `product_code`, as obtained from the [Market List](#market-list).
  Please refer to the [Regions](#regions) to check available products in each region.

Response:
```json
{
  "status": "NORMAL"
}
```

Parameter Descriptions:
* `status`: One of the following levels will be displayed: `NORMAL`, `BUSY`, `VERY BUSY`, `SUPER BUSY`, `STOP`.
```

--------------------------------

### bitFlyer Lightning Realtime API Connection and Behavior

Source: https://lightning.bitflyer.com/docs/playgroundrealtime

Details on connecting to the bitFlyer Lightning Realtime API, including protocol, data handling upon disconnection, and client requirements. This entry covers the general operational aspects of the realtime API.

```APIDOC
Realtime API Connection:
  Protocol: JSON-RPC 2.0 over WebSocket
  Client Requirements:
    - TLS 1.2 compatible client and settings are required.

Data Handling:
  - Information delivered before reconnection may not be received if the connection is lost.
  - Connection may be intentionally disconnected for maintenance.
  - Reconnection procedures must be implemented by the client for continuous data reception.

Channel Naming Convention:
  - {{proto.label}}
  - Private channels: {{ch.private ? "" : "lightning_"}}{{ch.id}}
  - Public channels: {{ch.private ? "" : "lightning_"}}{{ch.id}}{{ ch.productCodeParameter ? "_<productCode>" : ""}}

Security Recommendations:
  - Encrypt API Secret when programming.
  - Avoid storing API Secret in program code, text files, databases, or version control systems.
  - Enable two-factor authentication.
  - Use API Secret at your own risk; do not share it outside of authorized services.
```

--------------------------------

### Get Crypto Assets Deposit Addresses

Source: https://lightning.bitflyer.com/docs/api

Retrieves crypto asset deposit addresses for making deposits to a bitFlyer account. Supports BTC and ETH.

```APIDOC
GET /v1/me/getaddresses

Response:
[
  {
    "type": "NORMAL",
    "currency_code": "BTC",
    "address": "3AYrDq8zhF82NJ2ZaLwBMPmaNziaKPaxa7"
  },
  {
    "type": "NORMAL",
    "currency_code": "ETH",
    "address": "0x7fbB2CC24a3C0cd3789a44e9073381Ca6470853f"
  }
]

Fields:
- type: "NORMAL" for general deposit addresses.
- currency_code: "BTC" for Bitcoin addresses and "ETH" for Ethereum addresses.
```

--------------------------------

### Get Chat Logs

Source: https://lightning.bitflyer.com/docs/api

Obtains chat logs, with options to filter by region (Japan, USA, EU). Supports querying messages after a specified date.

```APIDOC
GET /v1/getchats
GET /v1/getchats/usa
GET /v1/getchats/eu

Query parameters:
- from_date: Accesses new messages after this date. Defaults to the previous 5 days if left blank.

Response:
[
  {
    "nickname": "User1234567",
    "message": "Hello world!",
    "date": "2016-02-16T10:58:08.833"
  }
]

Notes:
- `/v1/getchats` pulls logs from Japan.
- `/v1/getchats/usa` pulls logs from USA.
- `/v1/getchats/eu` pulls logs from EU.
```

--------------------------------

### BitFlyer API: Trading Commission

Source: https://lightning.bitflyer.com/docs/index

Documentation for the BitFlyer API endpoint to retrieve trading commission rates. Includes the request method, required query parameters, and the response structure.

```APIDOC
Get Trading Commission:
  GET /v1/me/gettradingcommission
  - Retrieves the trading commission rate.
  - Query Parameters:
    - product_code: Specify a product_code obtained from the Market List.
  - Response Example:
    {
      "commission_rate": 0.001
    }
```

--------------------------------

### bitFlyer API: Private API - Permissions

Source: https://lightning.bitflyer.com/docs/index

Retrieves a list of HTTP Private APIs accessible with the provided API key. Requires authentication.

```APIDOC
GET /v1/me/getpermissions

Description:
  Returns a list of HTTP Private APIs that can be used with the API key provided in the header of the request. Authentication is required.

Response:
  [
    "/v1/me/getpermissions",
    "/v1/me/getbalance",
    "/v1/me/getcollateral"
  ]
```

--------------------------------

### bitFlyer API Authentication Headers

Source: https://lightning.bitflyer.com/docs/index

Details the required HTTP headers for authenticating requests to bitFlyer's private APIs. These headers include the API key, a timestamp, and a generated signature.

```APIDOC
Required HTTP Headers for Private API Authentication:

- `ACCESS-KEY`: Your API key issued by bitFlyer.
- `ACCESS-TIMESTAMP`: The Unix Timestamp of the request.
- `ACCESS-SIGN`: HMAC-SHA256 hash of the concatenated `ACCESS-TIMESTAMP`, HTTP method, request path, and request body, signed with your API secret.
```

--------------------------------

### bitFlyer Public API: Ticker Query Parameters

Source: https://lightning.bitflyer.com/docs/index

Details the query parameter required for the ticker endpoints.

```APIDOC
Query Parameters:

- `product_code`: Required. Specifies the product for which to retrieve ticker information (e.g., 'BTC_JPY'). Refer to the Market List for available product codes.
```

--------------------------------

### Get Margin Status and Collateral

Source: https://lightning.bitflyer.com/docs/api

Provides details on margin status, including deposited collateral, profit/loss from open positions, required collateral, and margin call information.

```APIDOC
GET /v1/me/getcollateral

Response:
{
  "collateral": 100000,
  "open_position_pnl": -715,
  "require_collateral": 19857,
  "keep_rate": 5.000,
  "margin_call_amount": 1000000,
  "margin_call_due_date": "2021-09-01T08:00:00"
}

Fields:
- collateral: The amount deposited in JPY.
- open_position_pnl: The profit or loss from valuation.
- require_collateral: The current required margin.
- keep_rate: The current maintenance margin.
- margin_call_amount: The margin call.
- margin_call_due_date: The margin call due date.
```

```APIDOC
GET /v1/me/getcollateralaccounts

Description: Obtain the details of your margin deposits for each currency.

Response:
[
  {
    "currency_code": "JPY",
    "amount": 10000
  },
  {
    "currency_code": "BTC",
    "amount": 1.23
  }
]
```

--------------------------------

### bitFlyer Lightning API Endpoints URLs

Source: https://lightning.bitflyer.com/docs/index

The base URLs for accessing the bitFlyer Lightning HTTP API for different regions.

```APIDOC
Endpoint URLs:

- Japan Endpoint URL: `https://api.bitflyer.com/v1/`
- U.S. Endpoint URL: `https://api.bitflyer.com/v1/`
- Europe Endpoint URL: `https://api.bitflyer.com/v1/`
```

--------------------------------

### List Executions API

Source: https://lightning.bitflyer.com/docs/index

Fetches a list of executed orders. Supports filtering by `product_code`, pagination using `count`, `before`, and `after`, and optional filtering by `child_order_id` or `child_order_acceptance_id`. Refer to Market List and Pagination documentation for details.

```APIDOC
GET /v1/me/getexecutions

Query parameters:
  * `product_code`: Required. Specifies the product code (e.g., BTC_JPY). Refer to Market List.
  * `count`: For pagination.
  * `before`: For pagination.
  * `after`: For pagination.
  * `child_order_id`: Optional. Filters by child order ID.
  * `child_order_acceptance_id`: Optional. Filters by child order acceptance ID.

Response:
[
  {
    "id": 37233,
    "child_order_id": "JOR20150707-060559-021935",
    "side": "BUY",
    "price": 33470,
    "size": 0.01,
    "commission": 0,
    "exec_date": "2015-07-07T09:57:40.397",
    "child_order_acceptance_id": "JRF20150707-060559-396699"
  },
  {
    "id": 37232,
    "child_order_id": "JOR20150707-060426-021925",
    "side": "BUY",
    "price": 33470,
    "size": 0.01,
    "commission": 0,
    "exec_date": "2015-07-07T09:57:40.397",
    "child_order_acceptance_id": "JRF20150707-060559-396699"
  }
]

```

--------------------------------

### bitFlyer Public API: Order Book Query Parameters

Source: https://lightning.bitflyer.com/docs/index

Details the query parameter required for the order book endpoints.

```APIDOC
Query Parameters:

- `product_code`: Required. Specifies the product for which to retrieve the order book (e.g., 'BTC_JPY'). Refer to the Market List for available product codes.
```

--------------------------------

### bitFlyer Lightning API Endpoints URLs

Source: https://lightning.bitflyer.com/docs/api

The base URLs for accessing the bitFlyer Lightning HTTP API for different regions.

```APIDOC
Endpoint URLs:

- Japan Endpoint URL: `https://api.bitflyer.com/v1/`
- U.S. Endpoint URL: `https://api.bitflyer.com/v1/`
- Europe Endpoint URL: `https://api.bitflyer.com/v1/`
```

--------------------------------

### bitFlyer API Authentication Headers

Source: https://lightning.bitflyer.com/docs/api

Details the required HTTP headers for authenticating requests to bitFlyer's private APIs. These headers include the API key, a timestamp, and a generated signature.

```APIDOC
Required HTTP Headers for Private API Authentication:

- `ACCESS-KEY`: Your API key issued by bitFlyer.
- `ACCESS-TIMESTAMP`: The Unix Timestamp of the request.
- `ACCESS-SIGN`: HMAC-SHA256 hash of the concatenated `ACCESS-TIMESTAMP`, HTTP method, request path, and request body, signed with your API secret.
```

--------------------------------

### Get Crypto Assets Transaction History

Source: https://lightning.bitflyer.com/docs/api

Retrieves the history of crypto asset transactions (outbound remittances). Details include ID, order ID, currency, amount, address, fees, status, and event date.

```APIDOC
GET /v1/me/getcoinouts

Query parameters:
- count, before, after: See [Pagination](#pagination).

Response:
[
  {
    "id": 500,
    "order_id": "CWD20151224-014040-077777",
    "currency_code": "BTC",
    "amount": 0.1234,
    "address": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa",
    "tx_hash": "724c07dfd4044abcb390b0412c3e707dd5c4f373f0a52b3bd295ce32b478c60a",
    "fee": 0.0005,
    "additional_fee": 0.0001,
    "status": "COMPLETED",
    "event_date": "2015-12-24T01:40:40.397"
  }
]

Fields:
- status: "PENDING" if remittance is processing, "COMPLETED" if finished.
```

--------------------------------

### Get Crypto Assets Deposit History

Source: https://lightning.bitflyer.com/docs/api

Fetches the history of crypto asset deposits. Includes transaction details like ID, order ID, currency, amount, address, transaction hash, status, and event date.

```APIDOC
GET /v1/me/getcoinins

Query parameters:
- count, before, after: See [Pagination](#pagination).

Response:
[
  {
    "id": 100,
    "order_id": "CDP20151227-024141-055555",
    "currency_code": "BTC",
    "amount": 0.00002,
    "address": "1WriteySQufKZ2pVuM1oMhPrTtTVFq35j",
    "tx_hash": "9f92ee65a176bb9545f7becb8706c50d07d4cee5ffca34d8be3ef11d411405ae",
    "status": "COMPLETED",
    "event_date": "2015-11-27T08:59:20.301"
  }
]

Fields:
- status: "PENDING" if processing, "COMPLETED" if finished.
```

--------------------------------

### bitFlyer Public API: Ticker Query Parameters

Source: https://lightning.bitflyer.com/docs/api

Details the query parameter required for the ticker endpoints.

```APIDOC
Query Parameters:

- `product_code`: Required. Specifies the product for which to retrieve ticker information (e.g., 'BTC_JPY'). Refer to the Market List for available product codes.
```
Tokens:
Raw