55## 🎯 Overview
66
77This Google Sheets add-on brings live commodity prices to your spreadsheets:
8+
89- ** Custom Functions** : ` =OILPRICE("BRENT_CRUDE_USD") `
910- ** Sidebar UI** : Fetch and manage prices easily
1011- ** Auto-Convert** : Standardize all prices to $/MMBtu
@@ -13,13 +14,15 @@ This Google Sheets add-on brings live commodity prices to your spreadsheets:
1314## 📦 Features
1415
1516### Custom Functions
17+
1618``` javascript
1719= OILPRICE (" BRENT_CRUDE_USD" ) // Returns latest Brent Crude price
1820= OILPRICE_HISTORY (" WTI_USD" , 30 ) // Returns 30 days of WTI data
1921= OILPRICE_CONVERT (" NATURAL_GAS_GBP" ) // Returns price in $/MMBtu
2022```
2123
2224### Sidebar Features
25+
2326- API key management
2427- Commodity selection (20+ commodities)
2528- Fetch latest prices
@@ -28,19 +31,22 @@ This Google Sheets add-on brings live commodity prices to your spreadsheets:
2831- Usage tracking
2932
3033### Tier Detection
34+
3135- Free: 100 requests (lifetime)
3236- Exploration: 10,000 requests/month + historical data
3337- Production+: Higher limits + webhooks
3438
3539## 🚀 Installation
3640
3741### From Google Workspace Marketplace (Coming Soon)
42+
38431 . Open any Google Sheet
39442 . Extensions → Add-ons → Get add-ons
40453 . Search "OilPriceAPI Energy Prices"
41464 . Click Install
4247
4348### For Development
49+
44501 . Open Google Sheets
45512 . Extensions → Apps Script
46523 . Copy code from ` Code.gs ` and ` Sidebar.html `
@@ -49,20 +55,25 @@ This Google Sheets add-on brings live commodity prices to your spreadsheets:
4955## 📖 Quick Start
5056
5157### Step 1: Get API Key
52- Visit https://oilpriceapi.com/auth/signup to get your free API key.
58+
59+ Visit https://www.oilpriceapi.com/signup?utm_source=google_sheets&utm_medium=addin&utm_campaign=readme to get your free API key.
5360
5461### Step 2: Open Add-on
62+
55631 . Extensions → OilPriceAPI → Configure
56642 . Enter your API key
57653 . Click Save
5866
5967### Step 3: Use Custom Functions
68+
6069In any cell, type:
70+
6171```
6272=OILPRICE("BRENT_CRUDE_USD")
6373```
6474
6575### Step 4: Fetch Multiple Prices
76+
66771 . Extensions → OilPriceAPI → Fetch Prices
67782 . Select commodities
68793 . Click Fetch
@@ -71,6 +82,7 @@ In any cell, type:
7182## 🎨 Example Dashboards
7283
7384### Energy Price Comparison
85+
7486```
7587| Commodity | Latest Price | $/MMBtu | 30-Day Change |
7688|-----------------|--------------|----------|---------------|
@@ -81,6 +93,7 @@ In any cell, type:
8193```
8294
8395### Historical Price Chart
96+
84971 . Fetch past year data
85982 . Insert → Chart
86993 . Select date and price columns
@@ -89,28 +102,32 @@ In any cell, type:
89102## 💰 Pricing
90103
91104** Free Tier:**
105+
92106- 100 requests (lifetime)
93107- Real-time prices
94108- 20+ commodities
95109- Custom functions
96110
97111** Exploration ($15/mo):**
112+
98113- 10,000 requests/month
99114- Historical data access
100115- Pandas integration (Python SDK)
101116- Email support
102117
103118** Production ($45/mo):**
119+
104120- 50,000 requests/month
105121- Webhooks
106122- Priority support
107123- 99.9% uptime SLA
108124
109- [ View Full Pricing] ( https://oilpriceapi.com/pricing )
125+ [ View Full Pricing] ( https://www. oilpriceapi.com/pricing?utm_source=google_sheets&utm_medium=addin&utm_campaign= pricing )
110126
111127## 🛠️ Development
112128
113129### Project Structure
130+
114131```
115132google-sheets-energy-addin/
116133├── Code.gs # Main Apps Script code
@@ -122,12 +139,14 @@ google-sheets-energy-addin/
122139```
123140
124141### Testing Locally
142+
1251431 . Open Google Apps Script editor
1261442 . Make changes to Code.gs or Sidebar.html
1271453 . Click Run → test function
1281464 . Debug in Apps Script console
129147
130148### Deployment
149+
1311501 . Click Deploy → New deployment
1321512 . Type: Add-on
1331523 . Description: Version X.X.X
@@ -155,13 +174,15 @@ google-sheets-energy-addin/
155174## 📞 Support
156175
157176** Having issues?**
177+
158178- Email: support@oilpriceapi.com
159179- GitHub Issues: https://github.com/OilpriceAPI/google-sheets-addin/issues
160180- Documentation: https://www.oilpriceapi.com/tools/sheets-support
161181
162182## 🎓 Examples
163183
164184### Example 1: Build a Price Dashboard
185+
1651861 . Create new sheet named "Dashboard"
1661872 . Add formulas:
167188 ```
@@ -173,12 +194,14 @@ google-sheets-energy-addin/
1731944 . Add conditional formatting for price changes
174195
175196### Example 2: Historical Analysis
197+
1761981 . Extensions → OilPriceAPI → Fetch Historical
1771992 . Select "Brent Crude" and "Past Year"
1782003 . Data appears in "Historical" sheet
1792014 . Create line chart to visualize trends
180202
181203### Example 3: Energy Cost Calculator
204+
182205```
183206A1: Commodity | B1: =OILPRICE("NATURAL_GAS_USD")
184207A2: Volume (MMBtu) | B2: 1000
@@ -200,6 +223,7 @@ MIT License - See LICENSE file for details
200223## 🚀 Contributing
201224
202225Contributions welcome! Please:
226+
2032271 . Fork the repository
2042282 . Create feature branch
2052293 . Submit pull request
@@ -214,4 +238,4 @@ Contributions welcome! Please:
214238
215239** Built with ❤️ by OilPriceAPI**
216240
217- [ Website] ( https://oilpriceapi.com ) • [ Pricing] ( https://oilpriceapi.com/pricing ) • [ Docs] ( https://docs.oilpriceapi.com ) • [ Support] ( mailto:support@oilpriceapi.com )
241+ [ Website] ( https://www. oilpriceapi.com ) • [ Pricing] ( https://www. oilpriceapi.com/pricing?utm_source=google_sheets&utm_medium=addin&utm_campaign= pricing ) • [ Docs] ( https://docs.oilpriceapi.com ) • [ Support] ( mailto:support@oilpriceapi.com )
0 commit comments