Splash Lua API Overview

Splash provides a lot of methods, functions and properties; all of them are documented in Splash Scripts Reference, Available Lua Libraries, Element Object, Request Object, Response Object and Working with Binary Data. Here is a short description of the most used ones:

Script as an HTTP API endpoint

Each Splash Lua script can be seen as an HTTP API endpoint, with input arguments and structured result value. For example, you can emulate render.png endpoint using Lua script, including all its HTTP arguments.

Delays

Extracting information from a page

Screenshots

Interacting with a page

Making HTTP requests

  • splash:http_get - send an HTTP GET request and get a response without loading page to the browser;
  • splash:http_post - send an HTTP POST request and get a response without loading page to the browser;

Inspecting network traffic

Browsing Options