Pxshot 1.0.0

Pxshot .NET SDK

The official .NET SDK for the Pxshot screenshot API.

Installation

dotnet add package Pxshot

Quick Start

using Pxshot;
using Pxshot.Models;

var client = new PxshotClient("px_your_api_key");

// Capture a screenshot as bytes
byte[] imageBytes = await client.ScreenshotAsync(new ScreenshotRequest
{
    Url = "https://example.com"
});

// Save to file
await File.WriteAllBytesAsync("screenshot.png", imageBytes);

Features

• ✅ .NET 6, 7, and 8 support
• ✅ Async-first API
• ✅ Strongly-typed request/response models
• ✅ Rate limit header parsing
• ✅ Comprehensive exception handling
• ✅ Zero external dependencies (uses System.Text.Json)

Usage Examples

Basic Screenshot

var client = new PxshotClient("px_your_api_key");

byte[] image = await client.ScreenshotAsync(new ScreenshotRequest
{
    Url = "https://example.com"
});

Full Page Screenshot with Options

byte[] image = await client.ScreenshotAsync(new ScreenshotRequest
{
    Url = "https://example.com",
    Format = "png",
    Width = 1920,
    Height = 1080,
    FullPage = true,
    DeviceScaleFactor = 2,
    WaitUntil = "networkidle",
    BlockAds = true
});

Store Screenshot and Get URL

var result = await client.ScreenshotWithStorageAsync(new ScreenshotRequest
{
    Url = "https://example.com"
});

Console.WriteLine($"Screenshot URL: {result.Url}");
Console.WriteLine($"Expires at: {result.ExpiresAt}");
Console.WriteLine($"Size: {result.SizeBytes} bytes");

Wait for Specific Element

byte[] image = await client.ScreenshotAsync(new ScreenshotRequest
{
    Url = "https://example.com",
    WaitForSelector = ".main-content",
    WaitForTimeout = 2000 // Additional 2 second wait
});

Check Usage Statistics

var usage = await client.GetUsageAsync();

Console.WriteLine($"Screenshots taken: {usage.ScreenshotsTaken}");
Console.WriteLine($"Screenshots remaining: {usage.ScreenshotsRemaining}");
Console.WriteLine($"Period ends: {usage.PeriodEnd}");

Monitor Rate Limits

var client = new PxshotClient("px_your_api_key");

await client.ScreenshotAsync(new ScreenshotRequest { Url = "https://example.com" });

if (client.LastRateLimitInfo is { } rateLimit)
{
    Console.WriteLine($"Rate limit: {rateLimit.Remaining}/{rateLimit.Limit}");
    Console.WriteLine($"Resets at: {rateLimit.Reset}");
}

Using Custom HttpClient

// Useful for dependency injection or custom configurations
var httpClient = new HttpClient();
httpClient.Timeout = TimeSpan.FromMinutes(2);

var client = new PxshotClient("px_your_api_key", null, httpClient);

Custom Base URL

// For self-hosted or staging environments
var client = new PxshotClient("px_your_api_key", "https://staging-api.pxshot.com");

Exception Handling

using Pxshot.Exceptions;

try
{
    var image = await client.ScreenshotAsync(new ScreenshotRequest
    {
        Url = "https://example.com"
    });
}
catch (RateLimitException ex)
{
    Console.WriteLine($"Rate limited. Retry after: {ex.RetryAfter}");
    if (ex.RateLimitInfo is { } info)
    {
        Console.WriteLine($"Limit: {info.Limit}, Remaining: {info.Remaining}");
    }
}
catch (AuthenticationException ex)
{
    Console.WriteLine($"Authentication failed: {ex.Message}");
}
catch (ValidationException ex)
{
    Console.WriteLine($"Invalid request: {ex.Message}");
}
catch (PxshotException ex)
{
    Console.WriteLine($"API error ({ex.StatusCode}): {ex.Message}");
}

Request Options

License

MIT License - see LICENSE for details.