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

# Z-Library

Z-Library (abbreviated as z-lib, formerly BookFinder) is a shadow library project for file-sharing access to scholarly journal articles, academic texts and general-interest books. It began as a mirror of Library Genesis, from which most of its books originate.

## Configuration

The engine has the following additional settings:

- `zlib_year_from`

- `zlib_year_to`

- `zlib_ext`

With this options a SearXNG maintainer is able to configure additional engines for specific searches in Z-Library. For example a engine to search only for EPUB from 2010 to 2020.

    - name: z-library 2010s epub
      engine: zlibrary
      shortcut: zlib2010s
      zlib_year_from: '2010'
      zlib_year_to: '2020'
      zlib_ext: 'EPUB'

## Implementations

searx.engines.zlibrary.zlib_year_from: str = ''

  Filter z-library’s results by year from. E.g ‘2010’.

searx.engines.zlibrary.zlib_year_to: str = ''

  Filter z-library’s results by year to. E.g. ‘2010’.

searx.engines.zlibrary.zlib_ext: str = ''

  Filter z-library’s results by a file ending. Common filters for example are `PDF` and `EPUB`.

searx.engines.zlibrary.setup(engine_settings: dict [ str , Any ]) → bool

  Check of engine’s settings.

searx.engines.zlibrary.fetch_traits(engine_traits: EngineTraits ) → None

  Fetch languages and other search arguments from zlibrary’s search form.