How to Get Information about an Image using Node.js

Image files contain a lot of useful information which we might need to make changes to the image file in subsequent operations.

To retrieve that information, we can use the below code & take advantage of a free-to-use API. This will return a long list of information (as made available by the image), including what’s listed in the JSON response example below:

{
  "Successful": true,
  "ColorSpace": "string",
  "ColorType": "string",
  "Width": 0,
  "Height": 0,
  "CompressionLevel": 0,
  "ImageHashSignature": "string",
  "HasTransparency": true,
  "MimeType": "string",
  "ImageFormat": "string",
  "DPIUnit": "string",
  "DPI": 0,
  "ColorCount": 0,
  "BitDepth": 0,
  "Comment": "string",
  "ExifProfileName": "string",
  "ExifValues": [
    {
      "Tag": "string",
      "DataType": "string",
      "DataValue": "string"
    }
  ]
}

When we make our API call, we can authorize our request with a free-tier API key, which will allow us to make up to 800 API calls per month with no additional commitment.

Let’s start by installing the SDK. We can do that by either running the below command:

npm install cloudmersive-convert-api-client --save

Or by adding this snippet to our package.json:

  "dependencies": {
    "cloudmersive-convert-api-client": "^2.6.3"
  }

After that, we can include the below code in our file to call the function:

var CloudmersiveConvertApiClient = require('cloudmersive-convert-api-client');
var defaultClient = CloudmersiveConvertApiClient.ApiClient.instance;

// Configure API key authorization: Apikey
var Apikey = defaultClient.authentications['Apikey'];
Apikey.apiKey = 'YOUR API KEY';



var apiInstance = new CloudmersiveConvertApiClient.ConvertImageApi();

var inputFile = Buffer.from(fs.readFileSync("C:\\temp\\inputfile").buffer); // File | Input file to perform the operation on.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.convertImageGetImageInfo(inputFile, callback);

That’s all there is to it — now we can easily enumerate information about our image files in one quick & free request.