# Bitfinex

> Read Bitfinex's public market data: the price and last 24 hours of any trading pair or all of them, hourly price history, trades, the order book, price candles, margin longs and shorts, perpetual contracts' funding and open interest, margin funding rates, liquidations and leaderboards. Convert currencies at its rate, estimate what an order would fill at, and start a workflow when a price crosses a level. No account or API key required.

App · 19 actions. Web page: https://docs.lodol.com/docs/integrations/bitfinex

## Actions

### Convert currency

Convert an amount from one currency to another at Bitfinex's exchange rate, e.g. BTC to EUR, ETH to JPY or USD to EUR.

**Inputs**

- From currency (`from_currency`, text, required): The currency to convert from, e.g. BTC.
- To currency (`to_currency`, text, required): The currency to convert to, e.g. EUR or JPY.
- Amount (`amount`, number): How much to convert. Defaults to 1. At least 0. Default: `1`.

**Outputs**

- `amount` (number): The amount converted, in the first currency.
- `converted_amount` (number): What it is worth in the second currency.
- `from_currency` (text): The currency converted from.
- `rate` (number): How much of the second currency one of the first is worth.
- `summary` (text): One readable sentence about the answer.
- `to_currency` (text): The currency converted to.

**Example output**

```json
{
  "amount": 0.5,
  "converted_amount": 34355.25,
  "from_currency": "BTC",
  "rate": 68710.5,
  "summary": "0.5 BTC is 34,355.25 EUR at Bitfinex's rate of 68,710.5.",
  "to_currency": "EUR"
}
```

### Estimate average price

Estimate the average price an order to buy or sell an amount of a trading pair would fill at, from its order book now, and the total it would cost or bring in.

**Inputs**

- Pair (`pair`, text, required): The trading pair, e.g. BTC/USD. Pick from the list, or type it as BTC/USD, btcusd or tBTCUSD.
- Side (`side`, text, required): Buy or sell. One of: `buy`, `sell`.
- Amount (`amount`, number, required): How much of the pair's first currency to buy or sell, e.g. 2 for 2 BTC on BTC/USD. At least 0.

**Outputs**

- `amount_filled` (number): How much the order book can fill of it now.
- `amount_requested` (number): The order's size, in the base currency.
- `average_price` (number): The average price it would fill at.
- `fully_filled` (true/false): True when the order book holds enough to fill it all.
- `pair` (text): The pair as people write it, e.g. BTC/USD.
- `side` (text): buy or sell.
- `summary` (text): One readable sentence about the answer.
- `symbol` (text): Bitfinex's symbol for the pair, e.g. tBTCUSD.
- `total` (number): Average price times the amount filled, in the quote currency.

**Example output**

```json
{
  "amount_filled": 2,
  "amount_requested": 2.0,
  "average_price": 76890.42920163,
  "fully_filled": true,
  "pair": "BTC/USD",
  "side": "sell",
  "summary": "To sell 2 BTC on BTC/USD now would average 76,890.43 USD, 153,780.86 USD in all.",
  "symbol": "tBTCUSD",
  "total": 153780.85840326
}
```

### Get funding book

Get the margin funding offers and bids waiting on a currency, with their daily and yearly rates, periods and amounts.

**Inputs**

- Currency (`currency`, text, required): The currency lent on Bitfinex's funding market, e.g. USD.
- Grouping (`precision`, text): How finely to group the book: by price to 5 significant figures (the finest) down to 1, or every order on its own. One of: `P0` (5 significant figures), `P1` (4 significant figures), `P2` (3 significant figures), `P3` (2 significant figures), `P4` (1 significant figure), `R0` (Every order on its own). Default: `P0`.
- Depth (`length`, text): How many levels to list on each side. One of: `1` (1 a side), `25` (25 a side), `100` (100 a side), `250` (250 a side). Default: `25`.

**Outputs**

- `best_bid_rate` (number): The highest daily rate a borrower bids.
- `best_offer_rate` (number): The lowest daily rate a lender offers.
- `bid_amount` (number): How much the listed bids add up to.
- `bids` (list): Borrowers' bids, highest rate first.
- `currency` (text): The currency, e.g. USD.
- `offered_amount` (number): How much the listed offers add up to.
- `offers` (list): Lenders' offers, lowest rate first.
- `precision` (text): How rates are grouped: P0 (finest) to P4, or R0 for single offers.
- `summary` (text): One readable sentence about the answer.
- `symbol` (text): Bitfinex's symbol for the funding currency, e.g. fUSD.

**Example output**

```json
{
  "best_bid_rate": 0.00023287671232876712,
  "best_offer_rate": 0.000139,
  "bid_amount": 9637083.03859537,
  "bids": [
    {
      "amount": 9637083.03859537,
      "offer_id": null,
      "orders": 1,
      "period_days": 120,
      "rate": 0.00023287671232876712,
      "rate_yearly_percent": 8.5
    }
  ],
  "currency": "USD",
  "offered_amount": 4227.23502078,
  "offers": [
    {
      "amount": 4227.23502078,
      "offer_id": null,
      "orders": 3,
      "period_days": 2,
      "rate": 0.000139,
      "rate_yearly_percent": 5.0735
    }
  ],
  "precision": "P0",
  "summary": "USD funding book: lowest offer 0.0139% a day, highest bid 0.0233% a day; 1 offer and 1 bid levels.",
  "symbol": "fUSD"
}
```

### Get funding rates

Get a currency's margin funding rates: the last rate lent at, the best rates lenders ask and borrowers bid, the flash return rate and the last 24 hours, each daily with its yearly rate.

**Inputs**

- Currency (`currency`, text, required): The currency lent on Bitfinex's funding market, e.g. USD.

**Outputs**

- `ask_period_days` (number): How many days that offer is for.
- `ask_rate` (number): The lowest daily rate a lender is asking.
- `ask_size` (number): How much the 25 lowest offers add up to.
- `bid_period_days` (number): How many days that bid is for.
- `bid_rate` (number): The highest daily rate a borrower is bidding.
- `bid_size` (number): How much the 25 highest bids add up to.
- `change_24h` (number): How much the last rate moved over 24 hours.
- `change_24h_percent` (number): That move as a percentage of the rate.
- `currency` (text): The currency, e.g. USD.
- `flash_return_rate` (number): The flash return rate: the average of fixed-rate funding over the last hour, as a daily fraction.
- `flash_return_rate_yearly_percent` (number): The daily rate times 365, as a percentage.
- `frr_amount_available` (number): How much is offered at the flash return rate.
- `high_24h` (number): The highest daily rate over 24 hours.
- `last_rate` (number): A daily rate as a fraction: 0.0003 is 0.03% a day.
- `last_rate_yearly_percent` (number): The daily rate times 365, as a percentage.
- `low_24h` (number): The lowest daily rate over 24 hours.
- `summary` (text): One readable sentence about the answer.
- `symbol` (text): Bitfinex's symbol for the funding currency, e.g. fUSD.
- `volume_24h` (number): How much was lent over 24 hours, in the currency.

**Example output**

```json
{
  "ask_period_days": 2,
  "ask_rate": 0.000139,
  "ask_size": 573556.9608032,
  "bid_period_days": 120,
  "bid_rate": 0.00023287671232876712,
  "bid_size": 22731144.16946215,
  "change_24h": 8.54e-05,
  "change_24h_percent": 61.0,
  "currency": "USD",
  "flash_return_rate": 0.0002978794520547945,
  "flash_return_rate_yearly_percent": 10.8726,
  "frr_amount_available": 132876813.21814813,
  "high_24h": 0.00029773,
  "last_rate": 0.0002254,
  "last_rate_yearly_percent": 8.2271,
  "low_24h": 3e-05,
  "summary": "USD funding last lent at 0.0225% a day (8.2271% a year); flash return rate 0.0298% a day; 24-hour volume 181,522,688.33 USD.",
  "symbol": "fUSD",
  "volume_24h": 181522688.33385995
}
```

### Get funding statistics

Get a currency's margin funding over time: the flash return rate, how much is lent and how much of it is in use, and the average period.

**Inputs**

- Currency (`currency`, text, required): The currency lent on Bitfinex's funding market, e.g. USD.
- From (`start`, date and time): Only from this time on. Leave blank for the newest.
- To (`end`, date and time): Only up to this time. Leave blank for up to now.
- Most readings (`limit`, number): How many readings to list, from 1 to 250. Defaults to 24. From 1 to 250. Default: `24`.

**Outputs**

- `count` (number): How many rows are listed.
- `currency` (text): The currency, e.g. USD.
- `stats` (list): The readings, newest first.
- `summary` (text): One readable sentence about the answer.
- `symbol` (text): Bitfinex's symbol for the funding currency, e.g. fUSD.

**Example output**

```json
{
  "count": 2,
  "currency": "USD",
  "stats": [
    {
      "average_period_days": 85.21,
      "flash_return_rate": 0.0003066,
      "flash_return_rate_yearly_percent": 11.1909,
      "funding_amount": 5948753189.629787,
      "funding_amount_used": 5884043627.469175,
      "funding_below_threshold": 470258619.36756474,
      "funding_used_percent": 98.9122,
      "time": "2026-10-01T01:05:00Z",
      "timestamp_ms": 1790816700000
    },
    {
      "average_period_days": 85.02,
      "flash_return_rate": 0.0003066,
      "flash_return_rate_yearly_percent": 11.1909,
      "funding_amount": 5949278527.82728,
      "funding_amount_used": 5884559105.569227,
      "funding_below_threshold": 470071946.6680786,
      "funding_used_percent": 98.9121,
      "time": "2026-10-01T00:05:00Z",
      "timestamp_ms": 1790813100000
    }
  ],
  "summary": "2 readings of USD funding; at 2026-10-01T01:05:00Z the flash return rate was 0.0307% a day and 98.9122% of 5,948,753,189.63 USD lent was in use.",
  "symbol": "fUSD"
}
```

### Get hourly price history

Get a trading pair's best bid and ask once an hour, up to a year back.

**Inputs**

- Pair (`pair`, text, required): The trading pair, e.g. BTC/USD. Pick from the list, or type it as BTC/USD, btcusd or tBTCUSD.
- From (`start`, date and time): Only from this time on. Leave blank for the newest.
- To (`end`, date and time): Only up to this time. Leave blank for up to now.
- Most hours (`limit`, number): How many hours to list, from 1 to 250. Defaults to 24. From 1 to 250. Default: `24`.
- Order (`order`, text): Newest first, or oldest first. One of: `newest` (Newest first), `oldest` (Oldest first). Default: `newest`.

**Outputs**

- `count` (number): How many rows are listed.
- `history` (list): The best bid and ask once an hour.
- `pair` (text): The pair as people write it, e.g. BTC/USD.
- `summary` (text): One readable sentence about the answer.
- `symbol` (text): Bitfinex's symbol for the pair, e.g. tBTCUSD.

**Example output**

```json
{
  "count": 3,
  "history": [
    {
      "ask": 83654,
      "bid": 83640,
      "mid_price": 83647.0,
      "time": "2026-10-01T00:00:09Z",
      "timestamp_ms": 1790812809000
    },
    {
      "ask": 83528,
      "bid": 83522,
      "mid_price": 83525.0,
      "time": "2026-10-01T01:00:09Z",
      "timestamp_ms": 1790816409000
    },
    {
      "ask": 83517,
      "bid": 83509,
      "mid_price": 83513.0,
      "time": "2026-10-01T02:00:09Z",
      "timestamp_ms": 1790820009000
    }
  ],
  "pair": "BTC/USD",
  "summary": "3 hourly prices for BTC/USD, from 2026-10-01T00:00:09Z to 2026-10-01T02:00:09Z.",
  "symbol": "tBTCUSD"
}
```

### Get leaderboard

Get the top traders of a Bitfinex leaderboard (volume, realized or unrealized profit, over 3 hours, a week or a month), as they stand now or stood at a time.

**Inputs**

- Leaderboard (`leaderboard`, text, required): Which leaderboard, e.g. Volume, last week, all pairs.
- As of (`as_of`, date and time): The standings as they stood at this time. Leave blank for the latest.
- Most places (`limit`, number): How many places to list, from 1 to 100. Defaults to 25. From 1 to 100. Default: `25`.

**Outputs**

- `count` (number): How many rows are listed.
- `entries` (list): The places, first first.
- `leaderboard` (text): Bitfinex's key for the leaderboard, e.g. vol:1w:tGLOBAL:USD.
- `name` (text): What the leaderboard ranks, over what time and pairs.
- `standings_time` (text): When these standings were taken (ISO 8601, UTC).
- `summary` (text): One readable sentence about the answer.
- `unit` (text): What the values count: USD, or the base currency for a pair's volume.

**Example output**

```json
{
  "count": 3,
  "entries": [
    {
      "rank": 1,
      "twitter_handle": null,
      "username": "Wintermute",
      "value": 300923462.15
    },
    {
      "rank": 2,
      "twitter_handle": null,
      "username": "TheyDontKnowImJustABuyWall",
      "value": 242669435.04
    },
    {
      "rank": 3,
      "twitter_handle": null,
      "username": "Crypt3d",
      "value": 193299822.48
    }
  ],
  "leaderboard": "vol:1w:tGLOBAL:USD",
  "name": "Volume, last week, all pairs",
  "standings_time": "2026-10-19T00:00:00Z",
  "summary": "Volume, last week, all pairs, standings of 2026-10-19T00:00:00Z: first Wintermute (300,923,462.15 USD), 3 places listed.",
  "unit": "USD"
}
```

### Get order book

Get the buy and sell orders waiting on a trading pair, grouped by price or one by one, with the best bid and ask, the spread and the mid price.

**Inputs**

- Pair (`pair`, text, required): The trading pair, e.g. BTC/USD. Pick from the list, or type it as BTC/USD, btcusd or tBTCUSD.
- Grouping (`precision`, text): How finely to group the book: by price to 5 significant figures (the finest) down to 1, or every order on its own. One of: `P0` (5 significant figures), `P1` (4 significant figures), `P2` (3 significant figures), `P3` (2 significant figures), `P4` (1 significant figure), `R0` (Every order on its own). Default: `P0`.
- Depth (`length`, text): How many levels to list on each side. One of: `1` (1 a side), `25` (25 a side), `100` (100 a side), `250` (250 a side). Default: `25`.

**Outputs**

- `ask_amount` (number): How much the listed asks add up to, in the base currency.
- `asks` (list): Sell orders, lowest price first.
- `best_ask` (number): The lowest ask.
- `best_bid` (number): The highest bid.
- `bid_amount` (number): How much the listed bids add up to, in the base currency.
- `bids` (list): Buy orders, highest price first.
- `mid_price` (number): Halfway between the best bid and best ask.
- `pair` (text): The pair as people write it, e.g. BTC/USD.
- `precision` (text): How prices are grouped: P0 (finest) to P4, or R0 for single orders.
- `spread` (number): Best ask minus best bid.
- `spread_percent` (number): The spread as a percentage of the mid price.
- `summary` (text): One readable sentence about the answer.
- `symbol` (text): Bitfinex's symbol for the pair, e.g. tBTCUSD.

**Example output**

```json
{
  "ask_amount": 0.48809561,
  "asks": [
    {
      "amount": 0.48809561,
      "order_id": null,
      "orders": 7,
      "price": 76970,
      "value": 37568.7191017
    }
  ],
  "best_ask": 76970,
  "best_bid": 76940,
  "bid_amount": 0.00014,
  "bids": [
    {
      "amount": 0.00014,
      "order_id": null,
      "orders": 1,
      "price": 76940,
      "value": 10.7716
    }
  ],
  "mid_price": 76955.0,
  "pair": "BTC/USD",
  "precision": "P1",
  "spread": 30,
  "spread_percent": 0.038984,
  "summary": "BTC/USD order book: best bid 76,940, best ask 76,970 USD (spread 30); 1 bid and 1 ask levels.",
  "symbol": "tBTCUSD"
}
```

### Get perpetual history

Get a perpetual contract's past status about once a minute: prices, funding and open interest over time.

**Inputs**

- Contract (`contract`, text, required): The perpetual contract, e.g. BTC/USDT perpetual.
- From (`start`, date and time): Only from this time on. Leave blank for the newest.
- To (`end`, date and time): Only up to this time. Leave blank for up to now.
- Most readings (`limit`, number): How many readings to list, from 1 to 5,000. Defaults to 100. From 1 to 5000. Default: `100`.
- Order (`order`, text): Newest first, or oldest first. One of: `newest` (Newest first), `oldest` (Oldest first). Default: `newest`.

**Outputs**

- `contract` (text): The contract as people write it, e.g. BTC/USDT perpetual.
- `count` (number): How many rows are listed.
- `history` (list): The contract's status over time.
- `summary` (text): One readable sentence about the answer.
- `symbol` (text): Bitfinex's symbol for the contract, e.g. tBTCF0:USTF0.

**Example output**

```json
{
  "contract": "BTC/USDT perpetual",
  "count": 2,
  "history": [
    {
      "clamp_max": 0.0025,
      "clamp_min": 0.0005,
      "current_funding": 7.039e-05,
      "derivative_price": 83634.3149219,
      "insurance_fund_balance": 61797011.75827756,
      "mark_price": 83587.7957,
      "next_funding_accrued": 1.02e-06,
      "next_funding_step": 18,
      "next_funding_time": "2026-10-01T08:00:00Z",
      "open_interest": 8955.09194121,
      "spot_price": 83585.5,
      "time": "2026-10-01T00:00:58Z"
    },
    {
      "clamp_max": 0.0025,
      "clamp_min": 0.0005,
      "current_funding": 7.039e-05,
      "derivative_price": 83607.53588228,
      "insurance_fund_balance": 61797011.75827756,
      "mark_price": 83559.7598,
      "next_funding_accrued": 2.09e-06,
      "next_funding_step": 37,
      "next_funding_time": "2026-10-01T08:00:00Z",
      "open_interest": 8955.11071208,
      "spot_price": 83556,
      "time": "2026-10-01T00:01:57Z"
    }
  ],
  "summary": "2 readings of BTC/USDT perpetual from 2026-10-01T00:00:58Z to 2026-10-01T00:01:57Z.",
  "symbol": "tBTCF0:USTF0"
}
```

### Get perpetual status

Get perpetual contracts' derivative, spot and mark prices, their funding this period and next, open interest and the insurance fund, for chosen contracts or all of them.

**Inputs**

- Contracts (`contracts`, list): The perpetual contracts, e.g. BTC/USDT perpetual. Leave blank for every contract.

**Outputs**

- `contracts` (list): Each perpetual contract's status.
- `count` (number): How many rows are listed.
- `missing_contracts` (list): Contracts asked for that Bitfinex doesn't list.
- `summary` (text): One readable sentence about the answer.

**Example output**

```json
{
  "contracts": [
    {
      "clamp_max": 0.0025,
      "clamp_min": 0.0005,
      "contract": "BTC/USDT perpetual",
      "current_funding": 7.287e-05,
      "derivative_price": 76962.56751461,
      "insurance_fund_balance": 60638269.77216531,
      "mark_price": 76919.095,
      "next_funding_accrued": 0.00027965,
      "next_funding_step": 4545,
      "next_funding_time": "2026-11-03T00:00:00Z",
      "open_interest": 9244.60557787,
      "spot_price": 76912.5,
      "symbol": "tBTCF0:USTF0",
      "time": "2026-11-02T19:57:23Z"
    },
    {
      "clamp_max": 0.0025,
      "clamp_min": 0.0005,
      "contract": "ETH/USDT perpetual",
      "current_funding": 0,
      "derivative_price": 2248.499907965,
      "insurance_fund_balance": 60638269.77216531,
      "mark_price": 2247.9169,
      "next_funding_accrued": 0.00021632,
      "next_funding_step": 4545,
      "next_funding_time": "2026-11-03T00:00:00Z",
      "open_interest": 12110.40151433,
      "spot_price": 2247.4,
      "symbol": "tETHF0:USTF0",
      "time": "2026-11-02T19:57:23Z"
    }
  ],
  "count": 2,
  "missing_contracts": [],
  "summary": "Status of 2 Bitfinex perpetual contracts."
}
```

### Get platform status

Check whether Bitfinex is operating or in maintenance, when trading is paused.

**Inputs**: None.

**Outputs**

- `operative` (true/false): True when Bitfinex is operating, false in maintenance.
- `status` (text): operative or maintenance.
- `summary` (text): One readable sentence about the answer.

**Example output**

```json
{
  "operative": true,
  "status": "operative",
  "summary": "Bitfinex is operating normally."
}
```

### Get price

Get a trading pair's last price, best bid and ask, and its last 24 hours: change, high, low and volume.

**Inputs**

- Pair (`pair`, text, required): The trading pair, e.g. BTC/USD. Pick from the list, or type it as BTC/USD, btcusd or tBTCUSD.

**Outputs**

- `ask` (number): The lowest price a seller is asking.
- `ask_size` (number): How much the 25 lowest asks add up to, in the base currency.
- `base_currency` (text): The currency bought and sold, e.g. BTC.
- `bid` (number): The highest price a buyer is offering.
- `bid_size` (number): How much the 25 highest bids add up to, in the base currency.
- `change_24h` (number): How much the price moved over the last 24 hours.
- `change_24h_percent` (number): That move as a percentage, e.g. -1.43.
- `first_trade_time` (text): When the pair first traded on Bitfinex (ISO 8601, UTC).
- `high_24h` (number): The highest price over the last 24 hours.
- `last_price` (number): The price of the last trade.
- `low_24h` (number): The lowest price over the last 24 hours.
- `pair` (text): The pair as people write it, e.g. BTC/USD.
- `quote_currency` (text): The currency prices are in, e.g. USD.
- `spread` (number): Ask minus bid.
- `summary` (text): One readable sentence about the answer.
- `symbol` (text): Bitfinex's symbol for the pair, e.g. tBTCUSD.
- `volume_24h` (number): How much was traded over the last 24 hours, in the base currency.

**Example output**

```json
{
  "ask": 76965,
  "ask_size": 1.68408032,
  "base_currency": "BTC",
  "bid": 76945,
  "bid_size": 2.54199778,
  "change_24h": -942,
  "change_24h_percent": -1.2091,
  "first_trade_time": "2013-01-14T16:47:23Z",
  "high_24h": 78922,
  "last_price": 76967,
  "low_24h": 76701,
  "pair": "BTC/USD",
  "quote_currency": "USD",
  "spread": 20,
  "summary": "BTC/USD last traded at 76,967 USD, down 1.2091% over 24 hours (high 78,922, low 76,701, volume 419.2587 BTC).",
  "symbol": "tBTCUSD",
  "volume_24h": 419.25869364
}
```

### Get price candles

Get a trading pair's price candles (open, close, high, low and volume) of 1 minute to 1 month each, the latest one or between two times, with the change across them.

**Inputs**

- Pair (`pair`, text, required): The trading pair, e.g. BTC/USD. Pick from the list, or type it as BTC/USD, btcusd or tBTCUSD.
- Candle length (`timeframe`, text): How long each candle is. One of: `1m` (1 minute), `5m` (5 minutes), `15m` (15 minutes), `30m` (30 minutes), `1h` (1 hour), `3h` (3 hours), `6h` (6 hours), `12h` (12 hours), `1D` (1 day), `1W` (1 week), `14D` (2 weeks), `1M` (1 month). Default: `1h`.
- Latest only (`latest_only`, true/false): Only the newest one, leaving out From, To and the rest. Default: `false`.
- From (`start`, date and time): Only from this time on. Leave blank for the newest.
- To (`end`, date and time): Only up to this time. Leave blank for up to now.
- Most candles (`limit`, number): How many candles to list, from 1 to 10,000. Defaults to 100. From 1 to 10000. Default: `100`.
- Order (`order`, text): Newest first, or oldest first. One of: `newest` (Newest first), `oldest` (Oldest first). Default: `newest`.

**Outputs**

- `candles` (list): The candles, in the order asked for.
- `change` (number): Last close minus first open.
- `change_percent` (number): That change as a percentage of the first open.
- `close` (number): The last candle's closing price.
- `count` (number): How many rows are listed.
- `high` (number): The highest price across the candles.
- `low` (number): The lowest price across the candles.
- `open` (number): The first candle's opening price.
- `pair` (text): The pair as people write it, e.g. BTC/USD.
- `summary` (text): One readable sentence about the answer.
- `symbol` (text): Bitfinex's symbol for the pair, e.g. tBTCUSD.
- `timeframe` (text): How long each candle is, e.g. 1h.
- `volume` (number): The volume across the candles, in the base currency.

**Example output**

```json
{
  "candles": [
    {
      "close": 83503,
      "high": 83673,
      "low": 83412,
      "open": 83604,
      "time": "2026-10-01T00:00:00Z",
      "timestamp_ms": 1790812800000,
      "volume": 8.96377584
    },
    {
      "close": 83508,
      "high": 83692,
      "low": 83476,
      "open": 83502,
      "time": "2026-10-01T01:00:00Z",
      "timestamp_ms": 1790816400000,
      "volume": 2.80659228
    },
    {
      "close": 83479,
      "high": 83661,
      "low": 83403,
      "open": 83517,
      "time": "2026-10-01T02:00:00Z",
      "timestamp_ms": 1790820000000,
      "volume": 3.24011824
    }
  ],
  "change": -125,
  "change_percent": -0.1495,
  "close": 83479,
  "count": 3,
  "high": 83692,
  "low": 83403,
  "open": 83604,
  "pair": "BTC/USD",
  "summary": "3 candles of 1h for BTC/USD, 2026-10-01T00:00:00Z to 2026-10-01T02:00:00Z: opened 83,604, closed 83,479 (-0.1495%), high 83,692, low 83,403.",
  "symbol": "tBTCUSD",
  "timeframe": "1h",
  "volume": 15.01048636
}
```

### Get statistic

Get one of Bitfinex's statistics, the latest value or over time: margin longs or shorts open on a pair, a pair's volume-weighted average price for the day, funding provided or used in a currency, or Bitfinex's trading volume over 1, 7 or 30 days.

**Inputs**

- Statistic (`statistic`, text, required): Which statistic to get. One of: `longs` (Margin longs open on a pair), `shorts` (Margin shorts open on a pair), `vwap` (Volume-weighted average price of the day), `funding_provided` (Funding provided in a currency), `funding_used` (Funding used in positions, in a currency), `funding_used_on_pair` (Funding of a currency used on a pair), `volume_1d` (Bitfinex trading volume, last 24 hours), `volume_7d` (Bitfinex trading volume, last 7 days), `volume_30d` (Bitfinex trading volume, last 30 days).
- Pair (`pair`, text): The trading pair it is about, e.g. BTC/USD. Pick from the list, or type it as BTC/USD or tBTCUSD. Only when Statistic is Margin longs open on a pair, Margin shorts open on a pair, Volume-weighted average price of the day or Funding of a currency used on a pair.
- Currency (`currency`, text): The funding currency it is about, e.g. USD. Only when Statistic is Funding provided in a currency, Funding used in positions, in a currency or Funding of a currency used on a pair.
- Latest only (`latest_only`, true/false): Only the newest one, leaving out From, To and the rest. Default: `false`.
- From (`start`, date and time): Only from this time on. Leave blank for the newest.
- To (`end`, date and time): Only up to this time. Leave blank for up to now.
- Most values (`limit`, number): How many values to list, from 1 to 10,000. Defaults to 30. From 1 to 10000. Default: `30`.
- Order (`order`, text): Newest first, or oldest first. One of: `newest` (Newest first), `oldest` (Oldest first). Default: `newest`.

**Outputs**

- `count` (number): How many rows are listed.
- `currency` (text): The funding currency it is about, when it is about one.
- `latest_time` (text): When the newest value was taken (ISO 8601, UTC).
- `latest_value` (number): The newest value.
- `pair` (text): The pair it is about, when it is about one, e.g. BTC/USD.
- `statistic` (text): The statistic's choice, e.g. longs.
- `statistic_name` (text): What the statistic measures.
- `summary` (text): One readable sentence about the answer.
- `unit` (text): What the values count, e.g. BTC or USD.
- `values` (list): The values over time.

**Example output**

```json
{
  "count": 3,
  "currency": null,
  "latest_time": "2026-10-01T00:02:00Z",
  "latest_value": 90117.48664207,
  "pair": "BTC/USD",
  "statistic": "longs",
  "statistic_name": "Margin longs open on a pair",
  "summary": "Margin longs open on a pair, BTC/USD: 90,117.49 BTC at 2026-10-01T00:02:00Z (newest of 3).",
  "unit": "BTC",
  "values": [
    {
      "time": "2026-10-01T00:00:00Z",
      "timestamp_ms": 1790812800000,
      "value": 90117.48519547
    },
    {
      "time": "2026-10-01T00:01:00Z",
      "timestamp_ms": 1790812860000,
      "value": 90117.48557557
    },
    {
      "time": "2026-10-01T00:02:00Z",
      "timestamp_ms": 1790812920000,
      "value": 90117.48664207
    }
  ]
}
```

### List currencies

List the currencies Bitfinex holds with their codes and names, e.g. UST is Tether USDt, optionally only those matching some text.

**Inputs**

- Name or code contains (`search`, text): Only currencies whose code or name contains this, e.g. tether. Leave blank for all.

**Outputs**

- `count` (number): How many rows are listed.
- `currencies` (list): The currencies.
- `summary` (text): One readable sentence about the answer.

**Example output**

```json
{
  "count": 7,
  "currencies": [
    {
      "code": "AUSDT",
      "name": "Alloy Tether",
      "symbol": "aUSDT"
    },
    {
      "code": "CNHT",
      "name": "Tether CNHt",
      "symbol": "CNHt"
    },
    {
      "code": "MXNT",
      "name": "Tether MXNt",
      "symbol": "MXNt"
    },
    {
      "code": "UST",
      "name": "Tether USDt",
      "symbol": "USDt"
    },
    {
      "code": "USTF0",
      "name": "Tether USDt",
      "symbol": "USDt"
    },
    {
      "code": "XAUT",
      "name": "Tether XAUt",
      "symbol": "XAUt"
    },
    {
      "code": "XAUT0BNB",
      "name": "Tether(XAU) on BNB Chain",
      "symbol": "XAUt"
    }
  ],
  "summary": "Bitfinex lists 7 currencies matching 'tether'."
}
```

### List liquidations

List the margin and perpetual positions Bitfinex has liquidated, newest first or between two times, with the pair, side, size and prices. Bitfinex allows only 3 of these a minute.

**Inputs**

- From (`start`, date and time): Only from this time on. Leave blank for the newest.
- To (`end`, date and time): Only up to this time. Leave blank for up to now.
- Most liquidations (`limit`, number): How many liquidation records to list, from 1 to 500. Defaults to 50. From 1 to 500. Default: `50`.
- Order (`order`, text): Newest first, or oldest first. One of: `newest` (Newest first), `oldest` (Oldest first). Default: `newest`.

**Outputs**

- `count` (number): How many rows are listed.
- `liquidations` (list): Each liquidation record: Bitfinex lists a position when liquidation is triggered and again when it is executed.
- `summary` (text): One readable sentence about the answer.

**Example output**

```json
{
  "count": 2,
  "liquidations": [
    {
      "amount": 1e-08,
      "base_price": 0.094586,
      "pair": "DOGE/USDT perpetual",
      "position_id": 194310216,
      "price_acquired": null,
      "side": "short",
      "sold_into_market": true,
      "stage": "triggered",
      "symbol": "tDOGEF0:USTF0",
      "time": "2026-10-01T00:26:45Z",
      "timestamp_ms": 1790814405426
    },
    {
      "amount": 1e-08,
      "base_price": 0.094586,
      "pair": "DOGE/USDT perpetual",
      "position_id": 194310216,
      "price_acquired": 0.0946135,
      "side": "short",
      "sold_into_market": false,
      "stage": "triggered",
      "symbol": "tDOGEF0:USTF0",
      "time": "2026-10-01T00:26:45Z",
      "timestamp_ms": 1790814405428
    }
  ],
  "summary": "2 liquidation records, from 2026-10-01T00:26:45Z to 2026-10-01T00:26:45Z."
}
```

### List prices

Get the price and last 24 hours of several trading pairs in one step, or of every pair, optionally biggest rise or biggest fall first, to find the day's movers.

**Inputs**

- Pairs (`pairs`, list): The trading pairs, e.g. BTC/USD and ETH/USD. Leave blank for every pair.
- Sort by (`sort`, text): Which pairs come first. One of: `pair`, `rise` (Biggest rise first), `fall` (Biggest fall first). Default: `pair`.
- Most pairs (`limit`, number): How many pairs to list, from 1 to 500, after sorting. Leave blank for all. From 1 to 500.

**Outputs**

- `count` (number): How many rows are listed.
- `missing_pairs` (list): Pairs asked for that Bitfinex doesn't trade.
- `summary` (text): One readable sentence about the answer.
- `tickers` (list): Each pair's ticker.

**Example output**

```json
{
  "count": 2,
  "missing_pairs": [],
  "summary": "Prices for 2 Bitfinex trading pairs. Best 24 hours: ETH/USD (-0.6056%); worst: BTC/USD (-1.2117%).",
  "tickers": [
    {
      "ask": 2249.3,
      "ask_size": 305.71781755,
      "base_currency": "ETH",
      "bid": 2248.6,
      "bid_size": 920.58969779,
      "change_24h": -13.7,
      "change_24h_percent": -0.6056,
      "first_trade_time": "2016-03-09T16:04:35Z",
      "high_24h": 2318.4,
      "last_price": 2248.4,
      "low_24h": 2238.1,
      "pair": "ETH/USD",
      "quote_currency": "USD",
      "spread": 0.7,
      "summary": "ETH/USD last traded at 2,248.4 USD, down 0.6056% over 24 hours (high 2,318.4, low 2,238.1, volume 9,663.27 ETH).",
      "symbol": "tETHUSD",
      "volume_24h": 9663.2726035
    },
    {
      "ask": 76966,
      "ask_size": 1.82340801,
      "base_currency": "BTC",
      "bid": 76949,
      "bid_size": 2.87805669,
      "change_24h": -944,
      "change_24h_percent": -1.2117,
      "first_trade_time": "2013-01-14T16:47:23Z",
      "high_24h": 78922,
      "last_price": 76965,
      "low_24h": 76701,
      "pair": "BTC/USD",
      "quote_currency": "USD",
      "spread": 17,
      "summary": "BTC/USD last traded at 76,965 USD, down 1.2117% over 24 hours (high 78,922, low 76,701, volume 419.2649 BTC).",
      "symbol": "tBTCUSD",
      "volume_24h": 419.2648803
    }
  ]
}
```

### List recent trades

List a trading pair's trades, newest first or between two times, each with its side, amount and price, and the amounts bought and sold with their average price.

**Inputs**

- Pair (`pair`, text, required): The trading pair, e.g. BTC/USD. Pick from the list, or type it as BTC/USD, btcusd or tBTCUSD.
- From (`start`, date and time): Only from this time on. Leave blank for the newest.
- To (`end`, date and time): Only up to this time. Leave blank for up to now.
- Most trades (`limit`, number): How many trades to list, from 1 to 10,000. Defaults to 50. From 1 to 10000. Default: `50`.
- Order (`order`, text): Newest first, or oldest first. One of: `newest` (Newest first), `oldest` (Oldest first). Default: `newest`.

**Outputs**

- `average_price` (number): The volume-weighted average price of these trades.
- `buy_volume` (number): How much was bought in these trades, in the base currency.
- `count` (number): How many rows are listed.
- `pair` (text): The pair as people write it, e.g. BTC/USD.
- `sell_volume` (number): How much was sold in these trades, in the base currency.
- `summary` (text): One readable sentence about the answer.
- `symbol` (text): Bitfinex's symbol for the pair, e.g. tBTCUSD.
- `trades` (list): The trades.

**Example output**

```json
{
  "average_price": 83609.67338059,
  "buy_volume": 0.00047841,
  "count": 3,
  "pair": "BTC/USD",
  "sell_volume": 0.00061782,
  "summary": "3 BTC/USD trades: 0.00047841 BTC bought and 0.00061782 BTC sold at an average 83,609.67 USD.",
  "symbol": "tBTCUSD",
  "trades": [
    {
      "amount": 0.00039782,
      "price": 83604,
      "side": "sell",
      "time": "2026-10-01T00:00:00Z",
      "timestamp_ms": 1790812800882,
      "trade_id": 1985618920,
      "value": 33.25934328
    },
    {
      "amount": 0.00022,
      "price": 83604,
      "side": "sell",
      "time": "2026-10-01T00:00:00Z",
      "timestamp_ms": 1790812800882,
      "trade_id": 1985618919,
      "value": 18.39288
    },
    {
      "amount": 0.00047841,
      "price": 83617,
      "side": "buy",
      "time": "2026-10-01T00:00:01Z",
      "timestamp_ms": 1790812801860,
      "trade_id": 1985618921,
      "value": 40.00320897
    }
  ]
}
```

### List trading pairs

List the pairs Bitfinex trades, with the smallest and largest order and whether each can be traded on margin, optionally only those with one currency.

**Inputs**

- With currency (`currency`, text): Only pairs that buy or sell this currency, e.g. BTC. Leave blank for every pair.

**Outputs**

- `count` (number): How many rows are listed.
- `pairs` (list): The trading pairs, by name.
- `summary` (text): One readable sentence about the answer.

**Example output**

```json
{
  "count": 5,
  "pairs": [
    {
      "base_currency": "BTC",
      "first_trade_time": "2021-10-01T11:45:31Z",
      "margin_trading": false,
      "max_order_size": 250.0,
      "min_order_size": 4e-05,
      "pair": "BTC/XAUT",
      "quote_currency": "XAUT",
      "symbol": "tBTC:XAUT"
    },
    {
      "base_currency": "ETH",
      "first_trade_time": "2021-10-01T12:02:40Z",
      "margin_trading": false,
      "max_order_size": 2500.0,
      "min_order_size": 0.0008,
      "pair": "ETH/XAUT",
      "quote_currency": "XAUT",
      "symbol": "tETH:XAUT"
    },
    {
      "base_currency": "XAUT",
      "first_trade_time": "2020-01-24T15:04:35Z",
      "margin_trading": true,
      "max_order_size": 400.0,
      "min_order_size": 0.002,
      "pair": "XAUT/BTC",
      "quote_currency": "BTC",
      "symbol": "tXAUT:BTC"
    },
    {
      "base_currency": "XAUT",
      "first_trade_time": "2020-01-24T14:35:07Z",
      "margin_trading": true,
      "max_order_size": 400.0,
      "min_order_size": 0.002,
      "pair": "XAUT/USD",
      "quote_currency": "USD",
      "symbol": "tXAUT:USD"
    },
    {
      "base_currency": "XAUT",
      "first_trade_time": "2020-01-25T09:45:45Z",
      "margin_trading": true,
      "max_order_size": 400.0,
      "min_order_size": 0.002,
      "pair": "XAUT/USDT",
      "quote_currency": "USDT",
      "symbol": "tXAUT:UST"
    }
  ],
  "summary": "Bitfinex trades 5 pairs with XAUT."
}
```
