Skip to content

Latest commit

 

History

History

README.md

Google Cloud Platform logo

This library is considered to be in preview. This means it is still a work-in-progress and under active development. Any release is subject to backwards-incompatible changes at any time.

npm version

Financial Services API client for Node.js

A comprehensive list of changes in each version may be found in the CHANGELOG.

Read more about the client libraries for Cloud APIs, including the older Google APIs Client Libraries, in Client Libraries Explained.

Table of contents:

Quickstart

Before you begin

  1. Select or create a Cloud Platform project.
  2. Enable billing for your project.
  3. Enable the Financial Services API API.
  4. Set up authentication so you can access the API from your local workstation.

Installing the client library

npm install @google-cloud/financialservices

Samples

Samples are in the samples/ directory. Each sample's README.md has instructions for running its sample.

Sample Source Code
create backtest result source code
create dataset source code
create engine config source code
create instance source code
create model source code
create prediction result source code
delete backtest result source code
delete dataset source code
delete engine config source code
delete instance source code
delete model source code
delete prediction result source code
export backtest result metadata source code
export engine config metadata source code
export model metadata source code
export prediction result metadata source code
export registered parties source code
get backtest result source code
get dataset source code
get engine config source code
get engine version source code
get instance source code
get model source code
get prediction result source code
import registered parties source code
list backtest results source code
list datasets source code
list engine configs source code
list engine versions source code
list instances source code
list models source code
list prediction results source code
update backtest result source code
update dataset source code
update engine config source code
update instance source code
update model source code
update prediction result source code
cloud source code

Supported Node.js Versions

Our client libraries follow the Node.js release schedule. Libraries are compatible with all current active and maintenance versions of Node.js. If you are using an end-of-life version of Node.js, we recommend that you update as soon as possible to an actively supported LTS version.

Google's client libraries support legacy versions of Node.js runtimes on a best-efforts basis with the following warnings:

  • Legacy versions are not tested in continuous integration.
  • Some security patches and features cannot be backported.
  • Dependencies cannot be kept up-to-date.

Client libraries targeting some end-of-life versions of Node.js are available, and can be installed through npm dist-tags. The dist-tags follow the naming convention legacy-(version). For example, npm install @google-cloud/financialservices@legacy-8 installs client libraries for versions compatible with Node.js 8.

Versioning

This library follows Semantic Versioning.

More Information: Google Cloud Platform Launch Stages

Contributing

Contributions welcome! See the Contributing Guide.

Please note that this README.md and a variety of configuration files in this repository (including .nycrc and tsconfig.json) are generated from a central template.

License

Apache Version 2.0

See LICENSE