> ## Documentation Index > Fetch the complete documentation index at: https://docs.ctrl-hub.com/llms.txt > Use this file to discover all available pages before exploring further. # Search for streets > Search the national street gazetteer by street name. Unlike listing streets, which returns only streets already held, this asks the gazetteer and so finds streets no permit has ever touched. Results are ordered by the provider's relevance; there is no score to sort on. **Paging is by cursor.** The gazetteer can continue after a street it has already returned, but it cannot skip to the nth result. So the first page is asked for with no cursor, and each page after it with an `after` filter naming the USRN of the last street on the page before: `and(eq(term,"bentinck road"),eq(after,15003853))`. `offset` still numbers the page in the response meta, but does not fetch one: an `offset` above zero with no `after` is a 400, as is an `after` that is not in this term's results. `limit` is capped at 50. The count in the response is the number of streets matching the term, not the size of the page. Gazetteer data must be acknowledged wherever it is shown. A name search and a USRN lookup both answer from OS open data, and return that acknowledgement as `meta.stats.attribution`, to be displayed with the results as given. A USRN term (digits only) is a lookup, not a search: it returns at most one street, and there is never a second page. Every street returned is recorded before the response is sent, so each `id` can be fetched from `/v3/geo/streets/{street_id}` straight away. A street recorded this way has its USRN, name and town. A street already held gains the search's name and town only where its own are empty; nothing else of it changes. ## OpenAPI ````yaml /api-reference/openapi.yaml get /v3/street-search-results openapi: 3.1.0 info: contact: email: support@ctrl-hub.com name: Ctrl Hub url: https://www.ctrl-hub.com description: > Ctrl Hub is the all-in-one platform for high-risk industries like utilities, construction, infrastructure, and renewables. We help teams manage everything from risk assessments and HAVS exposure to vehicle and equipment checks, with a guaranteed minimum of 200% ROI. license: name: MIT License url: https://opensource.org/licenses/MIT summary: An API for managing your compliance and risk posture termsOfService: https://www.ctrl-hub.com/terms-conditions title: Ctrl Hub version: 1.0.0 servers: - description: Production url: https://api.ctrl-hub.com - description: Staging url: https://api.ctrl-hub.dev - description: Development url: https://api.ctrl-hub.run security: [] tags: - description: | Actions are follow-ups assigned to users and teams, produced manually or by domain producers such as the data-capture workflow runner. name: Actions - description: | Audit events are the events that are logged by the system. name: Audit Events - description: | View the platform's health and availability. name: Status - description: > User-owned dashboards composed of cards on a fixed-slot bento layout. Cards come from a per-domain registry; the API stores their config as opaque JSON. name: Dashboards - description: > Copies of a mobile device's local database, sent by the operative on request so that people in their organisation can recover work that never reached the server. Kept for 30 days, and visible to people granted `device-backups:view` in the organisation each is filed against. name: Device Backups - description: > A record of documents the platform generated and handed over, retained as evidence of what was issued. `subject_type` says what kind of records an export covers, and it is what decides how the request is authorised: there is no export permission of its own, so if you can see the records you can export them. name: Exports - description: > Scheduled delivery of a saved query's results, as a CSV attachment or a summary email. Every run is retained with the file it sent, so what a recipient received stays retrievable. A report runs as the person who created it, under their own access. name: Reports - description: | Manage appointments for work to be carried out with your customers name: Customer Appointments - description: | Manage interactions you have with your customers name: Customer Interactions - description: | Manage accounts for your customers name: Customer Accounts and Contacts - description: | Qualifications are the skills and knowledge that an organisation requires. name: Qualifications - description: | Workflows allow you to automate your processes. name: Workflows - description: | Manage documents name: Documents - description: | Manage documents name: Folders - description: | Manage documents name: Document Reviews - description: | Manage feature configurations for an organisation. name: Feature Configurations - description: | Equipment are the physical assets that an organisation manages. name: Equipment - description: | The central cost register: time-versioned rate codes for material, labour, contractor and miscellaneous spend, used to cost work against the job hierarchy. name: Costs - description: > Locations are places an organisation manages, optionally classified by a location type. name: Locations - description: > Bulk loads of locations from an uploaded CSV. An import matches rows on the organisation's own `reference`, so re-importing a corrected file updates what is already there rather than doubling the population, and the import record is the audit trail for the whole load: the bulk write path deliberately emits no per-row events. name: Location Imports - description: | Manage your forms and their schemas name: Forms, Schemas and Categories - description: | Create and view form submissions name: Submissions - description: | View the roles available in the system. name: IAM Roles - description: > IAM role groups can be assigned to principals to manage authorisation centrally. name: IAM Role Groups - description: | Manage service accounts which can access the API programmatically. name: Service Accounts - description: | Manage bridges between organisations. name: Bridges - description: | Manage settings for an organisation. name: Settings - description: | Manage teams within an organisation. name: Teams - description: | Manage job roles within an organisation. name: Job Roles - description: | Manage users and accounts. name: Users - description: | Invite and manage invitations to organisations. name: Invitations - description: > IAM grants are the asignment of roles or permissions to principals to manage resource access. name: IAM Grants - description: | View the permissions available in the system. name: IAM Permissions - description: | SSO providers are the identity providers for an organisation. name: SSO Providers - description: | Whoami returns information about the currently authenticated principal. name: Whoami - description: | Your personal inbox. A notification is the thing you receive: an envelope that carries what happened to one or more channels. Email is one of those channels, the inbox is another, and this is where the ones delivered to your inbox are listed, read, saved and archived. name: Notifications - description: | Manage your images name: Images - description: > AI agent personas that synthesise data into role-specific intelligent briefings. name: Agents - description: | Briefings generated by AI agents, including reasoning traces. name: Briefings - description: > Organisations are the center point for most resources in the platform. Most other endpoints are subresources of an organisation. name: Organisations - description: | Permits managements, integrated with street manager. name: Permits - description: | Projects manage your work and governance. name: Projects - description: > Import templates allow users to save and reuse their CSV importer configuration as named templates. name: Import Templates - description: | Properties are the physical locations. name: Properties - description: | Search across schemes, work orders, and operations. name: Search - description: | Provides the API specification in JSON and YAML formats name: Specifications - description: | Streets are the physical roads. name: Streets - description: | Integration with street manager name: Street Manager - description: | Vehicles are the physical vehicles that an organisation manages. name: Vehicles - description: > Scheme contracts (also known as regions) group schemes allocated from the network to a contractor. name: Scheme Contracts - description: > Scheme shares allow you to share your schemes with other organisations across bridges. name: Scheme Shares - description: | Schemes are large programmes of work name: Schemes - description: > Site attendances record who was on site and when, whether or not they hold an account. There is no daily register resource: a day's register and who is currently on site are both queries over the attendances themselves. name: Site Attendances - description: | Work orders the component parts of a scheme. name: Work Orders - description: | Operations are the work to be carried out within work orders. name: Operations externalDocs: description: More documentation and resources url: https://docs.ctrl-hub.com paths: /v3/street-search-results: get: tags: - Geo description: > Search the national street gazetteer by street name. Unlike listing streets, which returns only streets already held, this asks the gazetteer and so finds streets no permit has ever touched. Results are ordered by the provider's relevance; there is no score to sort on. **Paging is by cursor.** The gazetteer can continue after a street it has already returned, but it cannot skip to the nth result. So the first page is asked for with no cursor, and each page after it with an `after` filter naming the USRN of the last street on the page before: `and(eq(term,"bentinck road"),eq(after,15003853))`. `offset` still numbers the page in the response meta, but does not fetch one: an `offset` above zero with no `after` is a 400, as is an `after` that is not in this term's results. `limit` is capped at 50. The count in the response is the number of streets matching the term, not the size of the page. Gazetteer data must be acknowledged wherever it is shown. A name search and a USRN lookup both answer from OS open data, and return that acknowledgement as `meta.stats.attribution`, to be displayed with the results as given. A USRN term (digits only) is a lookup, not a search: it returns at most one street, and there is never a second page. Every street returned is recorded before the response is sent, so each `id` can be fetched from `/v3/geo/streets/{street_id}` straight away. A street recorded this way has its USRN, name and town. A street already held gains the search's name and town only where its own are empty; nothing else of it changes. operationId: ListStreetSearchResults parameters: - $ref: '#/components/parameters/street_search_results_filter' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/offset' responses: '200': $ref: '#/components/responses/ListStreetSearchResults' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorised' '500': $ref: '#/components/responses/InternalServerError' security: - Session: [] - OAuth2: [] - Cookie: [] components: parameters: street_search_results_filter: name: filter in: query description: > Filters the response data based on the value provided. A `term` filter is required; without one the search returns nothing rather than every street in the country. A term of digits only is a USRN, and is looked up rather than searched for: it returns at most one street. Any other term is passed to the gazetteer as a street name query. An `after` filter, naming the USRN of the last street on the previous page, asks for the next page: `and(eq(term,"high street"),eq(after,42502279))`. For more information on using named filters, see [the docs](https://docs.ctrl-hub.com/api-reference/features#filtering) required: false schema: type: string default: '' limit: name: limit in: query description: Limit the number of resources returned by the API required: false schema: type: integer format: int64 minimum: 1 default: 100 offset: name: offset in: query description: Offset the resources returned by the API required: false schema: type: integer format: int64 minimum: 0 default: 0 responses: ListStreetSearchResults: description: Get a list of results. headers: Content-Type: $ref: '#/components/headers/content-type' Content-Length: $ref: '#/components/headers/content-length' X-Request-ID: $ref: '#/components/headers/x-request-id' content: application/vnd.api+json: schema: allOf: - type: object required: - data properties: data: title: A list of results type: array items: $ref: '#/components/schemas/StreetSearchResult' - $ref: '#/components/schemas/DocumentMeta' - $ref: '#/components/schemas/JSONAPI' - type: object properties: meta: type: object properties: stats: type: object properties: attribution: type: string description: > The acknowledgement the gazetteer's data provider requires wherever its data is displayed — for OS open data, the Crown copyright notice. Show it with the results, as given. Absent when the provider sent none. BadRequest: description: > There was an error with the request - this could be due to an invalid body, query parameters, or headers that were sent to the API. headers: Content-Type: $ref: '#/components/headers/content-type' Content-Length: $ref: '#/components/headers/content-length' X-Request-ID: $ref: '#/components/headers/x-request-id' content: application/vnd.api+json: schema: type: object properties: errors: type: array items: $ref: '#/components/schemas/Error' example: id: 98ca4a78-b66f-4234-9719-aaf832ee6669 status: '400' title: A validation error was encountered source: parameter: include meta: resource: wrong_value Unauthorised: description: Authentication failed headers: Content-Type: $ref: '#/components/headers/content-type' Content-Length: $ref: '#/components/headers/content-length' X-Request-ID: $ref: '#/components/headers/x-request-id' content: application/vnd.api+json: schema: type: object properties: errors: type: array items: $ref: '#/components/schemas/Error' example: id: 05fc9c8d-73b9-4697-9337-57f7a567a48f status: '401' title: You are not authorised to access this resource detail: In order to access this resource, you need the 'admin' role. code: AUTH.001 InternalServerError: description: There was a problem handling the request on the server side headers: Content-Type: $ref: '#/components/headers/content-type' Content-Length: $ref: '#/components/headers/content-length' X-Request-ID: $ref: '#/components/headers/x-request-id' content: application/vnd.api+json: schema: type: object properties: errors: type: array items: $ref: '#/components/schemas/Error' example: id: fe9d9a69-f0a7-4fdc-bb2c-176027f316c5 status: '500' title: Internal Server Error detail: An unexpected error occurred on the server. headers: content-type: description: The content type of the response schema: type: string example: application/vnd.api+json content-length: description: The length of the response body in bytes schema: type: integer format: int32 example: 1234 x-request-id: description: >- An ID that can be provided when reporting bugs to help identify the issue schema: type: string example: 8470f56af4cf25e22be08e72c70dbbdc schemas: StreetSearchResult: type: object description: > A street as the gazetteer describes it, which may or may not be a street we already held. Every street a search returns is recorded before the response is sent, so it can be fetched from /v3/geo/streets/{street_id} by its USRN straight away. required: - id - type - attributes properties: id: type: string description: >- The USRN, rendered as a string. The gazetteer has no other identifier for a street. type: type: string const: street-search-results attributes: $ref: '#/components/schemas/StreetSearchResultAttributes' DocumentMeta: type: object description: Document level meta about the resources on the server in list endpoints. required: - meta properties: meta: type: object required: - pagination properties: features: $ref: '#/components/schemas/Features' pagination: $ref: '#/components/schemas/Pagination' JSONAPI: type: object description: JSON API response object required: - jsonapi properties: jsonapi: type: object required: - version properties: version: type: string description: The version of the JSON API specification examples: - '1.0' Error: type: object description: An error response properties: id: description: >- A unique identifier for this particular occurrence of the problem. If you encounter this, please provide us with the error ID and we can investigate it on our side. type: string format: uuid examples: - 05fc9c8d-73b9-4697-9337-57f7a567a48f status: description: >- The status code for the error. This might not match the HTTP status code if there are more that one errors to return with different status codes. type: string examples: - '401' - '500' title: description: A human readable title for the error. type: string examples: - You are not authorised to access this resource detail: description: >- Where there is more detail that we can provide outside of the title, we will provide it here. type: string examples: - In order to access this resource, you need the 'admin' role. code: description: >- A unique code for the error that may help us to diagnose the issue. Not all errors have codes, so this is usually empty. `CH.003.080` (403) means the organisation in `meta.organisation_id` requires two-factor authentication and the caller's session does not satisfy it. The caller must set up or use a second factor, or sign in through their organisation's SAML single sign-on. Other OIDC sign-ins do not count. type: string examples: - AUTH.001 - CH.003.080 source: description: A JSON object containing additional information about the error. type: object properties: pointer: description: >- A JSON Pointer to the value in the request that caused the error. type: string examples: - /data/attributes/email parameter: description: >- A string indicating which query parameter in the request caused the error. type: string examples: - include meta: description: >- A JSON object containing additional information about the error. When a parameter caused the error, there will be a `resource` property with the name of the resource that caused the error. When `code` is `CH.003.080`, `organisation_id` names the organisation that requires two-factor authentication, which the caller's session does not satisfy. type: object properties: resource: type: string description: >- The resource a parameter error relates to, such as an unsupported include. organisation_id: type: string format: uuid examples: - c000c344-8847-47da-a091-32e75902d3b1 additionalProperties: true required: - id - status - title StreetSearchResultAttributes: type: object description: Attributes for a street search result required: - usrn properties: usrn: type: number description: >- The Unique Street Reference Number, the gazetteer's identifier for the street. name: type: string description: The street name as the gazetteer records it, in upper case. town: type: string description: The town the street is in, in upper case. Features: type: object description: Represents feature configurations of the API properties: include: type: object properties: options: type: array items: type: string examples: - related.resource Pagination: type: object description: Represents pagination details for API responses required: - counts - current_page - offsets - requested properties: counts: type: object required: - pages - resources properties: pages: type: integer examples: - 1 resources: type: integer examples: - 1 current_page: type: integer examples: - 1 offsets: type: object required: - next - previous properties: next: type: - integer - 'null' examples: - null previous: type: - integer - 'null' examples: - null requested: type: object required: - limit - offset properties: limit: type: integer examples: - 10 offset: type: integer examples: - 0 securitySchemes: Session: description: | Session token for authentication. in: header name: X-Session-Token type: apiKey OAuth2: description: | OAuth2 token for authentication. flows: clientCredentials: scopes: {} tokenUrl: https://auth.ctrl-hub.com/oauth2/token type: oauth2 Cookie: description: | Cookie token for authentication. in: cookie name: ctrl_hub_session type: apiKey ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.