Download the PHP package codenix-sv/bitfinex-api without Composer
On this page you can find all versions of the php package codenix-sv/bitfinex-api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download codenix-sv/bitfinex-api
More information about codenix-sv/bitfinex-api
Files in codenix-sv/bitfinex-api
Package bitfinex-api
Short Description PHP client for Bitfinex API
License MIT
Homepage https://github.com/codenix-sv/bitfinex-api
Informations about the package bitfinex-api
bitfinex-api
A simple PHP wrapper for Bitfinex API. Bitfinex The world's largest and most advanced cryptocurrency trading platform
Pay attention to the WebSocket client in PHP for the Bitfinex API
Requirements
- PHP >= 7.2
- ext-json
- Bitfinex, API key and API secret
Installation
The preferred way to install this extension is through composer.
Either run
or add
to the require section of your application's composer.json
file.
Basic usage
Example
Available methods
Public API
getPlatformStatus
Get the current status of the platform, “Operative” or “Maintenance” (1=operative, 0=maintenance). Maintenance periods generally last for a few minutes to a couple of hours and may be necessary from time to time during infrastructure upgrades.
getTickers
The tickers endpoint provides a high level overview of the state of the market. It shows the current best bid and ask, the last traded price, as well as information on the daily volume and price movement over the last day. The endpoint can retrieve multiple tickers with a single query.
getTicker
The ticker endpoint provides a high level overview of the state of the market for a specified pair. It shows the current best bid and ask, the last traded price, as well as information on the daily volume and price movement over the last day.
getTrades
The trades endpoint allows the retrieval of past public trades and includes details such as price, size, and time. Optional parameters can be used to limit the number of results; you can specify a start and end timestamp, a limit, and a sorting method.
getBook
The Public Books endpoint allows you to keep track of the state of Bitfinex order books on a price aggregated basis with
customizable precision. Raw books can be retrieved by using precision R0
.
getStats
The Stats endpoint provides various statistics on a specified trading pair or funding currency. Use the available keys to specify which statistic you wish to retrieve.
Use side
param only for non-funding queries.
getCandles
The Candles endpoint provides OCHL (Open, Close, High, Low) and volume data for the specified funding currency or trading pair. Funding period required only for funding candles.
getConfigs
Fetch currency and symbol site configuration data. A variety of types of config data can be fetched by constructing a path with an Action, Object, and conditionally a Detail value.
getStatus
Endpoint used to receive different types of platform information - currently supports derivatives pair status only.
getLiquidationFeed
Endpoint to retrieve liquidations. By default it will retrieve the most recent liquidations, but time-specific data can be retrieved using timestamps.
getLeaderboards
The leaderboards endpoint allows you to retrieve leaderboard standings for unrealized profit (period delta), unrealized profit (inception), volume, and realized profit.
Further Information
Please, check the Bitfinex site documentation for further information about API.
License
codenix-sv/bitfinex-api
is released under the MIT License. See the bundled LICENSE for details.