pygnusocial
3.0
  • API Reference
    • Accounts
    • ActivityStreams
    • Blocking
    • Configuration
    • Data structures
    • Direct messages
    • Exceptions
    • Favorites
    • Friends
    • Friendships
    • Groups
    • Media uploads
    • OAuth
    • Search
    • Statuses
    • Timelines
    • Users
pygnusocial
  • Docs »
  • API Reference »
  • Search
  • View page source

Search¶

search.search(server_url, query, *, page=0, rpp=20, callback=None, username='', password='', oauth={})¶

Returns a collection of statuses matching a specified query.

Parameters:
  • server_url (str) – URL of the server
  • query (str) – UTF-8 encoded query
  • page (int) – (optional) the page number (starting at 1) to return
  • since_id (int) – (optional) returns statuses with an ID greater than (that is, more recent than) the specified ID
  • rpp (int) – (optional) the number of notices to return per page, up to a max of 100
  • callback (str) – if supplied when using the JSON format, the response will use the JSONP format with a callback of the given name
  • username (str) – (optional) name of the authenticating user
  • password (str) – (optional) password of the authenticating user
  • oauth (dict) – (optional) OAuth dict
Return type:

list

Returns:

a list of status dicts

Next Previous

© Copyright Creative Commons CC0 - http://creativecommons.org/publicdomain/zero/1.0/. To the extent possible under law, dtluna has waived all copyright and related or neighboring rights to this work.

Built with Sphinx using a theme provided by Read the Docs.