Bitfinex Websocket API
4 stars based on
63 reviews
Welcome to the Bitfinex api c developer documentation. This document should contain all the information required to properly implement applications using our API. If possible then we are strongly recommending using our tested libraries available on GitHub, rather than creating new ones.
However, if bitfinex api c decide to create your own implementation or to bitfinex api c existing one, then we encourage you to create Pull Request to our main repository with proposed changes, then we will able to include your code in our official repository for use by other users, effectively creating collaboration.
Encryption in CoinAPI is not optional. All communication to us is always encrypted using protocols that are considered best security practices. ISO currency code standard is used for fiat money identifications. Cryptocurrency assets are identified using codes used by the general public or adopted by the majority of exchanges. Numbers in our platform can have maximum 19 digits overall, but no more than 9 decimal places.
In bitfinex api c when number representing aggregate value then we allowing 38 digits overall, but still no more than 9 bitfinex api c places. Production endpoint, requires API key for authentication and providing real data: You can authorize by providing an additional parameter named apikey with a value equal to your API key in the query string of your HTTP request.
This will indicate to us that we can deliver compressed data to you which on your side should be decompressed transparently. Successful HTTP responses have the status code and the body in a format according to documentation of the requested bitfinex api c. All HTTP requests with response status codes different to must be considered as failed and you should expect additional JSON inside the body of the response with the error message encapsulated inside it as shown in the example.
We use the following error codes:. Each data point of this timeseries represents several indicators calculated from transactions activity inside a time range period. This section describes calls related to executed transactions bitfinex api c, also known as matched orders data or active data. If exchange has not reported who was aggressor side of transaction, we will classify who most probably was based on current market view. To get current last trade for all symbols, use Quotes current data as it includes last trade information.
Get latest trades from all symbols up to 1 minute ago or get latest trades from a specific bitfinex api c without time limitation. Latest data is always returned in time descending order.
This section describes calls related to quotes data, also known as quotes or passive level 1 data. Get latest quote updates up to 1 minute ago or get updates for a specific symbol without time limit. This section describes calls related to order book data, also known as books or passive level 2 data. Get bitfinex api c order book snapshots for a specific symbol within time range, returned in time ascending order. WebSocket endpoint bitfinex api c real-time market bitfinex api c streaming which works in Subscribe-Publish communication model.
After establishing a WebSocket connection with us, you will bitfinex api c to send a Hello message in accordance with this documentation. If everything is correct, we will provide you with a continuous stream of real-time market data updates. Another example of a hello message for subscription of all data types from all exchanges and symbols:. If your message will be incorrect, we will send you error message and disconnect connection afterwards.
Hello message can be repeated, each one will cause subscription scope override without interruption of your WebSocket connection. You need to be prepared to receive an error message from us when you send something wrong; all errors are permanent and you should expect that the underlying WebSocket connection will be closed by us after sending an error message.
If exchange has not bitfinex api c who the aggressor side of the transaction was, then we will classify who it most probably was based on current market view. A Book message is sent for each snapshot or update of the order book. After subscription to this data type is initialized, we immediately start delivering updates to the order book and at least one snapshot will be provided as soon as possible with the nearest update of the book.
Heartbeat message is sent to you every time there is one second of silence in communication between us, if you agreed on this feature in Hello message.
Financial Information eXchange FIX protocol is an electronic communications protocol bitfinex api c in for international real-time exchange of information related to the securities transactions and markets. If your FIX protocol implementation does not support establishing a connection over a secure channel, you must use a proxy between your client and our FIX gateway to unbundle encryption.
After successful authorization, server will respond with same message type and start delivering market data messages to you. Message sent by any side to bitfinex api c established session.
If received, should be sent back unchanged to confirm session termination. If exchange has not reported who the aggressor side of bitfinex api c transaction was, we will classify who it most probably was based on current bitfinex api c view.
There are 3 main interfaces bitfinex api c can be used to access CoinAPI: In repository you can find libraries or examples for languages or enviroments like: Asset codes ISO currency code standard is used for fiat money identifications. Numbers precision Numbers in our platform can have maximum 19 digits overall, but no more than 9 decimal places.
Time For all input and output time values ISO standard is used. Format specifier Description yyyy The year as a four-digit number. MM The month, from 01 through HH The hour, using bitfinex api c hour clock from 00 to Input time values are parsed using the following formats bitfinex api c far as possible: Endpoints Production endpoint, requires API key for authentication and providing real data: There are 2 methods for passing the Bitfinex api c key to us, you only need to use one: We use the following error codes: X-RateLimit-Remaining int The number of requests left for the time window.
Superset of the ISO currency codes standard. List all symbols curl https: List all periods curl https: Latest data curl bitfinex api c Current data curl https: Endpoint Production endpoint, requires API bitfinex api c for authentication and providing real data: Bitfinex api c preferences Heartbeat and subscription details API key for authorization If your message will be incorrect, we will send you error message and disconnect connection afterwards.
Data type Description trade Executed transactions feed order book matches quote Quote updates feed order book level 1 book Order book snapshots and updates feed order book level 2, full order book snapshot and real-time updates book5 Order book snapshots feed order book level 2, 5 best levels from each side of book book20 Order book snapshots feed order book level 2, 20 best levels from each bitfinex api c of book book50 Order book snapshots feed order book level 2, 50 best levels from each side of book Error handling Example JSON error message is structured like this: If true then all bid and ask levels are listed, otherwise only changed since the last message.
FIX API General Financial Information eXchange FIX protocol is an electronic communications protocol initiated in for international real-time exchange of information related to the securities transactions and markets.
Endpoint FIX client configuration file: Parameter Value Hostname fix. Always the last field in bitfinex api c message, i. Stateful API providing streaming of realtime market data, widely adopted by the finance industry. Output data format optional, default value is jsonpossible values are jsonxml or csv.
Ignore header line in CSV output? Encapsulate strings with quotes in CSV output? Comma delimited list of column names to ignore in CSV output optional, by default all columns are included. Character that will be used as column delimiter in CSV output optional, default value is. Character that will be used as decimal separator in CSV output optional, default value is. New line type optional, default value is unixpossible values winmacunix.
Boolean value; true for cryptocurrency assets, false otherwise. Comma or semicolon delimited parts of symbol identifier used to filter response. Type of symbol possible values are: FX Spot derivative contract where traders agree to trade right to require buy or sell of fx spot at agreed price on exercise date. Boolean value representing option type. Requested exchange rate base asset identifier. Full list available here. Requested exchange rate quote asset identifier.
Time at which exchange rate is calculated optional, if not supplied then current rate is returned. Requested exchange rates base asset identifier. Symbol identifier of requested timeseries full list available here.
Identifier of requested timeseries period required, e. Include items with no activity? Amount of items to return optional, mininum is 1, maximum isdefault value isif the parameter is used then every output items are counted bitfinex api c one request. Timeseries ending time in Bitfinex api c optional, if not supplied then the bitfinex api c is returned to the end or when count of result elements reaches the limit.
Symbol identifier for requested timeseries full list available here. Timeseries ending time in ISO optional, bitfinex api c not supplied then the data is returned to the end or when result elements count reaches the limit. Timeseries ending time in ISO optional, if not supplied then the data is returned to the end or when result elements reaches count the limit. List of data types you want to receive required, possible values listed in table below.
Filter data to symbols whose identifiers match at least one of the listed prefixes optional, if not provided then stream will not filtered by symbols. Filter data to symbols which are related to the at least one of the listed asset identifiers optional, if not provided then stream will not be filtered by assets. Order book snapshots and updates feed order book level 2, full bitfinex api c book snapshot and real-time updates.
