project.create

project.create

Used to create an on-page project. By default, a domain is specified and a project name is set. Additionally, you can configure a crawl limit and crawl frequency, determining how often the project should be crawled. Keywords can be added to the project using the kw parameter. To avoid unexpected charges, the acknowledge_extra_cost parameter must be set if creating more projects than your profile limit allows. Note that only one project can be created every 20 seconds.

Result

If no error message is displayed, the project has been successfully created. The result includes the domain of the created project (domain), the project hash (project_hash), and the project name (project_name). Additionally, the result contains the set crawl limit (crawl_limit) and the specified frequency (frequency).

GET-Parameters

Parameters (Mandatory)

api_key
STRING
Your personal API key. This key is used to authenticate your requests. You can obtain it here.
address_object
STRING
Defines the domain, host, path, or URL to which the method is applied, depending on the key value provided.

Parameters (Optional)

acknowledge_extra_cost
BOOLEAN
Allows exceeding the project limit of the profile. Each project beyond the limit incurs additional costs. By setting this parameter to true, you acknowledge and accept these costs.
crawl_limit
INTEGER
Sets the crawl limit for the on-page project. The maximum number of pages that can be crawled is 25,000, with a default limit of 10,000.
project_name
STRING
Sets the name for the on-page project. The default name is the domain used.
frequency
STRING
Sets the frequency for each crawl of the on-page project. Available parameters are: "weekly" to schedule a weekly crawl or "manual" for manual crawls, which must be initiated manually.
kw
STRING
Adds up to 40 keywords to the on-page project. The keywords should be provided in an array format, e.g., ["kw1", "kw2"].
format
STRING
Specifies whether the response will be returned in XML or JSON format. By default, the result will be in XML format.
To be able to use the API documentation with real data, you have to create an API key in your account.
EXAMPLE
$baseUrl = "https://api.sistrix.com/project.create";

$post = [



];

$curl = curl_init();

curl_setopt($curl, CURLOPT_URL, $baseUrl);

curl_setopt($curl, CURLOPT_POSTFIELDS, $post);

curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);

$response = curl_exec($curl);

curl_close($curl);
import requests

baseUrl = 'https://api.sistrix.com/project.create'

post = {



}

response = requests.post(baseUrl, post)

data = response.text
curl https://api.sistrix.com/project.create \


let baseUrl = 'https://api.sistrix.com/project.create';

let form = new FormData();



fetch(baseUrl, {

    method: 'POST',

    body: form

}).then(function(response){

    return response.text();

}).then(function(data){

    //data contains the results of the request

})
Testing is not supported for this function.