Financial Services API: Node.js Client
Financial Services API client for Node.js
A comprehensive list of changes in each version may be found inthe CHANGELOG.
- Financial Services API Node.js Client API Reference
- Financial Services API Documentation
- github.com/googleapis/google-cloud-node/packages/google-cloud-financialservices
Read more about the client libraries for Cloud APIs, including the olderGoogle APIs Client Libraries, inClient Libraries Explained.
Table of contents:
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 theAPI from your local workstation.
Installing the client library
npm install @google-cloud/financialservicesUsing 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 libraryconst {AMLClient} = require('@google-cloud/financialservices').v1;// Instantiates a clientconst financialservicesClient = newAMLClient();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 thesamples/ directory. Each sample'sREADME.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 | ![]() |
TheFinancial Services API Node.js Client API Reference documentationalso contains samples.
Supported Node.js Versions
Our client libraries follow theNode.js release schedule.Libraries are compatible with all currentactive andmaintenance versions ofNode.js.If you are using an end-of-life version of Node.js, we recommend that you updateas soon as possible to an actively supported LTS version.
Google's client libraries support legacy versions of Node.js runtimes on abest-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, andcan be installed through npmdist-tags.The dist-tags follow the naming conventionlegacy-(version).For example,npm install @google-cloud/financialservices@legacy-8 installs client librariesfor versions compatible with Node.js 8.
Versioning
This library followsSemantic Versioning.
This library is considered to be inpreview. This means it is still awork-in-progress and under active development. Any release is subject tobackwards-incompatible changes at any time.
More Information:Google Cloud Platform Launch Stages
Contributing
Contributions welcome! See theContributing Guide.
Please note that thisREADME.md, thesamples/README.md,and a variety of configuration files in this repository (including.nycrc andtsconfig.json)are generated from a central template. To edit one of these files, make an editto its templates indirectory.
License
Apache Version 2.0
SeeLICENSE
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-30 UTC.
