Toraware Tanach Search API

API Version: 1.0

Structured API access to the Tanach corpus.


Overview

The Toraware Tanach Search API provides programmatic access to the search engine used on toraware.org. Supported methods include word and phrase searches, gematria queries, acronym searches, and skip-based (qd) analysis.

This API is read-only and returns deterministic results across the Tanach corpus.


Who This API Is For

For manual searches, use the main site interface.


Corpus Scope


Quick Start

The API exposes a single endpoint for structured queries. Queries are validated server-side and return JSON responses. See the examples below and replace values as needed.

Search Example

POST https://toraware/api/search
    Content-Type: application/json

    {
      "method": "ph",
      "option1": "1",
      "option2": "1",
      "startNum": 1,
      "endNum": 88,
      "hitLimit": 9999,
      "query": "קן בשם"
    }
    

Parameter details and method-specific behavior are defined in the OpenAPI specification.


Home → Developers → API Demo

API Resources

📘 OpenAPI Specification

🧪 Interactive API Demo


Using Postman (Optional)

Developers may import the OpenAPI schema into Postman to explore endpoints and test queries.

  1. Open Postman
  2. Import openapi.json
  3. Use the POST search endpoint: https://toraware/api/search
  4. Ensure Content-Type: application/json is set and replace placeholder values in the JSON body as needed
  5. Run the request and inspect the JSON response

This step is optional and not required to use the API.

Advanced / Experimental Usage

The qd method is currently limited to skip intervals that are practical for standard hardware (e.g., 1–50, 301–350) to ensure reasonable response times.

Skip intervals refer to how many letters to skip in the Torah between each letter of the string when searching for equidistant sequences. The search domain is strictly the Torah (books 1–54).

For developers with access to high-performance systems, it may be possible to execute extended qd searches over very large skip intervals (e.g., 1–10,000), enabling a greater likelihood of detecting a user’s letter sequence. Within over 304,000 letters in Torah, the combinatorial search space is vast, and many potential matches exist at skip intervals that exceed the practical limits of standard computing environments.

If you are interested in exploring or developing this capability, please contact us to discuss collaboration.


Stability and Usage Notes


Attribution

Please attribute Toraware (toraware.org) when referencing API results in external projects or publications.


Contact

For API questions or integration assistance, visit toraware.org.


This page is a technical entry point. End users should use the main site interface for interactive searching.