Skip to content
Back to top
View this page
Edit this page

# Demo Online Engine

Within this module we implement a demo online engine. Do not look to close to the implementation, its just a simple example which queries The Art Institute of Chicago

## Configuration

To get in use of this demo engine add the following entry to your engines list in `settings.yml`:

    - name: my online engine
      engine: demo_online
      shortcut: demo
      disabled: false

## Implementations

searx.engines.demo_online.setup(engine_settings: OnlineParams) → bool

  Dynamic setup of the engine settings.

  For more details see `searx.enginelib.Engine.setup`.

searx.engines.demo_online.init(engine_settings: dict[str, Any]) → bool

  Initialization of the engine.

  For more details see `searx.enginelib.Engine.init`.

searx.engines.demo_online.request(query: str, params: OnlineParams) → None

  Build up the `params` for the online request. In this example we build a URL to fetch images from artic.edu.

searx.engines.demo_online.response(resp: SXNG_Response) → EngineResults

  Parse out the result items from the response. In this example we parse the response from api.artic.edu and filter out all images.