Infobox Results

Back to top

Hint

There is still no typing for these result items. The templates can be used as orientation until the final typing is complete.

The area info box is an area where addtional infos shown to the user.

Fields used in the :

img_src: str : URL of a image or thumbnail that is displayed in the infobox.

infobox: str : Title of the info box.

content: str : Text of the info box.

The infobox has additional subsections for attributes, urls and relatedTopics:

attributes: List[dict] : A list of attributes. An attribute is a dictionary with keys:

- label [`str`](https://docs.python.org/3/builtins/stdtypes.html#str): (mandatory)
- value [`str`](https://docs.python.org/3/builtins/stdtypes.html#str): (mandatory)
- image [`List`](https://docs.python.org/3/builtins/stdtypes.html#list)[[`dict`](https://docs.python.org/3/builtins/stdtypes.html#dict)] (optional)

  A list of images. An *image* is a dictionary with keys:

  - src [`str`](https://docs.python.org/3/builtins/stdtypes.html#str): URL of an image/thumbnail (mandatory)
  - alt [`str`](https://docs.python.org/3/builtins/stdtypes.html#str): alternative text for the image (mandatory)

urls: List[dict] : A list of links. An link is a dictionary with keys:

- url [`str`](https://docs.python.org/3/builtins/stdtypes.html#str): URL of the link (mandatory)
- title [`str`](https://docs.python.org/3/builtins/stdtypes.html#str): Title of the link (mandatory)

relatedTopics: List[dict] : A list of topics. An topic is a dictionary with keys:

- name: [`str`](https://docs.python.org/3/builtins/stdtypes.html#str): (mandatory)
- suggestions: [`List`](https://docs.python.org/3/builtins/stdtypes.html#list)[[`dict`](https://docs.python.org/3/builtins/stdtypes.html#dict)] (optional)

  A list of suggestions. A *suggestion* is simple dictionary with just one
  key/value pair:

  - suggestion: [`str`](https://docs.python.org/3/builtins/stdtypes.html#str): suggested search term (mandatory)

Copyright © SearXNG team

Made with Furo

💾 🌐