Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs.md #1

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update docs.md #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion docs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,10 +32,17 @@ Current Trading data API rate limit is 100 rpm per IP. If you need a higher limi
#### Params

- `symbol` _required_ - symbol for which OHLC should be returned. NOTE: `symbol` should be urlsafe encoded.
**NOTE:
`base_currencycode`+`base_issuer`/`second_currencycode`+`second_issuer`
1) if currncycode = XRP, then you do not need issuer
2) you must change `+` and `/` to `%2B` and `%2F`
so you finaly symbol will: USD`%2B`rD9W7ULveavz8qBGM1R5jMgK2QKsEDPQVi`%2F`XRP

- `period` _required_ - one of `["1m","3m","5m","15m","30m","1h","3h","6h","12h","1d","3d","1w"]`
- `from` _required_ - unix timestamp of OHLC start
- `to` _required_ - unix timestamp of OHLC end

**NOTE: API work with UTC time. `start date = 1970/01/01`, time must be in seconds - `14.09.2022 11:30:15 = 1663155015 sec`
how to count: `(date - start_date).TotalSeconds`
**NOTE: API has limitation of 2000 points per request**

It means that you can request 2000 of 1m points (2000/60/24) ~1.3 days. Or 2000 of 1h points ~83.3 days etc.
Expand Down