Wikipedia-API API reference

76 public APIs from Wikipedia-API (martin-majlis/Wikipedia-API) — 35 classes, 29 functions, 12 methods. Signatures extracted by static analysis of the actual source.

Repository: martin-majlis/Wikipedia-API

Kind	Count
Classes	35
Functions	29
Methods	12

API list

classwikipediaapi._enums.coordinates_prop.CoordinatesProp

Property values for coordinates query methods.

classwikipediaapi._enums.direction.Direction

Sort direction values for image query methods.

funcwikipediaapi._enums.direction.direction2str(direction:WikiDirection) -> str

Convert a :class:`WikiDirection` value to a plain ``str``.

classwikipediaapi._enums.geosearch_sort.GeoSearchSort

Sort values for ``geosearch`` method.

classwikipediaapi._enums.globe.Globe

Globe values for geosearch and coordinates methods.

funcwikipediaapi._enums.globe.globe2str(globe:WikiGlobe) -> str

Convert a :class:`WikiGlobe` value to a plain ``str``.

classwikipediaapi._enums.namespace.Namespace

Integer enumeration of MediaWiki namespaces.

funcwikipediaapi._enums.namespace.namespace2int(ns:WikiNamespace) -> int

Convert a :class:`WikiNamespace` value to a plain ``int``.

classwikipediaapi._enums.redirect_filter.RedirectFilter

Filter redirect values for methods like random.

classwikipediaapi._enums.search_info.SearchInfo

Metadata values for search query methods.

funcwikipediaapi._enums.search_info.search_info2str(info:WikiSearchInfo) -> str

Convert a :class:`WikiSearchInfo` value to a plain ``str``.

classwikipediaapi._enums.search_prop.SearchProp

Property values for search query methods.

funcwikipediaapi._enums.search_prop.search_prop2str(prop:WikiSearchProp) -> str

Convert a :class:`WikiSearchProp` value to a plain ``str``.

classwikipediaapi._enums.search_sort.SearchSort

Sort values for ``search`` method.

funcwikipediaapi._enums.search_sort.search_sort2str(sort:WikiSearchSort) -> str

Convert a :class:`WikiSearchSort` value to a plain ``str``.

classwikipediaapi._enums.search_what.SearchWhat

Search type values for search query methods.

funcwikipediaapi._enums.search_what.search_what2str(what:WikiSearchWhat) -> str

Convert a :class:`WikiSearchWhat` value to a plain ``str``.

classwikipediaapi._http_client.sync_http_client.SyncHTTPClient

Blocking HTTP client built on ``httpx.Client``.

methodwikipediaapi._image.wikipedia_image.WikipediaImage.mediatype() -> str | None

MediaWiki media type (e.g.

methodwikipediaapi._image.wikipedia_image.WikipediaImage.mime() -> str | None

MIME type of the file (e.g.

classwikipediaapi._page.wikipedia_page.WikipediaPage

Lazy representation of a Wikipedia page.

methodwikipediaapi._page.wikipedia_page.WikipediaPage.canonicalurl() -> Any

Canonical URL of the page.

methodwikipediaapi._page.wikipedia_page.WikipediaPage.contentmodel() -> Any

Content model of the page (e.g.

methodwikipediaapi._page.wikipedia_page.WikipediaPage.editurl() -> Any

URL for editing the page in the browser.

methodwikipediaapi._page.wikipedia_page.WikipediaPage.fullurl() -> Any

Canonical read URL of the page.

methodwikipediaapi._page.wikipedia_page.WikipediaPage.images() -> ImagesDict

Images (files) used on this page.

methodwikipediaapi._page.wikipedia_page.WikipediaPage.lastrevid() -> Any

Revision ID of the most recent edit.

methodwikipediaapi._page.wikipedia_page.WikipediaPage.length() -> Any

Page size in bytes.

methodwikipediaapi._page.wikipedia_page.WikipediaPage.pagelanguage() -> Any

BCP-47 language code of the page content.

methodwikipediaapi._page.wikipedia_page.WikipediaPage.sections() -> list[WikipediaPageSection]

Top-level sections of this page.

methodwikipediaapi._page.wikipedia_page.WikipediaPage.talkid() -> Any

Page ID of the associated talk page.

classwikipediaapi._params.geo_search_params.GeoSearchParams

Parameters for ``list=geosearch`` (prefix ``gs``).

classwikipediaapi._params.imageinfo_params.ImageInfoParams

Parameters for ``prop=imageinfo`` (prefix ``ii``).

classwikipediaapi._params.images_params.ImagesParams

Parameters for ``prop=images`` (prefix ``im``).

classwikipediaapi._params.random_params.RandomParams

Parameters for ``list=random`` (prefix ``rn``).

classwikipediaapi._params.search_params.SearchParams

Parameters for ``list=search`` (prefix ``sr``).

classwikipediaapi._types.geo_point.GeoPoint

A geographic point with latitude/longitude validation.

classwikipediaapi._wikipedia.async_wikipedia.AsyncWikipedia

Asynchronous client for the Wikipedia API.

classwikipediaapi._wikipedia.wikipedia.Wikipedia

Synchronous client for the Wikipedia API.

funcwikipediaapi.cli.cli() -> click.Group

Command line tool for querying Wikipedia using Wikipedia-API.

funcwikipediaapi.cli.main() -> None

Entry point for the CLI.

classwikipediaapi.commands.base.CategoryMember

TypedDict for category member information.

classwikipediaapi.commands.base.CoordinateInfo

TypedDict for coordinate information.

classwikipediaapi.commands.base.GeoSearchKwargs

TypedDict for geosearch method keyword arguments.

classwikipediaapi.commands.base.GeoSearchResult

TypedDict for geosearch result information.

classwikipediaapi.commands.base.PageInfo

TypedDict for page information.

classwikipediaapi.commands.base.PageNotFoundError

Raised when a Wikipedia page does not exist.

classwikipediaapi.commands.base.RandomKwargs

TypedDict for random method keyword arguments.

classwikipediaapi.commands.base.RandomPageResult

TypedDict for random page result information.

classwikipediaapi.commands.base.SearchKwargs

TypedDict for search method keyword arguments.

classwikipediaapi.commands.base.SearchResult

TypedDict for search result information.

classwikipediaapi.commands.base.SearchResults

TypedDict for search results container.

classwikipediaapi.commands.base.SectionInfo

TypedDict for section information.

classwikipediaapi.commands.base.SectionNotFoundError

Raised when a Wikipedia section does not exist.

func

wikipediaapi.commands.base.fetch_page(wiki:wikipediaapi.Wikipedia, title:str, namespace:int) -> wikipediaapi.WikipediaPage

Get a WikipediaPage from the given Wikipedia instance.

funcwikipediaapi.commands.base.format_page_dict(pages:wikipediaapi.PagesDict, output_format:str) -> str

Format a PagesDict in the requested format as a string.

funcwikipediaapi.commands.base.format_page_info(info:PageInfo, output_format:str) -> str

Format page info in the requested format.

funcwikipediaapi.commands.base.format_sections(sections:list[SectionInfo], output_format:str) -> str

Format sections list in the requested format.

funcwikipediaapi.commands.base.parse_bbox_string(bbox_str:str) -> wikipediaapi.GeoBox

Parse bounding box string in format 'lat1|lon1|lat2|lon2'.

funcwikipediaapi.commands.category_commands.format_category_members(members:list[CategoryMember], output_format:str) -> str

Format category members in the requested format.

func

wikipediaapi.commands.category_commands.get_category_members(wiki:wikipediaapi.Wikipedia, title:str, max_level:int=0, namespace:int=0) -> list[CategoryMember]

Get pages in a Wikipedia category.

func

wikipediaapi.commands.category_commands.get_page_categories(wiki:wikipediaapi.Wikipedia, title:str, namespace:int=0) -> wikipediaapi.PagesDict

Get categories for a Wikipedia page.

funcwikipediaapi.commands.geo_commands.format_coordinates(coords:list[CoordinateInfo], output_format:str) -> str

Format coordinates in the requested format.

funcwikipediaapi.commands.geo_commands.format_geosearch(results:list[GeoSearchResult], output_format:str) -> str

Format geosearch results in the requested format.

funcwikipediaapi.commands.link_commands.format_langlinks(langlinks, output_format:str) -> str

Format language links in the requested format.

funcwikipediaapi.commands.link_commands.get_langlinks(wiki:wikipediaapi.Wikipedia, title:str, namespace:int=0) -> Any

Get language links for a Wikipedia page.

func

wikipediaapi.commands.link_commands.get_page_backlinks(wiki:wikipediaapi.Wikipedia, title:str, namespace:int=0) -> wikipediaapi.PagesDict

Get pages that link to a Wikipedia page.

func

wikipediaapi.commands.link_commands.get_page_links(wiki:wikipediaapi.Wikipedia, title:str, namespace:int=0) -> wikipediaapi.PagesDict

Get pages linked from a Wikipedia page.

func

wikipediaapi.commands.page_commands.get_page_sections(wiki:wikipediaapi.Wikipedia, title:str, namespace:int=0) -> list[SectionInfo]

Get sections of a Wikipedia page.

funcwikipediaapi.commands.page_commands.get_page_summary(wiki:wikipediaapi.Wikipedia, title:str, namespace:int=0) -> str

Get the summary of a Wikipedia page.

funcwikipediaapi.commands.page_commands.get_page_text(wiki:wikipediaapi.Wikipedia, title:str, namespace:int=0) -> str

Get the full text of a Wikipedia page.

func

wikipediaapi.commands.page_commands.get_section_text(wiki:wikipediaapi.Wikipedia, title:str, section_title:str, namespace:int=0) -> str

Get the text of a specific section.

funcwikipediaapi.commands.search_commands.format_random(results:list[RandomPageResult], output_format:str) -> str

Format random page results in the requested format.

funcwikipediaapi.commands.search_commands.format_search(results:SearchResults, output_format:str) -> str

Format search results in the requested format.

classwikipediaapi.exceptions.wiki_http_timeout_error.WikiHttpTimeoutError

Raised when a request to Wikipedia API times out.

classwikipediaapi.exceptions.wikipedia_exception.WikipediaException

Base exception for all Wikipedia-API errors.

About this data

These signatures were extracted from the public source of martin-majlis/Wikipedia-API using Python's ast module. Argument names, default values, type annotations and return types are taken verbatim from the code. Implementation bodies are never stored. See how it works for details.

Back to all 805 libraries