Foxbit API (WebSocket)
Pacote NPM de acesso via WebSocket para a API da exchange brasileira Foxbit.
Autor: Miguel Medeiros [Site] [Youtube] [Twitter]
Exchange: [Foxbit]
Documentação da API: [Site da Foxbit] [PDF da Alphapoint]
Gostou do trabalho? Então me pague um café!
Carteira BTC: 1NM76h5SvdhTdmS8dksGwWpHNbnVngWczR
Esse pacote foi desenvolvido para uso próprio.
Portanto, não é um pacote oficial da Foxbit.
USE POR SUA CONTA E RISCO!
Readme Index
- Instalação
- Configuração
- Funções
- Funções Públicas
- Connect: Conecta na API via WebSocket.
- LogOut: Finaliza conexão com o WebSocket.
- GetInstrument: Retorna as informações par de moedas por ID.
- GetInstruments: Retorna um array de pares de moedas cadastrados.
- GetOpenOrders: Retorna as ordens abertas no livro de ordens.
- GetProduct: Retorna a moeda cadastrado por ID.
- GetProducts: Retorna as moedas cadastradas.
- GetL2Snapshot: Retorna um spanshot do Orderbook.
- GetTickerHistory: Retorna um histórico de Tickers.
- SubscribeTicker: Se inscreve para receber Tickers atualizados.
- SubscribeTrades: Se inscreve para receber Trades atualizadas.
- UnsubscribeTicker: Se desinscreve do Ticker.
- UnsubscribeTrades: Se desinscreve das Trades.
- Funções Privadas
- GetUserConfig: Retorna configurações definidas pelo usuário.
- GetUserInfo: Retorna os dados das informações de Usuário.
- GetUserPermissions: Retorna permissões do usuário solicitante.
- GetOrdersHistory: Retorna um array com o histórico de ordens.
- SendOrder: Envia Ordem de Compra/Venda.
- CancelAllOrders: Cancela todas as ordens abertas.
- CancelOrder: Cancela ordem que ainda não foi executada.
- GetAccountInfo: Retorna informação sobre a conta do usuário logado.
- GetAccountPositions: Retorna um array com o balanço do usuário.
- GetAccountTrades: Retorna um array com o histórico do ordens executadas do usuário.
- GetAccountTransactions: Retorna um array com o histórico de transações abertas do usuário.
- Funções Públicas
- Contribua com Código
- License
Instalação
Você precisa importar o pacote para seu projeto:
npm i foxbit-api --save
Configuração
// importar foxbit api packageconst foxbit = ;
Funções
Segue a lista de funções para se conectar com o WebSocket da API da Foxbit.
Funções Públicas
Não é necessária de credenciais para acessar os métodos públicos.
Connect
Conecta na API via WebSocket.
Link Documentação
// Variáveis das suas credenciais// Necessárias somente para métodos privados.let user = "";let password = ""; // Dispara chamada para conectar com o WebSocket.foxbit; // Evento disparado quando o WebSocket foi conectado.foxbiteventEmitter;
Logout
Finaliza conexão com o WebSocket.
Link Documentação
// Evento disparado quando o WebSocket foi conectado.foxbiteventEmitter; // Evento disparado quando o LogOut foi efetuado.foxbiteventEmitter;
GetInstrument
Retorna as informações par de moedas por ID.
Link Documentação
// Evento disparado quando o WebSocket foi conectado.foxbiteventEmitter; // Evento disparado quando o GetInstrument foi efetuado.foxbiteventEmitter;
GetInstruments
Retorna um array de pares de moedas cadastrados.
Link Documentação
// Evento disparado quando o WebSocket foi conectado.foxbiteventEmitter; // Evento disparado quando o GetInstruments foi efetuado.foxbiteventEmitter;
GetOpenOrders
Retorna as ordens abertas no livro de ordens.
Link Documentação
// Evento disparado quando o WebSocket foi conectado.foxbiteventEmitter; // Evento disparado quando o GetProducts foi efetuado.foxbiteventEmitter;
GetProduct
Retorna a moeda cadastrado por ID.
Link Documentação
// Evento disparado quando o WebSocket foi conectado.foxbiteventEmitter; // Evento disparado quando o GetProduct foi efetuado.foxbiteventEmitter;
GetProducts
Retorna as moedas cadastradas.
Link Documentação
// Evento disparado quando o WebSocket foi conectado.foxbiteventEmitter; // Evento disparado quando o GetProducts foi efetuado.foxbiteventEmitter;
GetL2Snapshot
Retorna um spanshot do Orderbook.
Link Documentação
// Evento disparado quando o WebSocket foi conectado.foxbiteventEmitter; // Evento disparado quando o GetL2Snapshot foi efetuado.foxbiteventEmitter;
GetTickerHistory
Retorna um histórico de Tickers.
Link Documentação
// Evento disparado quando o WebSocket foi conectado.foxbiteventEmitter; // Evento disparado quando o GetTickerHistory foi efetuado.foxbiteventEmitter;
SubscribeTicker
Se inscreve para receber Tickers atualizados.
Link Documentação
// Evento disparado quando o WebSocket foi conectado.foxbiteventEmitter; // Evento disparado quando o SubscribeTicker foi efetuado.foxbiteventEmitter; // Evento disparado quando o Ticker é atualizado.foxbiteventEmitter;
SubscribeTrades
Se inscreve para receber Trades atualizadas.
// Evento disparado quando o WebSocket foi conectado.foxbiteventEmitter; // Evento disparado quando o SubscribeTrades foi efetuado.foxbiteventEmitter; // Evento disparado quando alguma Trade foi efetuada.foxbiteventEmitter;
UnsubscribeTicker
Se desinscreve do Ticker.
Link Documentação
// Evento disparado quando o WebSocket foi conectado.foxbiteventEmitter; // Evento disparado quando o UnsubscribeTicker foi efetuado.foxbiteventEmitter;
UnsubscribeTrades
Se desinscreve das Trades.
// Evento disparado quando o WebSocket foi conectado.foxbiteventEmitter; // Evento disparado quando o UnsubscribeTrades foi efetuado.foxbiteventEmitter;
Funções Privadas
Ao se conectar é necessário usar credenciais (usuário e senha) para acessar os métodos privados.
GetUserInfo
Retorna os dados das informações de Usuário.
Link Documentação
// Evento disparado quando o WebSocket foi conectado.foxbiteventEmitter; // Evento disparado quando o GetUserInfo foi efetuado.foxbiteventEmitter;
GetUserConfig
Retorna configurações definidas pelo usuário.
Link Documentação
// Evento disparado quando o WebSocket foi conectado// e recebeu as informações do usuário.foxbiteventEmitter; // Evento disparado quando o GetUserConfig foi efetuado.foxbiteventEmitter;
GetUserPermissions
Retorna permissões do usuário solicitante.
Link Documentação
// Evento disparado quando o WebSocket foi conectado// e recebeu as informações do usuário.foxbiteventEmitter; // Evento disparado quando o GetUserPermissions foi efetuado.foxbiteventEmitter;
GetOrdersHistory
Retorna um array com o histórico de ordens.
// Evento disparado quando o WebSocket foi conectado// e recebeu as informações do usuário.foxbiteventEmitter; // Evento disparado quando o GetOrdersHistory foi efetuado.foxbiteventEmitter;
SendOrder
Envia Ordem de Compra/Venda.
Link Documentação
// Evento disparado quando o WebSocket foi conectado// e recebeu as informações do usuário.foxbiteventEmitter; // Evento disparado quando o SendOrder foi efetuado.foxbiteventEmitter;
CancelAllOrders
Cancela todas as ordens abertas.
Link Documentação
// Evento disparado quando o WebSocket foi conectado// e recebeu as informações do usuário.foxbiteventEmitter; // Evento disparado quando o CancelAllOrders foi efetuado.foxbiteventEmitter;
CancelOrder
Cancela ordem que ainda não foi executada.
Link Documentação
// Evento disparado quando o WebSocket foi conectado// e recebeu as informações do usuário.foxbiteventEmitter; // Evento disparado quando o CancelOrder foi efetuado.foxbiteventEmitter;
GetAccountInfo
Retorna informação sobre a conta do usuário logado.
Link Documentação
// Evento disparado quando o WebSocket foi conectado// e recebeu as informações do usuário.foxbiteventEmitter; // Evento disparado quando o GetAccountInfo foi efetuado.foxbiteventEmitter;
GetAccountPositions
Retorna um array com o balanço do usuário.
Link Documentação
// Evento disparado quando o WebSocket foi conectado// e recebeu as informações do usuário.foxbiteventEmitter; // Evento disparado quando o GetAccountPositions foi efetuado.foxbiteventEmitter;
GetAccountTrades
Retorna um array com o histórico do ordens executadas do usuário.
Link Documentação
// Evento disparado quando o WebSocket foi conectado// e recebeu as informações do usuário.foxbiteventEmitter; // Evento disparado quando o GetAccountTrades foi efetuado.foxbiteventEmitter;
GetAccountTransactions
Retorna um array com o histórico de transações abertas do usuário.
Link Documentação
// Evento disparado quando o WebSocket foi conectado// e recebeu as informações do usuário.foxbiteventEmitter; // Evento disparado quando o GetAccountTransactions foi efetuado.foxbiteventEmitter;
Contribua com Código
Ainda faltam algumas chamadas para completar a API como um todo. Vou adorar se você quiser contribuir para deixar esse pacote mais completo! Sinta-se à vontade em fazer um 'pull request'! Afinal esse repositório é aberto! <3