-
-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1 from vansergen/public
PublicClient1
- Loading branch information
Showing
14 changed files
with
4,242 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
{ | ||
"extends": [ | ||
"eslint:recommended", | ||
"plugin:@typescript-eslint/eslint-recommended", | ||
"plugin:@typescript-eslint/recommended" | ||
], | ||
"overrides": [ | ||
{ | ||
"files": ["*.js"], | ||
"rules": { | ||
"@typescript-eslint/no-var-requires": "off" | ||
} | ||
}, | ||
{ | ||
"files": ["./build/index.js"], | ||
"rules": { | ||
"no-prototype-builtins": "off" | ||
} | ||
} | ||
], | ||
"env": { | ||
"node": true, | ||
"es2020": true | ||
}, | ||
"parser": "@typescript-eslint/parser", | ||
"parserOptions": { | ||
"sourceType": "module" | ||
}, | ||
"plugins": ["@typescript-eslint"], | ||
"rules": { | ||
"curly": "error", | ||
"eqeqeq": "error", | ||
"linebreak-style": "error", | ||
"quotes": "error", | ||
"prefer-destructuring": "error", | ||
"semi": "error", | ||
"@typescript-eslint/camelcase": "off", | ||
"no-console": ["error"] | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
custom: https://commerce.coinbase.com/checkout/221a3057-e35f-4559-97e4-af020145df62 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
--- | ||
name: Bug report | ||
about: Create a report to help us improve | ||
title: "[BUG]" | ||
labels: bug | ||
assignees: vansergen | ||
--- | ||
|
||
**Describe the bug** | ||
A clear and concise description of what the bug is. | ||
|
||
**To Reproduce** | ||
Steps to reproduce the behavior (add some code): | ||
|
||
```typescript | ||
import * as Bitfinex from "bitfinex-node-api"; | ||
// more code | ||
``` | ||
|
||
**Expected behavior** | ||
A clear and concise description of what you expected to happen. | ||
|
||
**Please complete the following information:** | ||
|
||
- Node.js version: [e.g. 8.1.0] | ||
- NPM version: [e.g. 5.1.2] | ||
- Version [e.g. 0.4.0] | ||
|
||
**Additional context** | ||
Add any other context about the problem here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
--- | ||
name: Feature request | ||
about: Suggest an idea for this project | ||
title: "[FEATURE-REQUEST]" | ||
labels: enhancement | ||
assignees: vansergen | ||
--- | ||
|
||
**Is your feature request related to a problem? Please describe.** | ||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] | ||
|
||
**Describe the solution you'd like** | ||
A clear and concise description of what you want to happen. | ||
|
||
**Describe alternatives you've considered** | ||
A clear and concise description of any alternative solutions or features you've considered. | ||
|
||
**Additional context** | ||
Add any other context or screenshots about the feature request here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
language: node_js | ||
node_js: | ||
- 8 | ||
- 9 | ||
- 10 | ||
- 11 | ||
- 12 | ||
- 13 | ||
script: | ||
- npm run prettier | ||
- npm run lint | ||
- npm test |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
# Changelog | ||
|
||
## [1.0.0] - 2019-11-28 | ||
|
||
### Added | ||
|
||
- `PublicClient1` methods: | ||
- `getTicker` | ||
- `getStats` | ||
- `getFundingBook` | ||
- `getOrderBook` | ||
- `getTrades` | ||
- `getLends` | ||
- `getSymbols` | ||
- `getSymbolDetails` | ||
|
||
[1.0.0]: https://github.com/vansergen/bitfinex-node-api/releases/tag/v1.0.0 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,76 @@ | ||
# Contributor Covenant Code of Conduct | ||
|
||
## Our Pledge | ||
|
||
In the interest of fostering an open and welcoming environment, we as | ||
contributors and maintainers pledge to making participation in our project and | ||
our community a harassment-free experience for everyone, regardless of age, body | ||
size, disability, ethnicity, sex characteristics, gender identity and expression, | ||
level of experience, education, socio-economic status, nationality, personal | ||
appearance, race, religion, or sexual identity and orientation. | ||
|
||
## Our Standards | ||
|
||
Examples of behavior that contributes to creating a positive environment | ||
include: | ||
|
||
- Using welcoming and inclusive language | ||
- Being respectful of differing viewpoints and experiences | ||
- Gracefully accepting constructive criticism | ||
- Focusing on what is best for the community | ||
- Showing empathy towards other community members | ||
|
||
Examples of unacceptable behavior by participants include: | ||
|
||
- The use of sexualized language or imagery and unwelcome sexual attention or | ||
advances | ||
- Trolling, insulting/derogatory comments, and personal or political attacks | ||
- Public or private harassment | ||
- Publishing others' private information, such as a physical or electronic | ||
address, without explicit permission | ||
- Other conduct which could reasonably be considered inappropriate in a | ||
professional setting | ||
|
||
## Our Responsibilities | ||
|
||
Project maintainers are responsible for clarifying the standards of acceptable | ||
behavior and are expected to take appropriate and fair corrective action in | ||
response to any instances of unacceptable behavior. | ||
|
||
Project maintainers have the right and responsibility to remove, edit, or | ||
reject comments, commits, code, wiki edits, issues, and other contributions | ||
that are not aligned to this Code of Conduct, or to ban temporarily or | ||
permanently any contributor for other behaviors that they deem inappropriate, | ||
threatening, offensive, or harmful. | ||
|
||
## Scope | ||
|
||
This Code of Conduct applies both within project spaces and in public spaces | ||
when an individual is representing the project or its community. Examples of | ||
representing a project or community include using an official project e-mail | ||
address, posting via an official social media account, or acting as an appointed | ||
representative at an online or offline event. Representation of a project may be | ||
further defined and clarified by project maintainers. | ||
|
||
## Enforcement | ||
|
||
Instances of abusive, harassing, or otherwise unacceptable behavior may be | ||
reported by contacting the project team at sergey.bakulin.github@gmail.com. All | ||
complaints will be reviewed and investigated and will result in a response that | ||
is deemed necessary and appropriate to the circumstances. The project team is | ||
obligated to maintain confidentiality with regard to the reporter of an incident. | ||
Further details of specific enforcement policies may be posted separately. | ||
|
||
Project maintainers who do not follow or enforce the Code of Conduct in good | ||
faith may face temporary or permanent repercussions as determined by other | ||
members of the project's leadership. | ||
|
||
## Attribution | ||
|
||
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, | ||
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html | ||
|
||
[homepage]: https://www.contributor-covenant.org | ||
|
||
For answers to common questions about this code of conduct, see | ||
https://www.contributor-covenant.org/faq |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,86 @@ | ||
# bitfinex-node-api | ||
# bitfinex-node-api [![Build Status](https://travis-ci.com/vansergen/bitfinex-node-api.svg?branch=master)](https://travis-ci.com/vansergen/bitfinex-node-api) [![GitHub version](https://badge.fury.io/gh/vansergen%2Fbitfinex-node-api.svg)](https://github.com/vansergen/bitfinex-node-api) ![node](https://img.shields.io/node/v/bitfinex-node-api) ![NPM](https://img.shields.io/npm/l/bitfinex-node-api) ![npm](https://img.shields.io/npm/dt/bitfinex-node-api) ![GitHub top language](https://img.shields.io/github/languages/top/vansergen/bitfinex-node-api) | ||
|
||
Bitfinex Node.js library | ||
|
||
## Installation | ||
|
||
```bash | ||
npm install bitfinex-node-api | ||
``` | ||
|
||
## Usage | ||
|
||
### PublicClient1 | ||
|
||
```typescript | ||
import { PublicClient1 } from "bitfinex-node-api"; | ||
const client = new PublicClient1(); | ||
``` | ||
|
||
- [`getTicker`](https://docs.bitfinex.com/v1/reference#rest-public-ticker) | ||
|
||
```typescript | ||
const symbol = "btcusd"; | ||
const ticker = await client.getTicker({ symbol }); | ||
``` | ||
|
||
- [`getStats`](https://docs.bitfinex.com/v1/reference#rest-public-stats) | ||
|
||
```typescript | ||
const symbol = "btcusd"; | ||
const stats = await client.getStats({ symbol }); | ||
``` | ||
|
||
- [`getFundingBook`](https://docs.bitfinex.com/v1/reference#rest-public-fundingbook) | ||
|
||
```typescript | ||
const currency = "usd"; | ||
const limit_bids = 10; | ||
const limit_asks = 5; | ||
const book = await client.getFundingBook({ currency, limit_bids, limit_asks }); | ||
``` | ||
|
||
- [`getOrderBook`](https://docs.bitfinex.com/v1/reference#rest-public-orderbook) | ||
|
||
```typescript | ||
const symbol = "btcusd"; | ||
const limit_bids = 20; | ||
const limit_asks = 10; | ||
const group = 1; | ||
const book = await client.getOrderBook({ | ||
symbol, | ||
limit_bids, | ||
limit_asks, | ||
group | ||
}); | ||
``` | ||
|
||
- [`getTrades`](https://docs.bitfinex.com/v1/reference#rest-public-trades) | ||
|
||
```typescript | ||
const symbol = "btcusd"; | ||
const timestamp = 1444266681; | ||
const limit_trades = 10; | ||
const trades = await client.getTrades({ symbol, timestamp, limit_trades }); | ||
``` | ||
|
||
- [`getLends`](https://docs.bitfinex.com/v1/reference#rest-public-lends) | ||
|
||
```typescript | ||
const currency = "usd"; | ||
const timestamp = 1444266681; | ||
const limit_lends = 10; | ||
const lends = await client.getLends({ currency, timestamp, limit_lends }); | ||
``` | ||
|
||
- [`getSymbols`](https://docs.bitfinex.com/v1/reference#rest-public-symbols) | ||
|
||
```typescript | ||
const symbols = await client.getSymbols(); | ||
``` | ||
|
||
- [`getSymbolDetails`](https://docs.bitfinex.com/v1/reference#rest-public-symbol-details) | ||
|
||
```typescript | ||
const symbolDetails = await client.getSymbolDetails(); | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
export * from "./src/public1"; |
Oops, something went wrong.