Lightweight Apify client for .NET. Web scraping and automation platform with 1,600+ ready-made actors. Run scrapers for Amazon, Google, Instagram, Twitter, and more. Features: actor execution, datasets, key-value stores, schedules, webhooks. Simple async interface with dependency injection support.
Lightweight Apify client for .NET. Web scraping and automation platform with 1,600+ ready-made actors for Amazon, Google, Instagram, Twitter, and more.
Features
1,600+ Ready-Made Scrapers - Amazon, Google, Instagram, Twitter, LinkedIn, and more
Run Any Actor - Execute pre-built or custom actors with one method
Datasets - Store and retrieve structured scraping results
Key-Value Stores - Save files, screenshots, and JSON data
Schedules - Automate recurring scrapes with cron expressions
Async Operations - Start jobs and check status later
ASP.NET Core Ready - Built-in dependency injection
Multi-Target - .NET 8, .NET 6, .NET Standard 2.0
Quick Start
Install
dotnet add package ForeverTools.Apify
Get Your API Token
Sign up at Apify to get your API token with free monthly credits.
Basic Usage
using ForeverTools.Apify;
using ForeverTools.Apify.Constants;
var client = new ApifyClient("your-api-token");
// Run a web scraper and get results
var results = await client.ScrapeAsync<Dictionary<string, object>>(
PopularActors.WebScraper,
new
{
startUrls = new[] { new { url = "https://example.com" } },
maxPagesPerCrawl = 10
});
foreach (var item in results)
{
Console.WriteLine(item["url"]);
}
// Start actor and wait for completion
var run = await client.RunActorAsync(
"apify/web-scraper",
new { startUrls = new[] { new { url = "https://example.com" } } },
new ActorRunOptions
{
MemoryMb = 1024,
TimeoutSeconds = 300
});
Console.WriteLine($"Run status: {run.Status}");
Console.WriteLine($"Dataset ID: {run.DefaultDatasetId}");
// Get results from the dataset
var items = await client.GetDatasetItemsAsync<MyDataClass>(run.DefaultDatasetId);
Start Actor Without Waiting
// Start actor and get run ID immediately
var run = await client.StartActorAsync("apify/web-scraper", input);
Console.WriteLine($"Started run: {run.Id}");
// Check status later
var status = await client.GetRunAsync(run.Id);
if (status.IsSucceeded)
{
var items = await client.GetRunDatasetItemsAsync<MyData>(run.Id);
}
Get Run Output from Key-Value Store
// Some actors store their output in key-value stores instead of datasets
var output = await client.RunAndGetOutputAsync<MyOutput>(
"apify/some-actor",
new { url = "https://example.com" },
outputKey: "OUTPUT");
Dataset Operations
// Get items with pagination
var items = await client.GetDatasetItemsAsync<Product>(
datasetId,
new DatasetItemsOptions
{
Offset = 0,
Limit = 100,
Clean = true,
Fields = new List<string> { "title", "price", "url" }
});
// Push items to a dataset
await client.PushDatasetItemsAsync(datasetId, new[]
{
new { title = "Product 1", price = 29.99 },
new { title = "Product 2", price = 39.99 }
});
// List all datasets
var datasets = await client.ListDatasetsAsync();
Key-Value Store Operations
// Get a JSON record
var data = await client.GetKeyValueRecordAsync<MyData>(storeId, "my-key");
// Get a screenshot or file as bytes
var screenshot = await client.GetKeyValueRecordBytesAsync(storeId, "screenshot.png");
File.WriteAllBytes("screenshot.png", screenshot);
// Store data
await client.SetKeyValueRecordAsync(storeId, "my-key", new { foo = "bar" });
// Store a file
var imageBytes = File.ReadAllBytes("image.png");
await client.SetKeyValueRecordAsync(storeId, "image.png", imageBytes, "image/png");
// List all keys
var keys = await client.ListKeyValueStoreKeysAsync(storeId);
Schedule Recurring Runs
// Create a schedule to run an actor daily at 9 AM
var schedule = await client.CreateScheduleAsync(new ScheduleRequest
{
Name = "Daily Amazon Scrape",
CronExpression = "0 9 * * *",
Timezone = "America/New_York",
IsEnabled = true,
Actions = new List<ScheduleAction>
{
new ScheduleAction
{
Type = ScheduleActionTypes.RunActor,
ActorId = "junglee/amazon-crawler",
RunInput = new ScheduleRunInput
{
ContentType = "application/json",
Body = JsonSerializer.Serialize(new { keyword = "laptop" })
}
}
}
});
// List schedules
var schedules = await client.ListSchedulesAsync();
// Update schedule
await client.UpdateScheduleAsync(schedule.Id, new ScheduleRequest
{
IsEnabled = false
});
// Delete schedule
await client.DeleteScheduleAsync(schedule.Id);
Get User Information
var user = await client.GetUserAsync();
Console.WriteLine($"Username: {user.Username}");
Console.WriteLine($"Plan: {user.Plan?.Name}");
Console.WriteLine($"Max concurrent runs: {user.Limits?.MaxConcurrentActorJobs}");
ASP.NET Core Integration
// Program.cs
builder.Services.AddForeverToolsApify("your-api-token");
// Or with full configuration
builder.Services.AddForeverToolsApify(options =>
{
options.Token = "your-api-token";
options.DefaultMemoryMb = 512;
options.DefaultTimeoutSeconds = 600;
options.TimeoutSeconds = 300;
});
// Or from appsettings.json
builder.Services.AddForeverToolsApify(builder.Configuration);
// Inject and use
public class ProductScraperService
{
private readonly ApifyClient _apify;
public ProductScraperService(ApifyClient apify)
{
_apify = apify;
}
public async Task<List<Product>> ScrapeAmazonAsync(string keyword)
{
return await _apify.ScrapeAsync<Product>(
PopularActors.AmazonScraper,
new { keyword, maxItems = 100 });
}
}
Environment Variables
// Uses APIFY_TOKEN by default
var client = ApifyClient.FromEnvironment();
// Or specify custom variable name
var client = ApifyClient.FromEnvironment("MY_APIFY_TOKEN");
