josehenriqueventura / binance-to-google-sheets

Google Spreadsheets add-on to get data directly from Binance API without any intermediaries! :rocket:

Binance to Google Sheets!

A lightweight Google Spreadsheets Add-On to GET data directly from Binance API without any intermediaries!

This add-on is basically an API client specially hand-crafted to work between Google Spreadsheets and Binance.
By using the BINANCE() formula in your spreadsheet, you can get data fetched from Binance API like:

• Current crypto prices
• 24h stats
• All current open orders
• Latest done/finished orders
• Historical orders table
• Account general info
• Last update time
• ..and many more to come!

At first glance, NO Binance API key is needed to call public endpoints like current crypto prices and 24h stats.
It only requires a Binance API key for account info and open/done/table orders lists, but a READ-ONLY API key is enough for everything to work.
In deed, I personally recommend to generate a READ-ONLY API key at Binance site here.
It does NOT need write/trade access in ANY way to properly work with all its features, so don't give extra permissions if they aren't needed!

I think and hope that many of you will find it as useful as it is for myself.
Enjoy, cheers! 🍻

How can I use it in my Google Spreadsheets?

First of all, open your desired Google Spreadsheet and configure it properly:

1. Go to File -> Spreadsheet settings.
2. Under the Calculation tab set the Recalculation combobox to On change and every minute.
3. Hit Save settings button and that's it!

The quick'n easy way for everybody

Just download the latest BINANCE.gs all-in-one file and copy & paste its contents following these steps:

1. With your desired Google Spreadsheet opened, go to Tools -> Script editor.
   • It should open a new page with a Code.gs file containing an empty function.
2. Remove any contents from Code.gs and paste the contents from the downloaded BINANCE.gs file.
3. Save the project at File -> Save. Give any name you want.
4. Refresh/reload your Google Spreadsheet (hit F5) and voila!

If you are a developer =]

You will need node and clasp in order to apply the add-on to your Google Spreadsheets.

1. Install node and clasp following their simple setup guides.
2. Clone the repo and login to your Google account with clasp by running: clasp login.
3. Get the Script ID for your desired Google Spreadsheet.
   1. With your Google Spreadsheet open, go to Tools -> Script editor.
   2. At the Google Script screen, go to File -> Project properties.
   3. The needed ID is the one under the Script ID label!
4. Just for the first time, run the target make setup SCRIPT_ID=my-script-id replacing my-script-id with the ID obtained at point 3.
   • It should create the file .clasp.json with your scriptId inside for future use.
   • NOTE: You only need to re-run this step if you want to change the configured scriptId.
5. Now you can run make push (or just make alone) to upload/apply local code to your desired Google Spreadsheet!
   • From now on, you can just run make to keep applying changes to the same configured spreadsheet.
   • TIP: You can run make update to pull latest changes from this repo and push them to your configured spreadsheet.
6. Refresh/reload your Google Spreadsheet (hit F5) and voila!

Windows users: You can download and use make from here or even the entire GnuWin toolset.

Binance API Key

Only needed if you also want to have account info, open/pending, done/finished and historical orders listing working in your spreadsheet.
To get your keys, go to Binance API panel and create a new one:

1. Enter a label like Binance to Google Sheets and click the Create button.
2. Take note for both API Key and Secret Key values.
3. Click the Edit restrictions button.
   1. Under API restrictions ONLY Can Read checkbox should be checked.
   2. Under IP access restrictions select Unrestricted.
4. Click the Save button and now you have to configure them on your spreadsheet!

Once you have the add-on already installed/enabled on your desired Google Spreadsheet, the main menu item Binance should have appeared at the rightmost position.

1. At spreadsheet's main menu, go to Binance -> Setup API Keys.
2. Set your API Key and click OK. Do the same for API Secret Key.
3. Voila, you are ready to go!

NOTE: You can remove or re-configure them at any time from the Binance main menu item in your spreadsheet.

OK, I have it installed! How do I use it at my spreadsheet?

NOTE: Check the Examples sheet in the live DEMO spreadsheet for more details.

You just need to call the =BINANCE() formula in a cell!
Some operations are public, meaning that you don't need a Binance API key to call them.
Some operations are private, meaning that they do require a Binance API key to call them.

So far, these are the available operations:

Operation: "version" (public)

=BINANCE("version") will return the current Binance to Google Sheets version you are running.

• Be sure to check the latest release and update yours if needed.

Operation: "last_update" (public)

=BINANCE("last_update") will return the timestamp of the last request/response from Binance API.

• The timestamp is updated every time we get a valid response from Binance API (status 200, no matter what operation triggered it).

Operation: "prices" (public)

=BINANCE("prices") will return a list with the latest prices from Binance.

• =BINANCE("prices", "BTC") Optionally you can give a symbol to just return its price (against USDT by default).
• =BINANCE("prices", "BNB", "BTC") Optionally you can give a ticker to compare against and to just return its price.
• =BINANCE("prices", A1:A3) Optionally you can give a ticker range to return a list of symbols and prices.
  • Values must be simple symbols like A1="BTC", A2="ETH" and A3="LTC".
• =BINANCE("prices", A1:A3, "headers: false") Optionally you can give more options like not returning table headers.
• =BINANCE("prices", A1:A3, "ticker: BNB, prices: true") Optionally you can return only the prices (and give a ticker in the meantime).

Operation: "stats/24h" (public)

=BINANCE("stats/24h", A1:A3) will return a list with the 24hs stats for given symbols from Binance.

• A single value like "BTC" or a range of values is required. Values must be simple symbols like A1="BTC", A2="ETH" and A3="LTC".
• =BINANCE("stats/24h", A1:A3, "BTC") Optionally you can give a ticker to match against (defaults to USDT).
• =BINANCE("stats/24h", A1:A3, "ticker: BTC, headers: false") Optionally you can give more options like not returning table headers.

Operation: "orders/open" (private)

=BINANCE("orders/open") will return a list with all your open/pending orders from Binance.

• =BINANCE("orders/open", "BTCUSDT") Optionally you can give a full ticker to filter the results.
• =BINANCE("orders/open", "BTCUSDT", "headers: false") Optionally you can give more options like not returning table headers.

Operation: "orders/done" (private)

=BINANCE("orders/done", A1:A3) will return a list with your latest (10 by default) done/finished orders for given symbols from Binance.

• A single value like "BTC" or a range of values is required. Values must be simple symbols like A1="BTC", A2="ETH" and A3="LTC".
• =BINANCE("orders/done", A1:A3, "BTC") Optionally you can give a ticker to match against (defaults to USDT).
• =BINANCE("orders/done", A1:A3, "ticker: BTC, headers: false, max: 100") Optionally you can give more options like not returning table headers and fetching latest 100 orders per given symbol.
• Values for max allowed between 1 and 1000 (defaults to 10).

Operation: "orders/table" (private)

=BINANCE("orders/table", MySheet!A1:A3) will transform the current sheet into a "table" in where ALL historic done/finished orders will be periodically polled and stored for each given symbol from Binance.

• This formula must always be placed at A1 in any new blank sheet into your spreadsheet.
• A single value like "BTC" or a range of values is required. Values must be simple symbols like MySheet!A1="BTC", MySheet!A2="ETH" and MySheet!A3="LTC".
• Be patient! It will adjust sheet's cols/rows and initialize a table header for you.
• Do NOT alter the table data by hand! It will poll for data every 10 minutes automatically.
• =BINANCE("orders/table", MySheet!A1:A3, "BTC") Optionally you can give a ticker to match against (defaults to USDT).

NOTE: You can have multiple sheets with this formula on. They will be all polled every 10 minutes, but take into account that if you have too much sheets to update, it could become really slow and even unresponsive.
Google Spreadsheets has a very poor performance for adding rows to a sheet, so that's why each poll session is limited to 100 items only.
If you have many assets and/or orders to fetch, it's recommended to have only 1 or 2 sheets at most, with a range that contains all your asset's symbols.

Operation: "account" (private)

=BINANCE("account") will return general account stats from Binance.

• =BINANCE("account", "", "headers: false") Optionally you can give more options like not returning table headers.

See it working live!

A spreadsheet example using the BINANCE() formula:
https://docs.google.com/spreadsheets/d/1AcOcPFsncrDB_ve3wWMHwfiFql6A4hmG1sFc01LLTDg

Some background: Why this tool had ever to come alive?!

I needed a way to have Binance data directly available at my Google Spreadsheet.
First, I've looked for several existing solutions, but none provided me the freedom, confidence and privacy that I want for this kind of delicate stuff.
It's a requirement for me that requests to Binance go directly from my spreadsheet to its API without any intermediary service in between (most than Google itself in where the spreadsheet resides, of course).
So I decided to write my own code, all from scratch, with only my will and my javascript knownledge aboard..
..and I was so happy with the results that I simply decided to share it to the world! 🎉

Disclaimer

I'm just a guy that uses both services and wanted to have Binance data available at my personal Google Spreadsheet.
I did it for myself and I liked it so much, that I decided to share it so anyone can use it!

The script only needs READ access keys to Binance API, so there is no security concerns about what the script is able to do at Binance in your behalf.
It will just retrieve useful Binance data for your enjoyment in your spreadsheets. =]

I'm not responsible for your private usage of this tool, although it will never cause you any problems!
Therefore, you will agree upon your own fully responsibility at the very moment you start using this tool.

NOTE: If you have any concerns, please feel free to open a ticket in the issues section or email me.

Privacy Policy

No personal data collect and/or usage is done in any way, that's why this add-on doesn't require any "controversial" permission from your side.
The only sensitive scopes according to Google are:

• script.external_request :: Needed to fetch data from Binance API into the spreadsheet (GET requests only).
• script.scriptapp :: Needed to install and run 3 triggers to keep data updated in the spreadsheet (every 1, 5 and 10 minutes).

NOTE: This is an open-source project, so you will always be available to keep and eye to the code and audit it.
If you have any concerns, please feel free to open a ticket in the issues section or email me.

Terms of Service

This is not a service. There is no contract nor obligations between the code/myself and you.
The only commitment on my behalf is regarding to no personal data usage in any way.

Only you decide when and how to use this tool. You can remove the add-on anytime like any other add-on.
You may also remove your Binance API key anytime and just use the public endpoints.

Requests to Binance API from your spreadsheets are made from your Google account on your behalf.
No other service acts as an intermediary between your Google spreadsheet and Binance!

NOTE: If you have any concerns, please feel free to open a ticket in the issues section or email me.

Binance Account - Get 5% discount on fees!

Don't you have a Binance account yet?
Register using the referal link below and get a 5% discount on fees for all your trades!

https://www.binance.com/en/register?ref=NJE1D9CS

Enjoy - Donate - Buy me a beer! =]

Thank you for using Binance to Google Sheets add-on!
I really hope you enjoyed and loved it as much as I love to use it everyday.

If your love is strong enough, feel free to share it with me! =D
I will much appreciate any contribution and support to keep working on it.

I have plenty of ideas for new features and improvements.
So far, this is just the first acceptable release, but much more could come..!

---

[BTC] Bitcoin donate address	[ETH] Ethereum donate address	[LTC] Litecoin donate address	[BNB] Binance Coin donate address
1FsN54WNibhhPhRt4vnAPRGgzaVeeFvEnM	0x1d047bc3e46ce0351fd0c44fc2a2029512e87a97	LZ8URuChzyuuy272isMCrts7R7UKtwnj6a	0x1d047bc3e46ce0351fd0c44fc2a2029512e87a97

---

This software was published and released under the GPL-3.0 License.

Use it wisely, happy trading!
Diego.