Run Apify Cheerio scraper
POST
/acts/apify~cheerio-scraper/runs https://api.apify.com/v2
Parameters
query Query Parameters
| Name | Type |
|---|---|
token
required
Enter your Apify token here | string |
Request Body
application/json
required
interface InputSchema {
startUrls: { url: string; }[];
keepUrlFragments?: boolean;
respectRobotsTxtFile?: boolean;
globs?: { glob: string; }[];
pseudoUrls?: { purl: string; }[];
excludes?: { glob: string; }[];
linkSelector?: string;
pageFunction: string;
proxyConfiguration: {};
proxyRotation?: "RECOMMENDED" | "PER_REQUEST" | "UNTIL_FAILURE";
sessionPoolName?: string;
initialCookies?: unknown[];
additionalMimeTypes?: unknown[];
suggestResponseEncoding?: string;
forceResponseEncoding?: boolean;
ignoreSslErrors?: boolean;
preNavigationHooks?: string;
postNavigationHooks?: string;
maxRequestRetries?: number;
maxPagesPerCrawl?: number;
maxResultsPerCrawl?: number;
maxCrawlingDepth?: number;
maxConcurrency?: number;
pageLoadTimeoutSecs?: number;
pageFunctionTimeoutSecs?: number;
debugLog?: boolean;
customData?: {};
datasetName?: string;
keyValueStoreName?: string;
requestQueueName?: string;
}
startUrls: { url: string; }[];
keepUrlFragments?: boolean;
respectRobotsTxtFile?: boolean;
globs?: { glob: string; }[];
pseudoUrls?: { purl: string; }[];
excludes?: { glob: string; }[];
linkSelector?: string;
pageFunction: string;
proxyConfiguration: {};
proxyRotation?: "RECOMMENDED" | "PER_REQUEST" | "UNTIL_FAILURE";
sessionPoolName?: string;
initialCookies?: unknown[];
additionalMimeTypes?: unknown[];
suggestResponseEncoding?: string;
forceResponseEncoding?: boolean;
ignoreSslErrors?: boolean;
preNavigationHooks?: string;
postNavigationHooks?: string;
maxRequestRetries?: number;
maxPagesPerCrawl?: number;
maxResultsPerCrawl?: number;
maxCrawlingDepth?: number;
maxConcurrency?: number;
pageLoadTimeoutSecs?: number;
pageFunctionTimeoutSecs?: number;
debugLog?: boolean;
customData?: {};
datasetName?: string;
keyValueStoreName?: string;
requestQueueName?: string;
}
Responses
200 application/json
OK
interface RunsResponseSchema {
data?: {
id?: string;
actId?: string;
userId?: string;
startedAt?: string;
finishedAt?: string;
status?: string;
meta?: { origin?: string;userAgent?: string; };
stats?: {
inputBodyLen?: number;
rebootCount?: number;
restartCount?: number;
resurrectCount?: number;
computeUnits?: number;
};
options?: {
build?: string;
timeoutSecs?: number;
memoryMbytes?: number;
diskMbytes?: number;
};
buildId?: string;
defaultKeyValueStoreId?: string;
defaultDatasetId?: string;
defaultRequestQueueId?: string;
buildNumber?: string;
containerUrl?: string;
usage?: {
ACTOR_COMPUTE_UNITS?: number;
DATASET_READS?: number;
DATASET_WRITES?: number;
KEY_VALUE_STORE_READS?: number;
KEY_VALUE_STORE_WRITES?: number;
KEY_VALUE_STORE_LISTS?: number;
REQUEST_QUEUE_READS?: number;
REQUEST_QUEUE_WRITES?: number;
DATA_TRANSFER_INTERNAL_GBYTES?: number;
DATA_TRANSFER_EXTERNAL_GBYTES?: number;
PROXY_RESIDENTIAL_TRANSFER_GBYTES?: number;
PROXY_SERPS?: number;
};
usageTotalUsd?: number;
usageUsd?: {
ACTOR_COMPUTE_UNITS?: number;
DATASET_READS?: number;
DATASET_WRITES?: number;
KEY_VALUE_STORE_READS?: number;
KEY_VALUE_STORE_WRITES?: number;
KEY_VALUE_STORE_LISTS?: number;
REQUEST_QUEUE_READS?: number;
REQUEST_QUEUE_WRITES?: number;
DATA_TRANSFER_INTERNAL_GBYTES?: number;
DATA_TRANSFER_EXTERNAL_GBYTES?: number;
PROXY_RESIDENTIAL_TRANSFER_GBYTES?: number;
PROXY_SERPS?: number;
};
};
}
data?: {
id?: string;
actId?: string;
userId?: string;
startedAt?: string;
finishedAt?: string;
status?: string;
meta?: { origin?: string;userAgent?: string; };
stats?: {
inputBodyLen?: number;
rebootCount?: number;
restartCount?: number;
resurrectCount?: number;
computeUnits?: number;
};
options?: {
build?: string;
timeoutSecs?: number;
memoryMbytes?: number;
diskMbytes?: number;
};
buildId?: string;
defaultKeyValueStoreId?: string;
defaultDatasetId?: string;
defaultRequestQueueId?: string;
buildNumber?: string;
containerUrl?: string;
usage?: {
ACTOR_COMPUTE_UNITS?: number;
DATASET_READS?: number;
DATASET_WRITES?: number;
KEY_VALUE_STORE_READS?: number;
KEY_VALUE_STORE_WRITES?: number;
KEY_VALUE_STORE_LISTS?: number;
REQUEST_QUEUE_READS?: number;
REQUEST_QUEUE_WRITES?: number;
DATA_TRANSFER_INTERNAL_GBYTES?: number;
DATA_TRANSFER_EXTERNAL_GBYTES?: number;
PROXY_RESIDENTIAL_TRANSFER_GBYTES?: number;
PROXY_SERPS?: number;
};
usageTotalUsd?: number;
usageUsd?: {
ACTOR_COMPUTE_UNITS?: number;
DATASET_READS?: number;
DATASET_WRITES?: number;
KEY_VALUE_STORE_READS?: number;
KEY_VALUE_STORE_WRITES?: number;
KEY_VALUE_STORE_LISTS?: number;
REQUEST_QUEUE_READS?: number;
REQUEST_QUEUE_WRITES?: number;
DATA_TRANSFER_INTERNAL_GBYTES?: number;
DATA_TRANSFER_EXTERNAL_GBYTES?: number;
PROXY_RESIDENTIAL_TRANSFER_GBYTES?: number;
PROXY_SERPS?: number;
};
};
}