Code Monkey home page Code Monkey logo

client-js's Introduction

code style: prettier

Install

npm install --save @polygon.io/client-js

usage

Authentication

  • call the desired client with your api key to initialize it
import { polygonClient, restClient, websocketClient } from "@polygon.io/client-js";
const rest = restClient("API KEY");

// you can use the api now

rest.forex
  .previousClose("C:EURUSD")
  .then(/* your success handler */)
  .catch(/* your error handler*/);
  • import all the rest submodule
import { restClient } from "@polygon.io/client-js";

const rest = restClient("api key");

rest.forex.previousClose("C:EURUSD").then(/* your success handler */);
  • import a specific submodule
import { referenceClient } from "@polygon.io/client-js";

const reference = referenceClient("api key");

reference.tickers().then(/* your success handler */);

You can get preauthenticated websocket clients for the 3 topics.

import { websocketClient } from "@polygon.io/client-js";

const stocksWS = websocketClient("api key").stocks();

stocksWS.onmessage = ({data}) => {
  const [message] = JSON.parse(data);

  stocksWS.send('{"action":"subscribe", "params":"AM.MSFT,A.MSFT"}');

  switch (message.ev) {
    case "AM":
      // your trade message handler
      break;
    case "A":
      // your trade message handler
      break;
  }
};

stocksWS.send({ action: "subscribe", params: "T.MSFT" });

documentation

  • Generate the package documentation
npm run generate-doc

client-js's People

Contributors

bassochette avatar teambailey avatar mpatel18 avatar stormy110 avatar timetraveler328 avatar jaydenwindle avatar joedursun avatar randomf avatar yehudabortz avatar dependabot[bot] avatar tharnach avatar akash9l avatar ctrahey avatar dylanmoz avatar ianrios avatar codingmatty avatar narciero avatar ruckonic avatar khuzha avatar nikofarrelly avatar jogenshah avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.