.NET

The official .NET SDK for Autom, with one typed method per endpoint and a generic request() for anything else.

RequirementsCopy Anchor Link

• .NET 8+

InstallCopy Anchor Link

dotnet add package Autom

Get your API keyCopy Anchor Link

Copy your API key from the Autom dashboard and set it in the AUTOM_API_KEY environment variable, which the SDK reads by default. Keep it out of source control.

Quick startCopy Anchor Link

using Autom;

using var client = new AutomClient();
var response = await client.GoogleSearchAsync(new GoogleSearchParams { Query = "web scraping api" });
Console.WriteLine(response.Json);

Async jobsCopy Anchor Link

Any call accepts is_async, which is useful past the 60-second server limit. The response is then a job_id, and the SDK can wait for the job to finish.

var submitted = await client.GoogleSearchAsync(new GoogleSearchParams { Query = "web scraping api", IsAsync = true });
var job = await client.WaitForJobAsync(
    submitted.Json.GetProperty("job_id").GetString()!,
    onProgress: j => Console.WriteLine($"{j.GetProperty("status")} {j.GetProperty("progress")}%"));

ErrorsCopy Anchor Link

A non-2xx response raises an API error with its status and message. See Status codes for the full list.

try
{
    await client.GoogleSearchAsync(new GoogleSearchParams { Query = "web scraping api" });
}
catch (AutomApiException exception)
{
    Console.Error.WriteLine($"{exception.StatusCode}: {exception.Message}");
}

RetriesCopy Anchor Link

Requests are retried up to 3 times after a network error, a 408, 500, 502, 503 or 504, or a plan rate limit. Per-key quota errors and client-side timeouts are not retried. The delay starts at 1 second and grows 1.5× per retry, and a Retry-After header wins.

using var client = new AutomClient(new AutomClientOptions { MaxRetries = 5, RetryDelay = TimeSpan.FromMilliseconds(500) });
await client.GoogleSearchAsync(new GoogleSearchParams { Query = "web scraping api" }, new RequestOptions { MaxRetries = 0 }); // one request without retries

Batch requestsCopy Anchor Link

Run many calls at once, 10 at a time by default. One failure does not stop the others.

string[] inputs = { "web scraping api", "serp api", "rank tracker" };
var results = await client.BatchAsync(inputs, (value, ct) =>
    client.GoogleSearchAsync(new GoogleSearchParams { Query = value }, cancellationToken: ct), concurrency: 5);
foreach (var result in results)
{
    if (result.Ok)
    {
        Console.WriteLine(result.Value!.Json);
    }
    else
    {
        Console.Error.WriteLine($"{inputs[result.Index]}: {result.Error!.Message}");
    }
}

Any endpointCopy Anchor Link

request() reaches any path, including endpoints released after your SDK version.

var response = await client.RequestAsync("GET", "/v1/usage");

Common mistakesCopy Anchor Link

• Putting the API key in front-end code. Anyone could read it. Call the API from your server.
• Treating every 401 as a bad key. A 401 can also be a rate limit: read the message. The SDK retries plan rate limits for you.
• Retrying a 402. It means there are no credits or quota left, so a retry cannot succeed. See Credits.
• Waiting on long requests. Past 60 seconds, use async mode as shown above rather than raising your timeout. See Timeout.

LinksCopy Anchor Link

• Package: Autom
• Source code: github.com/automdev/autom-dotnet
• API reference