REST API v1.0.0

ImgMiner API Reference

Use the ImgMiner API to extract images from websites, process bulk URL jobs, and download the results as ZIP archives.

OpenAPI JSON API capabilities JSON

Endpoints

POST/api/v1/download

Create an image download

Extract images from one URL or up to ten URLs and return a generated ZIP download URL.

GET/api/v1/download/file/{filename}

Download a generated ZIP file

Retrieve the ZIP archive identified by the filename returned from the download endpoint.

GET/api/v1/health

Check API health

Confirm that the ImgMiner API is available and read its current service timestamp.

Example request

curl -X POST https://www.imgminer.com/api/v1/download \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com",
    "maxImages": 50,
    "deepScan": false
  }'