API Reference

curl -X POST https://cwick.us/v1/screenshot \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://example.com", "width": 1920, "height": 1080}' \
  --output screenshot.png

curl -X POST https://cwick.us/v1/screenshot \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://github.com", "full_page": true, "dark_mode": true, "format": "jpeg", "quality": 90}' \
  --output github-dark.jpg

curl "https://cwick.us/v1/og?url=https://github.com" \
  -H "X-API-Key: YOUR_API_KEY"

import { writeFile } from 'fs/promises';

const response = await fetch('https://cwick.us/v1/screenshot', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.CWICKUS_API_KEY,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    url: 'https://example.com',
    width: 1920,
    height: 1080,
    format: 'jpeg',
    quality: 90,
  }),
});

const buffer = Buffer.from(await response.arrayBuffer());
await writeFile('screenshot.jpg', buffer);

console.log('Render time:', response.headers.get('X-Render-Time-Ms'), 'ms');
console.log('Remaining:', response.headers.get('X-RateLimit-Remaining'));

const response = await fetch(
  'https://cwick.us/v1/og?url=https://github.com',
  { headers: { 'X-API-Key': process.env.CWICKUS_API_KEY } }
);

const { data } = await response.json();
console.log(data.title);       // "GitHub: Let's build from here"
console.log(data.description);  // "GitHub is where over 100 million..."
console.log(data.image);        // "https://github.githubassets.com/..."

const response = await fetch('https://cwick.us/v1/screenshot', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.CWICKUS_API_KEY,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    url: 'https://example.com',
    response_type: 'base64',
    format: 'jpeg',
    quality: 70,
  }),
});

const { data, format } = await response.json();
const imgSrc = `data:image/${format};base64,${data}`;
// Use imgSrc in an <img> tag or store in database

import requests
import os

response = requests.post(
    'https://cwick.us/v1/screenshot',
    headers={'X-API-Key': os.environ['CWICKUS_API_KEY']},
    json={
        'url': 'https://example.com',
        'width': 1920,
        'height': 1080,
        'format': 'jpeg',
        'quality': 90,
        'dark_mode': True,
    },
)

response.raise_for_status()

with open('screenshot.jpg', 'wb') as f:
    f.write(response.content)

print(f"Render time: {response.headers['X-Render-Time-Ms']}ms")
print(f"Remaining: {response.headers['X-RateLimit-Remaining']}")

import requests
import os

response = requests.get(
    'https://cwick.us/v1/og',
    params={'url': 'https://github.com'},
    headers={'X-API-Key': os.environ['CWICKUS_API_KEY']},
)

data = response.json()['data']
print(f"Title: {data['title']}")
print(f"Image: {data['image']}")
print(f"Favicon: {data['favicon']}")

use Illuminate\Support\Facades\Http;
use Illuminate\Support\Facades\Storage;

$response = Http::withHeaders([
    'X-API-Key' => config('services.cwickus.key'),
])->post('https://cwick.us/v1/screenshot', [
    'url' => 'https://example.com',
    'width' => 1920,
    'height' => 1080,
    'format' => 'jpeg',
    'quality' => 90,
]);

Storage::put('screenshots/example.jpg', $response->body());

$renderTime = $response->header('X-Render-Time-Ms');
$remaining = $response->header('X-RateLimit-Remaining');

$client = new \GuzzleHttp\Client();

$response = $client->get('https://cwick.us/v1/og', [
    'headers' => ['X-API-Key' => $apiKey],
    'query' => ['url' => 'https://github.com'],
]);

$data = json_decode($response->getBody(), true)['data'];
echo $data['title'];  // "GitHub: Let's build from here"

require 'net/http'
require 'json'
require 'uri'

uri = URI('https://cwick.us/v1/screenshot')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Post.new(uri)
request['X-API-Key'] = ENV['CWICKUS_API_KEY']
request['Content-Type'] = 'application/json'
request.body = {
  url: 'https://example.com',
  width: 1920,
  height: 1080,
  format: 'jpeg'
}.to_json

response = http.request(request)

File.open('screenshot.jpg', 'wb') { |f| f.write(response.body) }
puts "Render time: #{response['X-Render-Time-Ms']}ms"

package main

import (
    "bytes"
    "encoding/json"
    "fmt"
    "io"
    "net/http"
    "os"
)

func main() {
    payload, _ := json.Marshal(map[string]interface{}{
        "url":    "https://example.com",
        "width":  1920,
        "height": 1080,
        "format": "jpeg",
    })

    req, _ := http.NewRequest("POST",
        "https://cwick.us/v1/screenshot",
        bytes.NewBuffer(payload))
    req.Header.Set("X-API-Key", os.Getenv("CWICKUS_API_KEY"))
    req.Header.Set("Content-Type", "application/json")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    out, _ := os.Create("screenshot.jpg")
    defer out.Close()
    io.Copy(out, resp.Body)

    fmt.Println("Render time:", resp.Header.Get("X-Render-Time-Ms"), "ms")
}