POST/v1/batches

Start Batch

Starts a new batch. You receive an `id` that you can use to track the progress of the batch as shown [here](/api-reference/batches/info). Note: Processing time is constant regardless of batch size

Olostep·Dynamic pricing

Dynamic pricing

(body.items.length * 0.01) + 0.01

Example code

// Using @orth/sdk - The simplest way to call APIs
// Install: npm install @orth/sdk
import Orthogonal from "@orth/sdk";

const orthogonal = new Orthogonal({
  apiKey: process.env.ORTHOGONAL_API_KEY,
});

const output = await orthogonal.run({
  api: "olostep",
  path: "/v1/batches",
  body: {
    "items": "value"
  }
});

console.log(output);

Body parameters

itemsrequired

object[]

Array of items to be processed in the batch.

country

string

Country for the batch execution. Provide in ISO 3166-1 alpha-2 codes like US(USA), IN(India), etc

parser

object

You can use this parameter to specify the parser to use. Parsers are useful to extract structured content from web pages. Olostep has a few parsers built in for most common web pages, and you can also create your own parsers.

links_on_page

object

Get all the links present on each page in the batch.

Response

string

object

string

parser

string

status

string

country

string

created

number

start_date

string

total_urls

number

batch_parser

string

batch_country

string

completed_urls

number

number_retried

number