Sample Queries

Explore ready-to-use examples of Nimbus Graph API queries — from simple postcode lookups to advanced filtered searches. These samples are designed to help you integrate quickly and understand the available filters and data structure.

This guide assumes a basic familiarity with GraphQL.

Query Resolvers:

I) EntrySearch

Search sort and paginate through multiple entries with filters.
This is the core query for browsing data. You can filter by postcode, coordinates, size, use class, planning status, and more. Supports pagination with first, after, and other cursor-based arguments.

Note: This is typically the most-used query for exploring the Nimbus property dataset.

II) Entry

Retrieve a single entry by unique ID.
This operation returns one complete entry object, usually identified by an internal Nimbus ID or external reference (e.g. title number). Use this when you already know the exact ID and need full details.

Query Options:


As a rule, we support the latest GraphQL Spec as shown on the GraphQL official website. This includes all Paging, Sorting, Projection, Filtering options.

Samples to try:

1) Titles with Leases

This sample GraphQL query searches for entries where the associated title has at least one lease, and returns the title number, tenure type, and detailed lease information including dates, address, rent amounts, term lengths, and any break clause details.

query Sample1 {
  entrySearch(
    where: {
      title: {
        leases: { any: true } }
      }
    ) {
    nodes {
      title {
        number
        tenure {
          value
        }
        leases {
          startDate
          endDate
          address {
            fullAddress
          }
          isPremium
          breakClause {
            breakClauseDescription
            breakClauseTermInMonths
            breakClauseFromDate
          }
          termMonths
          termYears
          rent
          rentMonthly
          rentAnnually
          rentPerSquareFoot
          rentPerSquareMeter
        }
      }
    }
  }
}

2) Title with details

This sample GraphQL query retrieves detailed information for a specific title, identified by its reference. It returns the title number, address, area, linked titles, building and title part measurements, planning applications, and any overlapping constraints.

query Sample2 {
entry(
reference: "60438fea-f5ee-4c98-b4b1-3baf4a013b3c"
) {
    reference
    title {
      number
      address {
        fullAddress
      }
      areaInSquareFeet
      titleParts {
        areaInSquareMeters
        buildingParts {
          footprintArea
          eavesHeight
          chimneyHeight
          heightAboveSeaLevel
        }
      }
      planningApplications {
        reference
        description
        decisionDate
        dateSubmitted
      }
      titleConstraintSummaries {
        overlapPercentage
        isOverlapping
        constraint {
          name
        }
      }
      linkedTitles {
        number
      }
    }
  }
}

3) Ownerships with Sales

This sample GraphQL query searches for entries with at least one ownership sale acquired after 22 August 2023. It returns ownership details including owner type, individual or company owner information, and sale records with acquisition date, title number, and price.

query Sample3 {
  entrySearch(
    where: {
      ownership: {
        sales: { some: { dateAcquired: { gt: "2023-08-22T23:00:00.000Z" } } }
      }
    }
  ) {
    nodes {
      ownership {
        ownerType {
          value
        }
        individualOwners {
          personalDetail {
            firstName
            lastName
          }
        }
        groupOwners {
          company {
            number
          }
        }
        sales {
          dateAcquired
          title {
            number
          }
          price
        }
      }
    }
  }
}

4) Inspires with UPRNs

This sample GraphQL query searches for entries where the title part contains at least one UPRN. It returns INSPIRE identifiers along with UPRN details, including classification codes and council tax band information.

query Sample4 {
  entrySearch(
    where: {
      inspire: {
        titlePart: { uprns: { any: true } } }
      }
    ) {
    nodes {
      inspire {
        number
        titlePart {
          uprns {
            number
            classifications {
              code
              description
              oldClassificationCode
              newClassificationCode
            }
            councilTax {
              band
              effectiveDate
              uniqueAddressReferenceNumber
            }
          }
        }
      }
    }
  }
}