Javascript SDK for OP API
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src
tests
.gitignore
.npmignore
.prettierrc
.travis.yml
LICENCE
README.md
config.ts
index.ts
package-lock.json
package.json
preprocessor.js
tsconfig.json

README.md

op-api-javascript-sdk

Build Status

Description

Simple universal SDK for easy consumption of OP APIs.

Installation

npm install @op/api-sdk

Usage

import SDK from "@op/api-sdk";

const options = {
    headers: {
        'x-api-key': 'your-api-key',
    }
}

const client = new SDK.Client(options)

See requests for required headers.

You can set request options for client instance, and also for each request function call, which is useful because you can then use global instance of SDK client, with globally defined x-api-key, but still give separate x-authorization header for each user:

const userOptions = {
    headers: {
        'x-authorization': userSession.getAuthorizationKey({bank: "OP"})
    }
}

const accounts = await client.getAllAccounts(userOptions);

For further reading, please see our API documentation

Developing

Running tests