EirePlan
    Eireplan API
    Endpoints

    Precedents API

    Overview of the precedents API and its request pages.

    Use the precedents API to search planning applications and retrieve full precedent records. This API is useful when you need to discover relevant cases first and then fetch a complete record for one result.

    #What This API Covers

    • Search across planning applications and decisions.
    • Filter by authority, status, decision, and text query.
    • Retrieve a single precedent with richer detail, geometry flags, and official links.

    #Resource Shape

    The core resource is a precedent under /ext/v1/precedents.

    • Use the search request to find candidate precedents.
    • Use the detail request once you have a precedent id.
    • Expect search responses to be lighter than detail responses.

    #Requests In This API

    RequestMethodPathWhat it does
    Search PrecedentsGET/ext/v1/precedentsSearch and filter precedent records with pagination support.
    Site HistoryGET/ext/v1/precedents/site-historyRetrieve planning history around an address, eircode, or coordinates.
    Get Precedent DetailsGET/ext/v1/precedents/:idFetch one precedent record with full detail and official links.

    #Typical Workflow

    1. Call Search Precedents with a text query or authority filter.
    2. If you need nearby planning context for a specific site, call Site History.
    3. Capture the returned precedent id.
    4. Call Get Precedent Details to fetch the full record for that result.

    #Shared Response Patterns

    Field or patternMeaning
    idStable precedent identifier for follow-up requests.
    planning_refOfficial planning reference from the local authority.
    local_authorityResponsible council or authority.
    decision_norm, status_normNormalized values for reliable filtering.
    nextCursor for the next search page on list responses.

    #Example Sequence

    bash
    curl "https://api.eireplan.ie/ext/v1/precedents?q=apartment&limit=5" \
  -H "Authorization: Bearer ek_your_api_key_here"

    Use one of the returned id values to continue with:

    bash
    curl "https://api.eireplan.ie/ext/v1/precedents/5f8fcb68-2be1-4ce7-8ef4-6a29c2fb4aa8" \
  -H "Authorization: Bearer ek_your_api_key_here"

    Continue to the request pages above for full parameter references and detailed response schemas.

    Search Precedents