Skip to main content
GET
Proxy Image
This endpoint is public and does not require authentication.

Overview

The Image Proxy API fetches and transforms images from decentralized storage protocols like Arweave and IPFS. It acts as a proxy that:
  • Converts ar:// and ipfs:// URLs to fetchable gateway URLs
  • Resizes images to specified dimensions without enlargement
  • Converts images to optimized formats (WebP, AVIF, JPEG, PNG)
  • Returns immutable cache headers for efficient caching

Supported URL Formats

Image Transformation

When w (width) or h (height) parameters are provided, the image is resized to fit within the specified dimensions using the inside fit strategy, meaning:
  • The image will never be enlarged beyond its original size
  • Aspect ratio is preserved
  • The image fits within the bounding box defined by w and h

Example Usage

Basic Request

With Resize and Format Conversion

In an HTML Image Element

Query Parameters

url
string
required

The URL of the image to fetch. Supports Arweave (ar://), IPFS (ipfs://), and HTTPS URLs.

w
integer

Target width in pixels. The image will be resized to fit within this width without enlargement.

Required range: 1 <= x <= 4096
h
integer

Target height in pixels. The image will be resized to fit within this height without enlargement.

Required range: 1 <= x <= 4096
q
integer
default:80

Image quality (1-100). Higher values produce better quality but larger files.

Required range: 1 <= x <= 100
f
enum<string>
default:webp

Output image format.

Available options:
webp,
avif,
jpeg,
png

Response

Processed image returned

The response is of type file.