API Setup

This section covers the essentials you need to know to start utilizing our API for your scraper projects. With the PullNode API, you can programmatically manage your scrapers, retrieve data, and integrate PullNode's capabilities into your applications.

Creating an API Key

Before you can use the API, you'll need an API key. Follow these steps to create one:

1. Go to the "API" section in your project dashboard.
2. Scroll to "Add New Key".
3. Enter a name for your key and click "Create".

You'll see your new key listed under "Keys". You can manage its settings or remove it at any time.

Using the API

You can use the API directly in the browser as a URL to start the scraper or get data. It can also be integrated into software applications for automated data scraping and analysis. Each API call is authenticated using your API key.

Base URL

https://v1.pullnode.com/{SCRAPER_ID}

Replace {SCRAPER_ID} with your actual scraper project ID from the API builder on your dashboard. This ID is unique for each user.

Authorization

Append your API key to the request URL as a query parameter:

?key=YOUR_PRIVATE_KEY

Example Request

https://v1.pullnode.com/12345?key=YOUR_PRIVATE_KEY&run_now=true&save_current=true&amount=1&index=0&format=json&parameter_PAGE_NUMBER=15&parameter_SEARCH_QUERY=Cars

This request will start the scraper with ID 12345, run it, save the current data, and return this page of results in JSON format. It will also set the PAGE_NUMBER URL dynamic parameter to 15 and the SEARCH_QUERY URL dynamic parameter to "Cars".

URL Parameters

Parameter	Explanation	Variable Type	Required	Default
key	Your private API key	String	Yes	N/A
run_now	Runs the scraper immediately. Otherwise, returns the latest data.	Boolean	No	true
save_current	Creates a historical data set from this API run.	Boolean	No	true
amount	Number of data sets to return. Includes current if run_now is true.	Integer	No	1
index	Starting index for retrieving historical data sets.	Integer	No	0
format	The format of the returned data.	String	No	json
parameter_PAGE_NUMBER	The page number to retrieve in your scraper.	Integer	No	User set
parameter_SEARCH_QUERY	The search query for the scraper.	String	No	User set

Dynamic Parameters

Dynamic parameters such as parameter_PAGE_NUMBER and parameter_SEARCH_QUERY allow you to customize the scraper request. They are set in the API URL and correspond to the dynamic parameters you've defined in your URLs setup.

Integrations

PullNode's API can be easily integrated with other software applications for automated scraping, data analysis, and more. For examples of integrations and further instructions, refer to our Integrations Documentation.

Quotas and Limits

Each API key comes with a quota, which you can manage in the key settings. You can view your current usage, the total quota for the period, and the next reset date. Quotas are reset based on the period selected (Day, Week, Month, Quarter, Half-year, Year).