Trawley
Getting started

Quickstart

Query a Trawley scraper from your code in five minutes.

Trawley turns any website into a natural language search API. You build a scraper once in the dashboard, and Trawley keeps it indexed so your code can ask questions like "3 bed houses under £500k with parking" and get structured JSON back.

This quickstart gets you from a finished scraper to your first API response.

You need a scraper that has run at least once. If you have not built one yet, start with the no-code setup wizard, then come back here.

Steps

Grab your scraper ID

Open your scraper in the dashboard at app.trawley.ai. The ID is the last segment of the URL:

text
https://app.trawley.ai/scrapers/scr_8f2a1c9e
                                 ^^^^^^^^^^^^

Call the search endpoint

The recommended endpoint is hybrid search. Pass a natural language query in the search parameter:

cURL
curl "https://api.trawley.ai/v1/scrapers/scr_8f2a1c9e/hybrid?search=3+bed+houses+with+a+garden"

::

Read the results

You get back structured records matching the query, plus pagination metadata:

json
{
  "data": [
    { "title": "3 bed semi in Kendal", "price": 425000, "bedrooms": 3 }
  ],
  "pagination": { "total": 18, "page": 1, "take": 10, "totalPages": 2, "hasMore": true },
  "meta": { "filter": "bedrooms = 3" }
}

::

That is the whole loop: one GET request, structured results, no HTML parsing.

The API is currently reached by scraper ID and does not yet require an API key. Authentication is coming. See the API overview for what that means for you today.

What's next