Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
etfdb-api - npm Package Compare versions
Comparing version 1.0.3 to 2.0.0
| const etfdb = require('./index'); | ||
| etfdb.getData(limit=50, offset=0, sort='ytd_percent_return', order='desc') | ||
| etfdb.getData(perPage=50, page=1, sort='ytd', order='desc') | ||
| .then(result => { | ||
| console.log('Total ETFs:', result.total); | ||
| console.log('Returned ETFs:', result.rows.length); | ||
| console.log('Total ETFs:', result.meta.total_records); | ||
| result.rows.forEach(row => { | ||
| console.log(row._ytd_percent_return_data.th, row.ytd_percent_return); | ||
| }) | ||
| }); | ||
| result.data.forEach(etf => { | ||
| console.log(etf.symbol.text, etf.ytd); | ||
| }) | ||
| }).catch(err => console.log(err)); |
| const request = require('request'); | ||
| /** | ||
| * HTTPS GET API | ||
| * resolve returns JSON-parsed response | ||
| * | ||
| * @param query | ||
| * @returns {Promise} | ||
| */ | ||
| module.exports.fetch = (query) => { | ||
| return new Promise((resolve, reject) => { | ||
| request(query, (error, response, body) => { | ||
| try { | ||
| resolve(JSON.parse(body)); | ||
| module.exports.fetch = (url = ``, payload = null) => { | ||
| const options = { | ||
| url, | ||
| method: 'POST', | ||
| "User-Agent": 'Mozilla/4.2 (Macintosh; Intel Mac OS X 10_12_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.77 Safari/537.36', | ||
| body: payload, | ||
| json: true | ||
| }; | ||
| return new Promise((res, rej) => { | ||
| request.post(options, (err, response, body) => { | ||
| if (err) { | ||
| return rej(err) | ||
| } | ||
| catch (err) { | ||
| reject(err); | ||
| } | ||
| }); | ||
| }); | ||
| res(body) | ||
| }) | ||
| }) | ||
| }; |
39
index.js
@@ -5,24 +5,29 @@ const h = require('./helpers'); | ||
| /** | ||
| * Get ETFdb data | ||
| * @param limit | ||
| * @param offset | ||
| * @param sort | ||
| * @param order | ||
| * @returns {Promise} | ||
| * List all ETFs. Manipulate the order by using parameters. | ||
| * @param {number} [perPage=25] | ||
| * @param {number} [page=1] | ||
| * @param {string} [sort='ytd'] | ||
| * @param {string} [order='desc'] | ||
| */ | ||
| module.exports.getData = (limit=25, | ||
| offset=0, | ||
| sort='ytd_percent_return', | ||
| module.exports.getData = (perPage=25, | ||
| page = 1, | ||
| sort='ytd', | ||
| order='desc') => { | ||
| const path = `data_set/?tm=1885&no_null_sort=true&` + | ||
| `count_by_id=&` + | ||
| `sort=${sort}&` + | ||
| `order=${order}&` + | ||
| `limit=${limit}&` + | ||
| `offset=${offset}`; | ||
| const path = `api/screener/`; | ||
| const query = config.etfdb.baseUrl + path; | ||
| const body = { | ||
| "page": page, | ||
| "per_page": perPage, | ||
| "sort_by": sort, | ||
| "sort_direction": order, | ||
| "only": [ | ||
| "meta", | ||
| "data" | ||
| ] | ||
| }; | ||
| return h.fetch(query); | ||
| const url = config.etfdb.baseUrl + path; | ||
| return h.fetch(url, body); | ||
| }; |
| { | ||
| "name": "etfdb-api", | ||
| "version": "1.0.3", | ||
| "version": "2.0.0", | ||
| "description": "ETFdb.com API", | ||
@@ -5,0 +5,0 @@ "main": "index.js", |
296
README.md
@@ -6,254 +6,78 @@ # ETFdb.com API | ||
| # Example | ||
| ## Example Script | ||
| ```javascript | ||
| const etfdb = require('etfdb-api'); | ||
| etfdb.getData(limit=50, offset=0, sort='ytd_percent_return', order='desc') | ||
| etfdb.getData(perPage=50, page=1, sort='ytd', order='desc') | ||
| .then(result => { | ||
| console.log('Total ETFs:', result.total); | ||
| console.log('Returned ETFs:', result.rows.length); | ||
| console.log('Total ETFs:', result.meta.total_records); | ||
| result.rows.forEach(row => { | ||
| console.log(row._ytd_percent_return_data.th, row.ytd_percent_return); | ||
| }) | ||
| }); | ||
| result.data.forEach(etf => { | ||
| console.log(etf.symbol.text, etf.ytd); | ||
| }) | ||
| }).catch(err => console.log(err)); | ||
| ``` | ||
| ## Example Response | ||
| ```json | ||
| { | ||
| "total": 3114, | ||
| "rows": [ | ||
| "meta": { | ||
| "page": 2, | ||
| "per_page": 25, | ||
| "sort_direction": "desc", | ||
| "sort_by": "assets", | ||
| "order": { | ||
| "assets": "desc" | ||
| }, | ||
| "total_pages": 90, | ||
| "total_records": 2245, | ||
| "filter": {} | ||
| }, | ||
| "data": [ | ||
| { | ||
| "symbol": "<a href=\"/etf/AAVX/\"><span class=\"caps\">AAVX</span></a>", | ||
| "_symbol_data": { | ||
| "th": "Symbol" | ||
| "symbol": { | ||
| "type": "link", | ||
| "text": "XLF", | ||
| "url": "/etf/XLF/" | ||
| }, | ||
| "name": "<a href=\"/etf/AAVX/\"><span class=\"caps\">ETRACS</span> Daily Short 1-Month S&P 500 <span class=\"caps\">VIX</span> Futures <span class=\"caps\">ETN</span></a>", | ||
| "_name_data": { | ||
| "th": "ETF Name" | ||
| "name": { | ||
| "type": "link", | ||
| "text": "Financial Select Sector SPDR Fund", | ||
| "url": "/etf/XLF/" | ||
| }, | ||
| "assets_under_management": "N/A", | ||
| "_assets_under_management_data": { | ||
| "th": "Total Assets*" | ||
| "mobile_title": "XLF - Financial Select Sector SPDR Fund", | ||
| "price": "$24.00", | ||
| "assets": "$23,740.88", | ||
| "average_volume": "73,474,031", | ||
| "ytd": "-12.95%", | ||
| "overall_rating": { | ||
| "type": "restricted", | ||
| "url": "/members/join/" | ||
| }, | ||
| "ytd_percent_return": "154.63%", | ||
| "_ytd_percent_return_data": { | ||
| "th": "YTD" | ||
| "asset_class": "Equity" | ||
| }, | ||
| { | ||
| "symbol": { | ||
| "type": "link", | ||
| "text": "VO", | ||
| "url": "/etf/VO/" | ||
| }, | ||
| "three_month_average_volume": "2,592.0", | ||
| "_three_month_average_volume_data": { | ||
| "th": "Avg Volume" | ||
| "name": { | ||
| "type": "link", | ||
| "text": "Vanguard Mid-Cap Index ETF", | ||
| "url": "/etf/VO/" | ||
| }, | ||
| "price": "$220.66", | ||
| "_price_data": { | ||
| "th": "Previous Closing Price" | ||
| "mobile_title": "VO - Vanguard Mid-Cap Index ETF", | ||
| "price": "$141.39", | ||
| "assets": "$21,782.58", | ||
| "average_volume": "571,031", | ||
| "ytd": "-7.61%", | ||
| "overall_rating": { | ||
| "type": "restricted", | ||
| "url": "/members/join/" | ||
| }, | ||
| "change": "0.00%", | ||
| "_change_data": { | ||
| "th": "1-Day Change" | ||
| }, | ||
| "one_week_return": "23.68%", | ||
| "_one_week_return_data": { | ||
| "th": "1 Week" | ||
| }, | ||
| "four_week_return": "17.97%", | ||
| "_four_week_return_data": { | ||
| "th": "4 Week" | ||
| }, | ||
| "fiftytwo_week_return": "150.49%", | ||
| "_fiftytwo_week_return_data": { | ||
| "th": "1 year" | ||
| }, | ||
| "three_year_percent_return": "N/A", | ||
| "_three_year_percent_return_data": { | ||
| "th": "3 year" | ||
| }, | ||
| "five_year_percent_return": "N/A", | ||
| "_five_year_percent_return_data": { | ||
| "th": "5 year" | ||
| }, | ||
| "ytd_fund_flow": "<a class=\"restricted\" data-analytics-track-click=\"{"category":"Table","label":"YTD Fund Flow","action":"Click"}\" href=\"/members/join/\"></a>", | ||
| "_ytd_fund_flow_data": { | ||
| "th": "YTD FF" | ||
| }, | ||
| "one_week_fund_flow": "<a class=\"restricted\" data-analytics-track-click=\"{"category":"Table","label":"1 Week Fund Flow","action":"Click"}\" href=\"/members/join/\"></a>", | ||
| "_one_week_fund_flow_data": { | ||
| "th": "1 Week FF" | ||
| }, | ||
| "four_week_fund_flow": "<a class=\"restricted\" data-analytics-track-click=\"{"category":"Table","label":"4 Week Fund Flow","action":"Click"}\" href=\"/members/join/\"></a>", | ||
| "_four_week_fund_flow_data": { | ||
| "th": "4 Week FF" | ||
| }, | ||
| "one_year_fund_flow": "<a class=\"restricted\" data-analytics-track-click=\"{"category":"Table","label":"1 Year Fund Flow","action":"Click"}\" href=\"/members/join/\"></a>", | ||
| "_one_year_fund_flow_data": { | ||
| "th": "1 Year FF" | ||
| }, | ||
| "three_year_fund_flow": "<a class=\"restricted\" data-analytics-track-click=\"{"category":"Table","label":"3 Year Fund Flow","action":"Click"}\" href=\"/members/join/\"></a>", | ||
| "_three_year_fund_flow_data": { | ||
| "th": "3 Year FF" | ||
| }, | ||
| "five_year_fund_flow": "<a class=\"restricted\" data-analytics-track-click=\"{"category":"Table","label":"5 Year Fund Flow","action":"Click"}\" href=\"/members/join/\"></a>", | ||
| "_five_year_fund_flow_data": { | ||
| "th": "5 Year FF" | ||
| }, | ||
| "etf_category": "<a href=\"/etfdb-category/inverse-volatility/\">Inverse Volatility</a>", | ||
| "_etf_category_data": { | ||
| "th": "ETFdb.com Category" | ||
| }, | ||
| "inception": "N/A", | ||
| "_inception_data": { | ||
| "th": "Inception" | ||
| }, | ||
| "expense_ratio": "1.35%", | ||
| "_expense_ratio_data": { | ||
| "th": "ER" | ||
| }, | ||
| "link_to_commission_free_brokers": "N/A", | ||
| "_link_to_commission_free_brokers_data": { | ||
| "th": "Commission Free" | ||
| }, | ||
| "dividend_annular_rate": "$0.00", | ||
| "_dividend_annular_rate_data": { | ||
| "th": "Annual Dividend Rate" | ||
| }, | ||
| "dividend_date": "N/A", | ||
| "_dividend_date_data": { | ||
| "th": "Dividend Date" | ||
| }, | ||
| "dividend": "$0.00", | ||
| "_dividend_data": { | ||
| "th": "Dividend" | ||
| }, | ||
| "dividend_yield": "0.00%", | ||
| "_dividend_yield_data": { | ||
| "th": "Annual Dividend Yield %" | ||
| }, | ||
| "pe_ratio": "0.00", | ||
| "_pe_ratio_data": { | ||
| "th": "P/E Ratio" | ||
| }, | ||
| "beta": "0.00", | ||
| "_beta_data": { | ||
| "th": "Beta" | ||
| }, | ||
| "number_of_holdings": "N/A", | ||
| "_number_of_holdings_data": { | ||
| "th": "# of Holdings" | ||
| }, | ||
| "top_ten_holdings": "N/A", | ||
| "_top_ten_holdings_data": { | ||
| "th": "% In Top 10" | ||
| }, | ||
| "complete": "<a href=\"/etf/AAVX/#holdings\">View</a>", | ||
| "_complete_data": { | ||
| "th": "Complete" | ||
| }, | ||
| "short_term_cap_gains_rate": "35%", | ||
| "_short_term_cap_gains_rate_data": { | ||
| "th": "ST Cap Gain Rate" | ||
| }, | ||
| "long_term_cap_gains_rate": "15%", | ||
| "_long_term_cap_gains_rate_data": { | ||
| "th": "LT Cap Gain Rate" | ||
| }, | ||
| "tax_form": "1099", | ||
| "_tax_form_data": { | ||
| "th": "Tax Form" | ||
| }, | ||
| "twenty_day_lower_bollinger_band": "$162.36", | ||
| "_twenty_day_lower_bollinger_band_data": { | ||
| "th": "Lower Bollinger" | ||
| }, | ||
| "twenty_day_upper_bollinger_band": "$206.83", | ||
| "_twenty_day_upper_bollinger_band_data": { | ||
| "th": "Upper Bollinger" | ||
| }, | ||
| "support_level_one": "$218.81", | ||
| "_support_level_one_data": { | ||
| "th": "Support 1" | ||
| }, | ||
| "resistance_level_one": "$221.59", | ||
| "_resistance_level_one_data": { | ||
| "th": "Resistance 1" | ||
| }, | ||
| "twenty_day_rsi": "71.92", | ||
| "_twenty_day_rsi_data": { | ||
| "th": "RSI" | ||
| }, | ||
| "advanced": "<a href=\"/etf/AAVX/#technical\">View</a>", | ||
| "_advanced_data": { | ||
| "th": "Advanced" | ||
| }, | ||
| "fact_sheet": "<a href=\"/etf/AAVX/#fact-sheet\">View</a>", | ||
| "_fact_sheet_data": { | ||
| "th": "Fact Sheet" | ||
| }, | ||
| "etf_holdings": "<a href=\"/etf/AAVX/#holdings\">View</a>", | ||
| "_etf_holdings_data": { | ||
| "th": "ETF Holdings" | ||
| }, | ||
| "chart": "<a href=\"/etf/AAVX/#charts\">View</a>", | ||
| "_chart_data": { | ||
| "th": "Chart" | ||
| }, | ||
| "etf_home_page": "<a href=\"/etf/AAVX/\">View</a>", | ||
| "_etf_home_page_data": { | ||
| "th": "ETF Home Page" | ||
| }, | ||
| "head_to_head": "<a href=\"/tool/etf-comparison/#AAVX\">View</a>", | ||
| "_head_to_head_data": { | ||
| "th": "Head-To-Head" | ||
| }, | ||
| "overall_score": "<a class=\"restricted\" data-analytics-track-click=\"{"category":"Table","label":"Overall Rating","action":"Click"}\" href=\"/members/join/\"></a>", | ||
| "_overall_score_data": { | ||
| "th": "Overall Rating" | ||
| }, | ||
| "liquidity_score": "N/A", | ||
| "_liquidity_score_data": { | ||
| "th": "Liquidity Rating" | ||
| }, | ||
| "expenses_score": "N/A", | ||
| "_expenses_score_data": { | ||
| "th": "Expenses Rating" | ||
| }, | ||
| "performance_score": "<a class=\"restricted\" data-analytics-track-click=\"{"category":"Table","label":"Returns Rating","action":"Click"}\" href=\"/members/join/\"></a>", | ||
| "_performance_score_data": { | ||
| "th": "Returns Rating" | ||
| }, | ||
| "volatility_score": "<a class=\"restricted\" data-analytics-track-click=\"{"category":"Table","label":"Volatility Rating","action":"Click"}\" href=\"/members/join/\"></a>", | ||
| "_volatility_score_data": { | ||
| "th": "Volatility Rating" | ||
| }, | ||
| "dividend_score": "<a class=\"restricted\" data-analytics-track-click=\"{"category":"Table","label":"Dividend Rating","action":"Click"}\" href=\"/members/join/\"></a>", | ||
| "_dividend_score_data": { | ||
| "th": "Dividend Rating" | ||
| }, | ||
| "concentration_score": "<a class=\"restricted\" data-analytics-track-click=\"{"category":"Table","label":"Concentration Rating","action":"Click"}\" href=\"/members/join/\"></a>", | ||
| "_concentration_score_data": { | ||
| "th": "Concentration Rating" | ||
| }, | ||
| "esg_quality_score": "N/A", | ||
| "_esg_quality_score_data": { | ||
| "th": "ESG Score" | ||
| }, | ||
| "esg_quality_score_pctl_peer": "N/A", | ||
| "_esg_quality_score_pctl_peer_data": { | ||
| "th": "ESG Score Peer Percentile (%)" | ||
| }, | ||
| "esg_quality_score_pctl_global": "N/A", | ||
| "_esg_quality_score_pctl_global_data": { | ||
| "th": "ESG Score Global Percentile (%)" | ||
| }, | ||
| "esg_weighted_avg_carbon_inten": "N/A", | ||
| "_esg_weighted_avg_carbon_inten_data": { | ||
| "th": "Carbon Intensity (Tons of CO2e / $M Sales)" | ||
| }, | ||
| "esg_sri_exclusion_criteria_pct": "N/A", | ||
| "_esg_sri_exclusion_criteria_pct_data": { | ||
| "th": "ESG Exclusion Criteria (%)" | ||
| }, | ||
| "esg_sustainable_impact_pct": "N/A", | ||
| "_esg_sustainable_impact_pct_data": { | ||
| "th": "Sustainable Impact Solutions (%)" | ||
| } | ||
| "asset_class": "Equity" | ||
| }, | ||
| { | ||
| ... | ||
| } | ||
@@ -260,0 +84,0 @@ ] |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Number of package files
- increased by16.67%
7
- Lines of code
- increased by1.89%
54
Worsened metrics
- Total package byte prevSize
- decreased by-66.59%
4432
- Number of lines in readme file
- decreased by-67.43%
85
No dependency changes