Financial Services API: Node.js Client

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
Samples
Versioning
Contributing
License

Quickstart

Before you begin

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

Installing the client library

npm install @google-cloud/financialservices

Using the client library

/**
 * This snippet has been automatically generated and should be regarded as a code template only.
 * It will require modifications to work.
 * It may require correct/in-range values for request initialization.
 * TODO(developer): Uncomment these variables before running the sample.
 */
/**
 *  Required. The parent of the Instance is the location for that Instance.
 *  Every location has exactly one instance.
 */
// const parent = 'abc123'
/**
 *  The number of resources to be included in the response. The response
 *  contains a next_page_token, which can be used to retrieve the next page of
 *  resources.
 */
// const pageSize = 1234
/**
 *  In case of paginated results, this is the token that was returned in the
 *  previous ListInstancesResponse. It should be copied here to retrieve the
 *  next page of resources. This will be empty for the first instance of
 *  ListInstancesRequest.
 */
// const pageToken = 'abc123'
/**
 *  Specify a filter to narrow search results.
 */
// const filter = 'abc123'
/**
 *  Specify a field to use for ordering.
 */
// const orderBy = 'abc123'

// Imports the Financialservices library
const {AMLClient} = require('@google-cloud/financialservices').v1;

// Instantiates a client
const financialservicesClient = new AMLClient();

async function callListInstances() {
  // Construct request
  const request = {
    parent,
  };

  // Run request
  const iterable = financialservicesClient.listInstancesAsync(request);
  for await (const response of iterable) {
    console.log(response);
  }
}

callListInstances();

Samples

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

Sample	Source Code	Try it
A_m_l.create_backtest_result	source code
A_m_l.create_dataset	source code
A_m_l.create_engine_config	source code
A_m_l.create_instance	source code
A_m_l.create_model	source code
A_m_l.create_prediction_result	source code
A_m_l.delete_backtest_result	source code
A_m_l.delete_dataset	source code
A_m_l.delete_engine_config	source code
A_m_l.delete_instance	source code
A_m_l.delete_model	source code
A_m_l.delete_prediction_result	source code
A_m_l.export_backtest_result_metadata	source code
A_m_l.export_engine_config_metadata	source code
A_m_l.export_model_metadata	source code
A_m_l.export_prediction_result_metadata	source code
A_m_l.export_registered_parties	source code
A_m_l.get_backtest_result	source code
A_m_l.get_dataset	source code
A_m_l.get_engine_config	source code
A_m_l.get_engine_version	source code
A_m_l.get_instance	source code
A_m_l.get_model	source code
A_m_l.get_prediction_result	source code
A_m_l.import_registered_parties	source code
A_m_l.list_backtest_results	source code
A_m_l.list_datasets	source code
A_m_l.list_engine_configs	source code
A_m_l.list_engine_versions	source code
A_m_l.list_instances	source code
A_m_l.list_models	source code
A_m_l.list_prediction_results	source code
A_m_l.update_backtest_result	source code
A_m_l.update_dataset	source code
A_m_l.update_engine_config	source code
A_m_l.update_instance	source code
A_m_l.update_model	source code
A_m_l.update_prediction_result	source code
Quickstart	source code

The Financial Services API Node.js Client API Reference documentation also contains samples.

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.

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.

More Information: Google Cloud Platform Launch Stages

Contributing

Contributions welcome! See the Contributing Guide.

Please note that this README.md, the samples/README.md, and a variety of configuration files in this repository (including .nycrc and tsconfig.json) are generated from a central template. To edit one of these files, make an edit to its templates in directory.

License

Apache Version 2.0

See LICENSE