npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

gch-truefx-pricefeed

v0.0.9

Published

LIVE FX price feed FREE from trueFX

Downloads

767

Readme

TrueFX price service

TrueFX price service hooks into the FREE fx price service offered by TrueFX and emits price updates on your selected currency pair via web sockets.

For more information on the implementation, please read the following article Full stack part 1: Creating an FX price feed

Table of Contents

  1. Implementation
  2. Demo
  3. Contributing
  4. License

Implementation

NPM

Dependencys

Assumptions : You have node and npm installed

  1. You will need to register at http://www.truefx.com/ to get a username and password
  2. socket.io - cheerio - request

Installation

  1. install the node package from npm via the following command.
npm install gch-truefx-priceservice

Usage

  1. Create trueFXConfig constructor object using your username and password from truefx and a delimeted list of currency pairs.
var trueFXConfig = {
    userName:'trueFXuserName',
    password:'trueFXPassword',
    curPairs : 'EUR/CAD,GBP/USD,EUR/JPY,GBP/JPY,GBP/CAD,EUR/AUD'
};
  1. Set up your socket server with your http server
var io  = require('socket.io');
io = io.listen(server);
  1. Call the fxprice-srv constructor
     require('gch-truefx-pricefeed')(io,trueFXConfig);

API

The following event is emmited from the fx price service

socket.emit('fxPriceUpdate', {
        payload: fxPriceData
});

A client needs to be capturing the `fxPriceUpdate' event.

In the demo example, angular and the socket.io library is used to handle the event.

        $scope.$on('socket:fxPriceUpdate', function(event, data) {

            $scope.rates  =  data.payload;

        });

Payload

The returned object in the payload is an array of symbolVO's ( value objects ). Each indivdual VO has the follwoing structure.

        {
            symbol: '',
            timeStamp: '',
            bidBig: '',
            bidPoint: '',
            offerBig: '',
            offerPoint: '',
            high: '',
            low: '',
            mid: '',
            bidBullBear: '' ,
            offerBullBear: ''
        };

Back to top

Demo

Please see the READme in the Demo folder for instruction on how to get the demo up and running.

Contributing

Open an issue first to discuss potential changes/additions.

License

(The MIT License)

Copyright (c) 2014 Bill Gooch

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

    The above copyright notice and this permission notice shall be

included in all copies or substantial portions of the Software.

    THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
    EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF

MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.