ballerinax/openfigi Ballerina library

1.5.1

Overview

This is a generated connector for OpenFIGI API v3 OpenAPI Specification.

OpenFIGI API provides capability to access multiple tools for identifying, mapping and requesting a free and open symbology dataset. This user friendly platform provides the ultimate understanding for how a unique identifier combined with accurate, associated metadata can eliminate redundant mapping processes, streamline the trade workflow and reduce operational risk.

Prerequisites

Before using this connector in your Ballerina application, complete the following:

  • Create OpenFIGI account
  • Obtaining tokens

Quickstart

To use the openfigi connector in your Ballerina application, update the .bal file as follows:

  • Mapping third party identifiers to FIGIs

Step 1 - Import connector

Copy
import ballerinax/openfigi;

Step 2 - Create a new connector instance

Copy
configurable openfigi:ApiKeysConfig & readonly apiKeyConfig = ?;
openfigi:Client baseClient = check new Client(apiKeyConfig);

Step 3 - Invoke connector operation

  1. Invoke connector operation using the client.
Copy
openfigi:MappingJob mapping = {
    idType: "<ID Type>",
    idValue: <ID value>
};
openfigi:BulkMappingJob bulkJob = [mapping];
openfigi:BulkMappingJobResult result = check baseClient->mapping(bulkJob);
  1. Use bal run command to compile and run the Ballerina program.

Import

import ballerinax/openfigi;Copy

Metadata

Released date: 10 months ago

Version: 1.5.1

License: Apache-2.0


Compatibility

Platform: any

Ballerina version: 2201.4.1

GraalVM compatible: Yes


Pull count

Total: 

Current verison: 0


Weekly downloads


Source repository


Keywords

Finance/Accounting
Cost/Free

Contributors

Other versions

See more...