{"components":{"parameters":{"circle":{"description":"Get all plots intersecting the circle.","in":"query","name":"circle","required":false,"schema":{"description":"Latitude, longitude and radius must be defined in that order using a comma to separate the values.","example":"60.37199449746464,5.342501858431774,10","pattern":"^(\\d{1,2}\\.\\d+,\\d{1,3}\\.\\d+,\\d+)$","type":"string"},"style":"form"},"lease":{"description":"The cadastral lease for the plot","in":"path","name":"lease","required":true,"schema":{"$ref":"#\/components\/schemas\/lease"},"style":"simple"},"municipality":{"description":"The municipality for the plot","in":"path","name":"municipality","required":true,"schema":{"$ref":"#\/components\/schemas\/municipality"},"style":"simple"},"path":{"description":"Get all plots intersecting the path. The client is required to include the parameter `radius` if this parameter is used.","in":"query","name":"path","required":false,"schema":{"$ref":"#\/components\/schemas\/coordinates"},"style":"form"},"point":{"description":"Get all plots intersecting the point.","in":"query","name":"point","required":false,"schema":{"description":"Latitude and longitude must be defined in that order using a comma to separate the coordinates.","example":"60.37199449746464,5.342501858431774","pattern":"^(\\d{1,2}\\.\\d+,\\d{1,3}\\.\\d+)$","type":"string"},"style":"form"},"polygon":{"description":"Get all plots intersecting the polygon. The provided polygon will be closed automatically if it is open.","in":"query","name":"polygon","required":false,"schema":{"$ref":"#\/components\/schemas\/coordinates"},"style":"form"},"property":{"description":"The cadastral property for the plot","in":"path","name":"property","required":true,"schema":{"$ref":"#\/components\/schemas\/property"},"style":"simple"},"radius":{"description":"Radius for the path. Include this parameter if you are using the `path` parameter.","in":"query","name":"radius","required":false,"schema":{"example":15,"minimum":0,"type":"number"},"style":"form"},"section":{"description":"The cadastral section for the plot","in":"path","name":"section","required":true,"schema":{"$ref":"#\/components\/schemas\/section"},"style":"simple"},"unit":{"description":"The cadastral unit for the plot","in":"path","name":"unit","required":true,"schema":{"$ref":"#\/components\/schemas\/unit"},"style":"simple"}},"responses":{"http_400":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/error_response"}}},"description":"Request is not accepted due to malformed payload."}},"schemas":{"coordinates":{"description":"Each pair with coordinates must be separated with commas. The coordinates in a pair must be separated with a whitespace where the first coordinate is latitude and the second is longitude.","example":"60.37199449746464 5.342501858431774,60.3721981169883 5.342394656613294,60.3721004913524 5.341474977854915","pattern":"^(\\d{1,2}\\.\\d+\\s\\d{1,3}\\.\\d+,)+(\\d{1,2}\\.\\d+\\s\\d{1,3}\\.\\d+)$","type":"string"},"error":{"properties":{"message":{"description":"An error message describing why we considered the request to be malformed.","example":"Missing radius parameter","type":"string"},"path":{"description":"Where in the input datastructure the error was detected.","example":"\/radius","type":"string"}},"required":["message","path"],"type":"object"},"error_response":{"properties":{"errors":{"items":{"$ref":"#\/components\/schemas\/error"},"type":"array"}},"required":["errors"],"type":"object"},"geojson":{"oneOf":[{"$ref":"#\/components\/schemas\/geojson_polygon"},{"$ref":"#\/components\/schemas\/geojson_multipolygon"}]},"geojson_crs":{"description":"Describes the coordinate reference system","properties":{"properties":{"properties":{"name":{"example":"EPSG:4326","type":"string"}},"type":"object"},"type":{"example":"name","type":"string"}},"type":"object"},"geojson_multipolygon":{"additionalProperties":false,"description":"An object which describes an area in GeoJSON","properties":{"coordinates":{"description":"A list of areas, for example a multipolygon with holes.","example":[[[["5.3414411246501174","60.372184170478874"],["5.341508831061475","60.371998681463424"],["5.342284633694135","60.37208793942554"],[5.34238760386242,60.3719101205259],["5.342656313681857","60.37194045423778"],[5.34258084924403,"60.37211164858053"],["5.342484931828437","60.37230689946156"],["5.3414411246501174","60.372184170478874"]]]],"items":{"description":"A list of coordinates which are the boundaries for a multiple areas.","items":{"description":"A list of coordinates which are the boundaries for a single area.","items":{"description":"A pair of coordinates that are listed in the following order: longitude, latitude\n","items":{"description":"A longitude or latitude value","pattern":"^\\d{1,3}\\.\\d+$","type":"number"},"type":"array"},"type":"array"},"type":"array"},"type":"array"},"crs":{"$ref":"#\/components\/schemas\/geojson_crs"},"type":{"description":"Name of the geometry used in context with coordinates","enum":["MultiPolygon"],"example":"MultiPolygon","type":"string"}},"required":["type","coordinates"],"type":"object"},"geojson_polygon":{"additionalProperties":false,"description":"An object which describes an area in GeoJSON","properties":{"coordinates":{"description":"A list of areas, for example a polygon with holes.","example":[[["5.3414411246501174","60.372184170478874"],["5.341508831061475","60.371998681463424"],["5.342284633694135","60.37208793942554"],[5.34238760386242,60.3719101205259],["5.342656313681857","60.37194045423778"],[5.34258084924403,"60.37211164858053"],["5.342484931828437","60.37230689946156"],["5.3414411246501174","60.372184170478874"]]],"items":{"description":"A list of coordinates which are the boundaries for a single area.","items":{"description":"A pair of coordinates that are listed in the following order: longitude, latitude\n","items":{"description":"A longitude or latitude value","pattern":"^\\d{1,3}\\.\\d+$","type":"number"},"type":"array"},"type":"array"},"type":"array"},"crs":{"$ref":"#\/components\/schemas\/geojson_crs"},"type":{"description":"Name of the geometry used in context with coordinates","enum":["Polygon"],"example":"Polygon","type":"string"}},"required":["type","coordinates"],"type":"object"},"lease":{"description":"The cadastral lease for the plot","example":0,"minimum":0,"nullable":true,"type":"integer"},"municipality":{"description":"The municipality for the plot","example":4601,"pattern":"^\\d{4}$","type":"string"},"plot_response":{"description":"Contains information about the plot, including coordinates for the boundary. The coordinates can contain holes.","properties":{"boundary":{"$ref":"#\/components\/schemas\/geojson"},"lease":{"$ref":"#\/components\/schemas\/lease"},"municipality":{"$ref":"#\/components\/schemas\/municipality"},"property":{"$ref":"#\/components\/schemas\/property"},"section":{"$ref":"#\/components\/schemas\/section"},"unit":{"$ref":"#\/components\/schemas\/unit"}},"type":"object"},"property":{"description":"The cadastral property for the plot","example":84,"minimum":0,"type":"integer"},"section":{"description":"The cadastral section for the plot","example":0,"minimum":0,"nullable":true,"type":"integer"},"unit":{"description":"The cadastral unit for the plot","example":159,"minimum":0,"type":"integer"}},"securitySchemes":{"token":{"description":"Access token for the API","in":"header","name":"X-Auth-Token","type":"apiKey"}}},"info":{"description":"Produces geographical \/ cadastral data based on your parameters and filters.\n\nSeveral endpoints will refer to _spatial units_, which are \"teiger\" in the Norwegian cadastre. Here they are presented as coordinates which describe the geographical area in GeoJSON.\n","license":{"name":"Stix Commercial License"},"title":"Stix Geo API","version":"1.0.0"},"openapi":"3.0.1","paths":{"\/boundary":{"get":{"description":"Get the coordinates, in GeoJSON, which are the merged boundary for all the plots that intersect with the specified geographical area.\n\nThe client must include a single area in the payload and use only _one_ of the following parameter types: `point`, `polygon`, `circle` or `path`.\n","operationId":"get_merged_boundary","parameters":[{"description":"Get all plots intersecting the point.","in":"query","name":"point","required":false,"schema":{"description":"Latitude and longitude must be defined in that order using a comma to separate the coordinates.","example":"60.37199449746464,5.342501858431774","pattern":"^(\\d{1,2}\\.\\d+,\\d{1,3}\\.\\d+)$","type":"string"},"style":"form"},{"description":"Get all plots intersecting the polygon. The provided polygon will be closed automatically if it is open.","in":"query","name":"polygon","required":false,"schema":{"$ref":"#\/components\/schemas\/coordinates"},"style":"form"},{"description":"Get all plots intersecting the circle.","in":"query","name":"circle","required":false,"schema":{"description":"Latitude, longitude and radius must be defined in that order using a comma to separate the values.","example":"60.37199449746464,5.342501858431774,10","pattern":"^(\\d{1,2}\\.\\d+,\\d{1,3}\\.\\d+,\\d+)$","type":"string"},"style":"form"},{"description":"Get all plots intersecting the path. The client is required to include the parameter `radius` if this parameter is used.","in":"query","name":"path","required":false,"schema":{"$ref":"#\/components\/schemas\/coordinates"},"style":"form"},{"description":"Radius for the path. Include this parameter if you are using the `path` parameter.","in":"query","name":"radius","required":false,"schema":{"example":15,"minimum":0,"type":"number"},"style":"form"}],"responses":{"200":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/geojson"}}},"description":"Request to fetch the merged boundary succeeded."},"400":{"$ref":"#\/components\/responses\/http_400"},"401":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/error_response"}}},"description":"Default response."},"404":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/error_response"}}},"description":"Default response."},"500":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/error_response"}}},"description":"Default response."},"501":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/error_response"}}},"description":"Default response."}},"summary":"Get the merged boundary for plots intersecting an area","tags":["Conversions"],"x-mojo-to":"cadastre#merged_boundary"}},"\/plots":{"get":{"description":"List the plots and their spatial units which intersect with the specified geographical area.\n\nThe client must include a single area in the payload and use only _one_ of the following parameter types: `point`, `polygon`, `circle` or `path`.\n","operationId":"get_plots","parameters":[{"description":"Get all plots intersecting the point.","in":"query","name":"point","required":false,"schema":{"description":"Latitude and longitude must be defined in that order using a comma to separate the coordinates.","example":"60.37199449746464,5.342501858431774","pattern":"^(\\d{1,2}\\.\\d+,\\d{1,3}\\.\\d+)$","type":"string"},"style":"form"},{"description":"Get all plots intersecting the polygon. The provided polygon will be closed automatically if it is open.","in":"query","name":"polygon","required":false,"schema":{"$ref":"#\/components\/schemas\/coordinates"},"style":"form"},{"description":"Get all plots intersecting the circle.","in":"query","name":"circle","required":false,"schema":{"description":"Latitude, longitude and radius must be defined in that order using a comma to separate the values.","example":"60.37199449746464,5.342501858431774,10","pattern":"^(\\d{1,2}\\.\\d+,\\d{1,3}\\.\\d+,\\d+)$","type":"string"},"style":"form"},{"description":"Get all plots intersecting the path. The client is required to include the parameter `radius` if this parameter is used.","in":"query","name":"path","required":false,"schema":{"$ref":"#\/components\/schemas\/coordinates"},"style":"form"},{"description":"Radius for the path. Include this parameter if you are using the `path` parameter.","in":"query","name":"radius","required":false,"schema":{"example":15,"minimum":0,"type":"number"},"style":"form"}],"responses":{"200":{"content":{"application\/json":{"schema":{"items":{"$ref":"#\/components\/schemas\/plot_response"},"type":"array"}}},"description":"Request to locate boundaries succeeded."},"400":{"$ref":"#\/components\/responses\/http_400"},"401":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/error_response"}}},"description":"Default response."},"404":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/error_response"}}},"description":"Default response."},"500":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/error_response"}}},"description":"Default response."},"501":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/error_response"}}},"description":"Default response."}},"summary":"Get plots which intersect with an area","tags":["Plots"],"x-mojo-to":"cadastre#plot_search"}},"\/plots\/count":{"get":{"description":"Get the number of all the plots that intersect with the specified geographical area.\n\nThe client must include a single area in the payload and use only one of the following parameter types: `point`, `polygon`, `circle` or `path`.\n","operationId":"get_plots_count","parameters":[{"description":"Get all plots intersecting the point.","in":"query","name":"point","required":false,"schema":{"description":"Latitude and longitude must be defined in that order using a comma to separate the coordinates.","example":"60.37199449746464,5.342501858431774","pattern":"^(\\d{1,2}\\.\\d+,\\d{1,3}\\.\\d+)$","type":"string"},"style":"form"},{"description":"Get all plots intersecting the polygon. The provided polygon will be closed automatically if it is open.","in":"query","name":"polygon","required":false,"schema":{"$ref":"#\/components\/schemas\/coordinates"},"style":"form"},{"description":"Get all plots intersecting the circle.","in":"query","name":"circle","required":false,"schema":{"description":"Latitude, longitude and radius must be defined in that order using a comma to separate the values.","example":"60.37199449746464,5.342501858431774,10","pattern":"^(\\d{1,2}\\.\\d+,\\d{1,3}\\.\\d+,\\d+)$","type":"string"},"style":"form"},{"description":"Get all plots intersecting the path. The client is required to include the parameter `radius` if this parameter is used.","in":"query","name":"path","required":false,"schema":{"$ref":"#\/components\/schemas\/coordinates"},"style":"form"},{"description":"Radius for the path. Include this parameter if you are using the `path` parameter.","in":"query","name":"radius","required":false,"schema":{"example":15,"minimum":0,"type":"number"},"style":"form"}],"responses":{"200":{"content":{"application\/json":{"schema":{"properties":{"count":{"description":"The number of intersecting plots","example":3,"type":"number"}},"type":"object"}}},"description":"Request to count number of intersecting plots succeeded."},"400":{"$ref":"#\/components\/responses\/http_400"},"401":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/error_response"}}},"description":"Default response."},"404":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/error_response"}}},"description":"Default response."},"500":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/error_response"}}},"description":"Default response."},"501":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/error_response"}}},"description":"Default response."}},"summary":"Get number of plots intersecting an area","tags":["Counting"],"x-mojo-to":"cadastre#plot_search_count"}},"\/plots\/{municipality}\/{unit}\/{property}\/{lease}\/{section}":{"get":{"description":"Fetch the plot and its spatial unit which belong to the specified cadastral unit.","operationId":"get_plot","parameters":[{"description":"The municipality for the plot","in":"path","name":"municipality","required":true,"schema":{"$ref":"#\/components\/schemas\/municipality"},"style":"simple"},{"description":"The cadastral unit for the plot","in":"path","name":"unit","required":true,"schema":{"$ref":"#\/components\/schemas\/unit"},"style":"simple"},{"description":"The cadastral property for the plot","in":"path","name":"property","required":true,"schema":{"$ref":"#\/components\/schemas\/property"},"style":"simple"},{"description":"The cadastral lease for the plot","in":"path","name":"lease","required":true,"schema":{"$ref":"#\/components\/schemas\/lease"},"style":"simple"},{"description":"The cadastral section for the plot","in":"path","name":"section","required":true,"schema":{"$ref":"#\/components\/schemas\/section"},"style":"simple"}],"responses":{"200":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/plot_response"}}},"description":"Request to locate plot boundary succeeded."},"400":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/error_response"}}},"description":"Default response."},"401":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/error_response"}}},"description":"Default response."},"404":{"description":"The API was unable to locate the specified plot. Response will be an empty object."},"500":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/error_response"}}},"description":"Default response."},"501":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/error_response"}}},"description":"Default response."}},"summary":"Get plot for a cadastral unit","tags":["Plots"],"x-mojo-to":"cadastre#plot_boundary"}},"\/plots\/{municipality}\/{unit}\/{property}\/{lease}\/{section}\/neighbours":{"get":{"description":"List the plots and their spatial units which are the neighbouring plots to the specified cadastral unit.","operationId":"get_plot_neighbours","parameters":[{"description":"The municipality for the plot","in":"path","name":"municipality","required":true,"schema":{"$ref":"#\/components\/schemas\/municipality"},"style":"simple"},{"description":"The cadastral unit for the plot","in":"path","name":"unit","required":true,"schema":{"$ref":"#\/components\/schemas\/unit"},"style":"simple"},{"description":"The cadastral property for the plot","in":"path","name":"property","required":true,"schema":{"$ref":"#\/components\/schemas\/property"},"style":"simple"},{"description":"The cadastral lease for the plot","in":"path","name":"lease","required":true,"schema":{"$ref":"#\/components\/schemas\/lease"},"style":"simple"},{"description":"The cadastral section for the plot","in":"path","name":"section","required":true,"schema":{"$ref":"#\/components\/schemas\/section"},"style":"simple"}],"responses":{"200":{"content":{"application\/json":{"schema":{"items":{"$ref":"#\/components\/schemas\/plot_response"},"type":"array"}}},"description":"Request to locate neighbouring plot boundaries succeeded."},"400":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/error_response"}}},"description":"Default response."},"401":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/error_response"}}},"description":"Default response."},"404":{"description":"The API was unable to locate any neighbouring plots. Response will be an empty array."},"500":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/error_response"}}},"description":"Default response."},"501":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/error_response"}}},"description":"Default response."}},"summary":"Get neighbouring plots to a cadastral unit","tags":["Plots"],"x-mojo-to":"cadastre#neighbours_boundaries"}},"\/polygon":{"get":{"description":"Get coordinates for the polygon which can be produced from specified path coordinates and radius.","operationId":"path_to_polygon","parameters":[{"description":"Coordinates for the path","in":"query","name":"path","required":true,"schema":{"$ref":"#\/components\/schemas\/coordinates"},"style":"form"},{"description":"Radius for the path","example":10,"in":"query","name":"radius","required":true,"schema":{"minimum":0,"type":"number"},"style":"form"}],"responses":{"200":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/geojson"}}},"description":"Request to translate path to polygon succeeded."},"400":{"$ref":"#\/components\/responses\/http_400"},"401":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/error_response"}}},"description":"Default response."},"404":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/error_response"}}},"description":"Default response."},"500":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/error_response"}}},"description":"Default response."},"501":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/error_response"}}},"description":"Default response."}},"summary":"Covert a path to polygon","tags":["Conversions"],"x-mojo-to":"cadastre#path_to_polygon"}},"\/reduce-precision":{"post":{"description":"Reduces the number of coordinates needed to represent a (multi)polygon.","operationId":"reduce_precision","requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/geojson"}}},"description":"The (multi)polygon, in GeoJSON, from which to remove redundant coordinates","required":true},"responses":{"200":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/geojson"}}},"description":"Request to reduce precision for geometry succeeded."},"400":{"$ref":"#\/components\/responses\/http_400"},"401":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/error_response"}}},"description":"Default response."},"404":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/error_response"}}},"description":"Default response."},"500":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/error_response"}}},"description":"Default response."},"501":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/error_response"}}},"description":"Default response."}},"summary":"Reduce the number of coordinates in an area","tags":["Conversions"],"x-mojo-to":"cadastre#reduce_precision"}}},"security":[{"token":[]}],"servers":[{"description":"Production server","url":"https:\/\/geo.stix.no\/"}]}