optiic

Site | NPM Module | GitHub Repo

optiic is the official npm module of Optiic, a free service to get SOCKS, HTTP, & HTTPS proxies as well as to check your public IP!

Optiic Works in Node AND browser environments

Yes, this module works in both Node and browser environments, including compatability with Webpack and Browserify!

Features

• Image recognition and analysis API
• Provide images as URLs or upload them directly
• OCR
  • Extract text from the supplied image
  • Easily filter by country, speed, and anonymity level

Getting an API key

You can use so much of optiic for free, but if you want to do some advanced stuff, you'll need an API key. You can get one by signing up for an account at https://optiic.dev/signup.

Install Optiic

Install via npm

Install with npm if you plan to use optiic in a Node project or in the browser.

npm install optiic

If you plan to use optiic in a browser environment, you will probably need to use Webpack, Browserify, or a similar service to compile it.

const optiic = new (require('optiic'))({
  apiKey: 'api_test_key' // Not required, but having one removes limits (get your key at https://optiic.dev).
});

Install via CDN

Install with CDN if you plan to use Optiic only in a browser environment.

<script src="https://cdn.jsdelivr.net/npm/optiic"></script>
<script type="text/javascript">
  let optiic = new Optiic({
    apiKey: 'api_test_Key' // Not required, but having one removes limits (get your key at https://optiic.dev).
  });
</script>

Use without installation

You can use Optiic in a variety of ways that require no installation, such as curl in terminal/shell. See the Use without installation section below.

Using Optiic

After you have followed the install step, you can start using optiic to get proxy lists and check your public IP!

.process(options)

Submit and image to process and return the text in the image.

let options = {
  url: 'https', // url to the image
  mode: 'ocr', // ocr
};
optiic.process(options)
.then(result => {
  console.log(result);
})

options

The options for ocr(options) are as follows.

• url string: URL of the image.
  • Values: n/a
  • Default: null
• mode string: What type of optical recognition will be run, such as OCR.
  • Values: ocr
  • Default: ocr

Extending Capabilities

For a more in-depth documentation of this library and the Optiic service, please visit the official Optiic website.

Use without installation

Use Optiic with curl

# OCR
# Standard
curl -X POST https://api.optiic.dev/process
# With options
curl -d "url=https://example.com/my-image" -X POST https://api.optiic.dev/process
# With options (alternative)
curl -d '{"url": "https://example.com/my-image"}' -H 'Content-Type: application/json' https://api.optiic.dev/process

What Can Optiic do?

Optiic is a free proxy api that helps you get free proxy lists and check your public IP.

Final Words

If you are still having difficulty, we would love for you to post a question to the Optiic issues page. It is much easier to answer questions that include your code and relevant files! So if you can provide them, we'd be extremely grateful (and more likely to help you find the answer!)

Projects Using this Library

Somiibo: A Social Media Bot with an open-source module library.
JekyllUp: A website devoted to sharing the best Jekyll themes.
Slapform: A backend processor for your HTML forms on static sites.
SoundGrail Music App: A resource for producers, musicians, and DJs.
Hammock Report: An API for exploring and listing backyard products.

Ask us to have your project listed! :)