Method: ScraperWiki::API#scraper_search

Defined in:
lib/scraperwiki-api.rb

#scraper_search(opts = {}) ⇒ Array

Search the titles and descriptions of all the scrapers.

Example output:

[
  {
    "description": "Scrapes websites for data.",
    "language": "ruby",
    "created": "1970-01-01T00:00:00",
    "title": "Example scraper",
    "short_name": "example-scraper",
    "privacy_status": "public"
  },
  ...
]

Parameters:

  • opts (Hash) (defaults to: {})

    optional arguments

Options Hash (opts):

  • :searchquery (String)

    search terms

  • :maxrows (Integer)

    number of results to return [default 5]

  • :requestinguser (String)

    the name of the user making the search, which changes the order of the matches

Returns:

  • (Array)


299
300
301
# File 'lib/scraperwiki-api.rb', line 299

def scraper_search(opts = {})
  request_with_apikey '/scraper/search', opts
end