Developer guides
Use the official RubyGems beta gem from Rails apps, scripts, and background jobs. Typed, batteries-included grouped helpers and dynamic operation calls.
Verified HTTP pattern
POST /google/search
Request
POST https://api.crawlora.net/api/v1/google/search
x-api-key: $CRAWLORA_API_KEY
Content-Type: application/json
{
"country": "us",
"keyword": "best CRM software",
"language": "en",
"limit": 10,
"page": 1
}Base URL
https://api.crawlora.net/api/v1
Auth header
x-api-key
Example endpoint
POST /google/search
The Ruby SDK is published to RubyGems as the crawlora gem and developed at https://github.com/Crawlora-org/crawlora-ruby-sdk. The current promoted beta is a prerelease (1.5.0.pre.sdk.3); install it with the --pre flag or pin it in your Gemfile. Requires Ruby 3.0+.
Developer workflow
RubyGems treats the -sdk. segment as a prerelease, so install with the --pre flag or pin the prerelease version in your Gemfile.
# Gemfile gem "crawlora", "1.5.0.pre.sdk.3" # or install directly (prerelease) gem install crawlora --pre
Developer workflow
export CRAWLORA_API_KEY="your_api_key_here"
Developer workflow
Create a client, then call grouped endpoint helpers or the dynamic operation interface.
require "crawlora"
# Reads CRAWLORA_API_KEY from the environment if api_key: is omitted.
client = Crawlora.client(api_key: ENV["CRAWLORA_API_KEY"])
result = client.bing.search(q: "coffee shops")
result["data"].each { |item| puts item["title"] }
client.close # release pooled keep-alive connectionsDeveloper workflow
The status codes below are common integration patterns. Endpoint detail pages list documented failure responses where available.
| Status / code | Meaning | How to handle |
|---|---|---|
| 400 | Invalid request or missing required input. | Validate request bodies before calling Crawlora and surface useful messages to users. |
| 401 | Missing or invalid API key. | Check the `x-api-key` header and rotate the key from the console if needed. |
| 402/403 | Plan, permission, or billing issue where applicable. | Check plan access, credit state, and endpoint availability. |
| 429 | Rate limit exceeded. | Back off with jitter and reduce concurrency. |
| 5xx | Temporary execution or upstream failure. | Retry safe jobs with exponential backoff and keep the failure visible. |
Developer workflow
Use Crawlora for structured public web data workflows. Customers are responsible for compliance with applicable laws, third-party rights, platform rules, and Crawlora terms. Keep API keys server-side, validate inputs, and avoid collecting or storing unnecessary sensitive data.
Read Crawlora termsDeveloper workflow
Use these pages to move between endpoint discovery, examples, pricing, and responsible-use guidance.
Developer workflow
Common questions for this Crawlora developer integration path.
Yes. The official Ruby beta gem is published to RubyGems as crawlora and developed at https://github.com/Crawlora-org/crawlora-ruby-sdk. Install it with gem install crawlora --pre.
Ruby 3.0 or newer.
RubyGems treats the -sdk. segment as a prerelease, so the current beta resolves as a .pre.sdk version. Use the --pre flag or pin the prerelease string in your Gemfile.
Pass api_key: to Crawlora.client, or omit it to read CRAWLORA_API_KEY from the environment. JWT authorization is also supported.
Yes. Use it in controllers, services, or workers; the client supports a block form that auto-closes pooled connections.
Open the endpoint detail page from the docs catalog to inspect request parameters, examples, and schema references.
Install the crawlora gem with --pre, set CRAWLORA_API_KEY, then inspect endpoint docs for platform-specific schemas.