outscraper 0.3.5 → 0.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9476b68f4bd7fc5b7af263cc5cb28b5e753960d760c44d1e697681123aee6236
-  data.tar.gz: 298ec43dbdec09108bbf6e98660b0e1150dce799d3408740a2c6d8fdbfd33c43
+  metadata.gz: 36bc03b48faddd06287b3c11a0c457a80412221cc752e19834419b66791eb83b
+  data.tar.gz: 2d46d01a94f94ffd1cbd39d8718ecf6c31172ae9a274f9380f365295a5115454
 SHA512:
-  metadata.gz: fb819008c8e1a0e634c4a73779842810153156b7c22fc2ce94954e8a030ee363d8dc57127a0db61e190b40dab50d349a93c852d5faf1ebe1cefeba7b7674dde0
-  data.tar.gz: 2b8beb1a3fdf33a45d0bfc20f293516b535106dfb723f5499f831fea583e5f5788423033939665ce109536ac804ecb2b47dd17f016265f860c45efdb197a7fe2
+  metadata.gz: c359daeb150ec3e8c527b3d1e25cde39decf289215f17d47707089ca0d4e61de61a2ae8e837686bd3521e22f44c9746b5d0a73454dc3bf5ee4b6ddc06fa076e4
+  data.tar.gz: 715e674806c05bf2daf94f153b5c30c04639b4a6452178b82adb361cddca5c8e97d32783b5dc72f78569f541149f8ed2099fca624f75381346736c9363c433fb

data/README.md

@@ -22,7 +22,7 @@ require 'Outscraper'
 
 client = Outscraper::Client.new('SECRET_API_KEY')
 ```
-[Link to the profile page to create the API key](https://app.outscraper.com/profile)
+[Link to the account page to create the API key](https://app.outscraper.com/account/api)
 
 ## Usage
 

data/examples/Businesses.md

@@ -0,0 +1,123 @@
+# Businesses Search With Ruby
+
+The library provides real-time access to business records via the [Outscraper API](https://app.outscraper.com/api-docs).
+It supports classic structured filters and AI-powered plain-text queries for flexible search.
+
+- Structured search using `filters`, `fields`, `limit`, and other parameters
+- AI-powered search using the `query` parameter
+- Combined mode where structured params and `query` are merged by the server
+
+---
+
+## Installation
+
+Install the gem and add it to the application's Gemfile by executing:
+
+```bash
+bundle add outscraper
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install outscraper
+```
+
+[Link to the Ruby package page](https://rubygems.org/gems/outscraper)
+
+---
+
+## Initialization
+
+```ruby
+require "outscraper"
+
+client = Outscraper::Client.new("SECRET_API_KEY")
+```
+
+[Link to the profile page to create the API key](https://app.outscraper.com/profile)
+
+---
+
+## Usage
+
+### Search businesses with structured filters
+
+```ruby
+results = client.businessesSearch(
+  filters: {
+    country_code: "US",
+    states: ["NY"],
+    cities: ["New York", "Buffalo"],
+    types: ["restaurant", "cafe"],
+    has_website: true,
+    has_phone: true,
+    business_statuses: ["operational"]
+  },
+  limit: 50,
+  include_total: false,
+  fields: ["name", "phone", "website", "address", "rating", "reviews"]
+)
+
+puts results
+```
+
+### Search businesses with AI plain-text query
+
+```ruby
+results = client.businessesSearch(
+  query: "Find cafes in New York, NY. Limit 25. Return name, address, phone, website, rating and reviews."
+)
+
+puts results
+```
+
+### Combine structured params and plain-text query
+
+```ruby
+results = client.businessesSearch(
+  filters: {
+    country_code: "US",
+    states: ["CA"],
+    types: ["restaurant"]
+  },
+  fields: ["name", "phone"],
+  limit: 15,
+  query: "Add cafes too. Return address and reviews. Limit 20. Include total."
+)
+
+puts results
+```
+
+When both structured params and `query` are provided:
+
+- `filters` and `fields` are merged
+- for `limit`, `cursor`, and `include_total`, plain-text values take priority when present
+- if a value is not specified, API defaults are used
+
+### Iterate through all results (auto-pagination)
+
+```ruby
+items = client.businessesIterSearch(
+  filters: {
+    country_code: "US",
+    states: ["NY"],
+    business_statuses: ["operational"]
+  },
+  limit: 100,
+  fields: ["name", "phone", "address", "rating", "reviews"]
+)
+
+puts items.length
+```
+
+### Get business details by ID
+
+```ruby
+business = client.businessesGet(
+  "YOUR_BUSINESS_ID",
+  fields: ["name", "phone", "website", "address", "rating", "reviews"]
+)
+
+puts business
+```

data/lib/outscraper/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Outscraper
-  VERSION = "0.3.5"
+  VERSION = "0.3.6"
 end

data/lib/outscraper.rb

@@ -414,7 +414,8 @@ module Outscraper
       fields: nil,
       async_request: false,
       ui: false,
-      webhook: nil
+      webhook: nil,
+      query: nil
     )
       payload = {
         filters: (filters || {}),
@@ -422,6 +423,7 @@ module Outscraper
         include_total: include_total,
         cursor: cursor,
         fields: fields ? Array(fields) : nil,
+        query: query,
         async: async_request,
         ui: ui,
         webhook: webhook

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: outscraper
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.3.6
 platform: ruby
 authors:
 - Outscraper
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-01-26 00:00:00.000000000 Z
+date: 2026-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -39,6 +39,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- examples/Businesses.md
 - examples/Company Insights.md
 - examples/Company Website Finder.md
 - examples/Contacts And Leads.md