Neptunium, Promethium, Manganese

    ocr-space-api-wrapper
    TypeScript icon, indicating that this package has built-in type declarations

    2.1.0 • Public • Published

    OCR.Space Node.js API wrapper

    Coverage Status npm Donate

    NPM

    Node.js wrapper for ocr.space APIs, a service for executing OCR (Optical Character Recognition) to images and PDFs.

    Install

    npm i ocr-space-api-wrapper

    Usage

    const { ocrSpace } = require('ocr-space-api-wrapper');
    
    async function main () {
      try {
        // Using the OCR.space default free API key (max 10reqs in 10mins) + remote file
        const res1 = await ocrSpace('http://dl.a9t9.com/ocrbenchmark/eng.png');
    
        // Using your personal API key + local file
        const res2 = await ocrSpace('/path/to/file.pdf', { apiKey: '<API_KEY_HERE>' });
        
        // Using your personal API key + base64 image + custom language
        const res3 = await ocrSpace('data:image/png;base64...', { apiKey: '<API_KEY_HERE>', language: 'ita' });
      } catch (error) {
        console.error(error);
      }
    }

    Params

    input string (required)

    The input param specifies the input file (see examples above). It can be one of the following:

    • a remote URL address such as http://example.com/image.jpg;
    • a local file path such as /path/to/file.pdf;
    • a base64 image string such as data:image/png;base64....

    options object

    This param is an object with the following keys:

    • apiKey: your API key for ocr.space APIs. Default API key has a limit of max 10reqs in 10mins.
    • ocrUrl: a different URL for ocr.space APIs, for example when you purchase the PRO plan.
    • All other params as documented in the official website.

    Response

    This package does not change the response in any way, please refer to the official website.

    Run lint

    npm run lint

    Run tests

    npm test

    Bug or feedback

    Please open a new issue.

    Author

    Install

    npm i ocr-space-api-wrapper

    DownloadsWeekly Downloads

    1,179

    Version

    2.1.0

    License

    MIT

    Unpacked Size

    455 kB

    Total Files

    12

    Last publish

    Collaborators

    • davideviolante