# ocr-space-api-alt2 > Fork of Dennnisk's original ocr-space-api with added support for PDF uploading. Provides an easy way to send images to the ocr.space API and get the OCR Result Latest version **2.0.1** (published 2021-12-25) · MIT license · 0 weekly downloads ## Install ```sh npm install ocr-space-api-alt2 pnpm add ocr-space-api-alt2 yarn add ocr-space-api-alt2 bun add ocr-space-api-alt2 ``` ## Health **Score 25/100 (F)** — status: abandoned. Positive: has types; no vulnerabilities; high quality score. Warnings: low downloads; no esm support. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 2.0.1 | | Published | 2021-12-25 | | First published | 2020-05-15 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | bundled | | Module format | CommonJS | | Dependencies | 2 | | Unpacked size | 416.2 KB | | Known vulnerabilities | 0 (+23 in 1 direct dependencies) | | Install scripts | no | | GitHub stars | 1 | | Author | AnthonyLzq @Anthony_Lzq | | Maintainers | anthonylzq | | Keywords | ocr, api, ocr-space, space, ocr-space-api, ocr-free | ## Links - npm: https://www.npmjs.com/package/ocr-space-api-alt2 - Repository: https://github.com/AnthonyLzq/ocr-space-api2 - Homepage: https://github.com/AnthonyLzq/ocr-space-api2#readme - Issues: https://github.com/AnthonyLzq/ocr-space-api2/issues - npm.io page: https://npm.io/package/ocr-space-api-alt2 ## Dependencies (2) - [axios](https://npm.io/package/axios.md) ^0.24.0 - [@postman/form-data](https://npm.io/package/@postman/form-data.md) ^3.1.1 ## Recent versions - 2.0.1 (latest) — 2021-12-25 - 2.0.0 — 2021-12-25 - 1.1.0 — 2021-01-07 - 1.0.0-c — 2020-06-04 - 1.0.0-b — 2020-05-16 - 1.0.0-a — 2020-05-16 - 1.0.0 — 2020-05-16 - 0.0.1-security — 2020-05-15 ## README # ocr-space-api-alt2 Allow to access [ORC.SPACE API](https://ocr.space/ocrapi) to send images and get the embedded text. More Details: https://ocr.space/ocrapi. **IMPORTANT**: The OCR is provided by [OCR.SPACE](https://ocr.space/). I don't have anything with them, I just want to help reworking and sharing this library. ## Main changes 1. The original library was using [request](https://github.com/request/request#readme), but since it's deprecated, I saw the necessity to migrate from it. Now I'm currently using [axios](https://github.com/axios/axios#readme) to perform the request. 2. Since [axios](https://github.com/axios/axios#readme) doesn't support `form data` request, I've used [query-string](https://github.com/sindresorhus/query-string#readme). ## Installation ### First - Register and Get your API key Get you API key at this [link](https://ocr.space/ocrapi). Just follow their steps. ### Second - Install npm package ```console npm i ocr-space-api-alt2 ``` ```console yarn add ocr-space-api-alt2 ``` ## Usage example You can see and example at the folder [`example`](/example/example.js). ```javascript const ocrSpaceApi = require('ocr-space-api-alt2') const options = { apikey: '', filetype: 'png', verbose: true, url: `${__dirname}/loveText.jpg` } const getText = async () => { try { const result = await ocrSpaceApi(options) console.log({ result }) } catch (error) { console.error(error) } } getText() ``` ### Options The available options are an adaptation from the [docs](https://ocr.space/ocrapi#post). | key | Value | Description | |--|--|--| | apikey | [Required] - String
API key from OCR space API| Get you API key at this [link](https://ocr.space/ocrapi). | | url | [Required] - String
| Url that points to file you want to get its text from. It can be a url (starting in http), a base64 image or a local file | | language | [Optional] - String
Arabic=ara
Bulgarian=bul
Chinese(Simplified)=chs
Chinese(Traditional)=cht
Croatian = hrv
Czech = cze
Danish = dan
Dutch = dut
English = eng
Finnish = fin
French = fre
German = ger
Greek = gre
Hungarian = hun
Korean = kor
Italian = ita
Japanese = jpn
Polish = pol
Portuguese = por
Russian = rus
Slovenian = slv
Spanish = spa
Swedish = swe
Turkish = tur | Language used for OCR. If no language is specified, English `eng` is taken as default.

IMPORTANT: The language code has always `3-letters` (not 2). So it is "eng" and not "en".

[Engine2](https://ocr.space/ocrapi#ocrengine) has automatic Western language detection, so this value will be ignored. | | isOverlayRequired | [Optional] - Boolean | Default = `False`
If true, returns the coordinates of the bounding boxes for each word. If false, the OCR'ed text is returned only as a text block (this makes the JSON reponse smaller). Overlay data can be used, for example, to show [text over the image](https://ocr.space/english). | | filetype | [Optional] - String
Available values: PDF, GIF, PNG, JPG, TIF, BMP | Overwrites the automatic file type detection based on [content-type](https://ocr.space/ocrapi#contenttype). Supported image file formats are png, jpg (jpeg), gif, tif (tiff) and bmp. For document ocr, the api supports the Adobe PDF format. Multi-page TIFF files are supported. | | detectOrientation | [Optional] - Boolean | If set to true, the api autorotates the image correctly and sets the `TextOrientation` parameter in the JSON response. If the image is not rotated, then TextOrientation=0, otherwise it is the degree of the rotation, e. g. "270". | | isCreateSearchablePdf | [Optional] - Boolean | Default = `False`
If true, API generates a [searchable PDF](https://ocr.space/ocrapi#searchablepdf). This parameter automatically sets isOverlayRequired = true. | | isSearchablePdfHideTextLayer | [Optional] - Boolean | Default = `False`.
If true, the text layer is hidden (not visible). | | scale | [Optional] - Boolean | Default = `False`.
If set to true, the api does some internal upscaling. This can improve the OCR result significantly, especially for low-resolution PDF scans. Note that the [front page demo](https://ocr.space/) uses scale=true, but the API uses scale=false by default. See also this [OCR forum post](https://forum.ui.vision/t/difference-between-online-ocr-and-ocr-api/980/2). | | isTable | [Optional] - Boolean | If set to true, the OCR logic makes sure that the parsed text result is always returned line by line. This switch is recommended for [table OCR](https://ocr.space/tablerecognition), [receipt OCR](https://ocr.space/receiptscanning), invoice processing and all other type of input documents that have a table like structure. | | OCREngine | [Optional] - Number
Available values: 1, 2 | Engine 1 is default. See [OCR Engines](https://ocr.space/ocrapi#ocrengine). | | verbose | [Optional] - Boolean | Wether or not you want the full response from de OCR API or just the text that was gotten. | ## Authors - **Denis** - _Initial Work_ - _Initial Documentation_ - [dennnisk](https://github.com/dennnisk). - **Anthony Luzquiños** - _Rework_ - [AnthonyLzq](https://github.com/AnthonyLzq). **Important** This package was not fully tested, and every contribution will be appreciated. --- _Source: https://npm.io/package/ocr-space-api-alt2 · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._