npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2025 – Pkg Stats / Ryan Hefner

ocean-apis-sdk

v1.0.12

Published

A Node.js SDK for Invincible Ocean API's

Downloads

35

Readme

# Ocean APIs SDK

Ocean APIs SDK is a Node.js SDK that provides simple access to Ocean API services, such as PAN verification and OCR processing.

## Installation

To install the SDK, use npm:

```bash
npm install ocean-apis-sdk

Initialization

To use the SDK, initialize it with your clientId and secretKey. These keys are provided by Invincible Ocean to access their APIs.

const { Apis } = require('ocean-apis-sdk');

// Initialize the SDK with your clientId and secretKey
const apis = new Apis('yourClientId', 'yourSecretKey');

API Methods

1. PAN Verification

Verify PAN number using the verifyPan method.

Example:

async function verifyPan() {
    try {
        const result = await apis.verifyPan('ABCDE1234F');  // Replace with the actual PAN number
        console.log('PAN Verification Result:', result);
    } catch (error) {
        console.error('Error during PAN verification:', error.message);
    }
}

verifyPan();

2. Global OCR

Use the globalOcr method to extract text from front and back images of documents.

Example:

async function performOcr() {
    try {
        const frontImagePath = './path/to/front-image.jpg';  // Provide the path to the front image
        const backImagePath = './path/to/back-image.jpg';    // Provide the path to the back image

        const ocrResult = await apis.globalOcr(frontImagePath, backImagePath);
        console.log('OCR Result:', ocrResult);
    } catch (error) {
        console.error('Error during OCR processing:', error.message);
    }
}

performOcr();

Environment Variables

You can optionally configure your clientId and secretKey using environment variables. To do this, create a .env file in the root of your project and add the following:

CLIENT_ID=yourClientId
SECRET_KEY=yourSecretKey

Then you can initialize the SDK like this:

require('dotenv').config();  // Load environment variables from .env file
const { Apis } = require('ocean-apis-sdk');

const apis = new Apis(process.env.CLIENT_ID, process.env.SECRET_KEY);

Documentation

Visit the official website for more detailed API documentation: Ocean APIs Documentation.

Support

For any support or queries, please contact us at:

License

This SDK is licensed under the MIT License. See the LICENSE file for more information.