1"use strict";(globalThis.webpackChunk_atlas_docs_ideal=globalThis.webpackChunk_atlas_docs_ideal||[]).push([[2243],{26114(e,t,n){n.d(t,{C8:()=>b,CP:()=>g,D0:()=>f,VY:()=>d,h:()=>o,w3:()=>p,wg:()=>_,yR:()=>u});var s=n(22155),i=n(22299),r=n(18962),a=n(65723);const o=({name:e,type:t})=>(0,a.jsxs)("header",{className:"atlas-prop__header",children:[(0,a.jsx)("code",{className:"atlas-prop__name",children:e}),t&&(0,a.jsx)("span",{className:"atlas-prop__type",children:Array.isArray(t)?t.join(" | "):t})]}),d=e=>e.description?(0,a.jsx)("div",{className:"atlas-prop__description",children:(0,a.jsx)(r.oz,{children:e.description})}):null,l=e=>"number"==typeof e?e.toString():`"${e}"`,p=({example:e,enumValues:t,format:n,defaultValue:s,extra:i})=>{const r=[];if(n&&r.push({label:"Format",value:(0,a.jsx)("code",{children:n})}),void 0!==s&&r.push({label:"Default",value:(0,a.jsx)("code",{children:String(s)})}),null!=e&&""!==e&&r.push({label:"Example",value:(0,a.jsx)("code",{children:String(e)})}),t?.length){const e=(0,a.jsx)("ul",{className:"atlas-prop__chips",children:t.map((e,t)=>(0,a.jsx)("li",{children:l(e)},t))});r.push({label:"Values",value:h(t)?(0,a.jsxs)("details",{className:"atlas-prop__chips-more",children:[(0,a.jsx)("summary",{children:`${t.length} possible values`}),e]}):e})}return i&&r.push(...i),r.length?(0,a.jsx)("dl",{className:"atlas-prop__meta",children:r.map((e,t)=>(0,a.jsx)(c,{label:e.label,children:e.value},t))}):null},c=({label:e,children:t})=>(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)("dt",{children:e}),(0,a.jsx)("dd",{children:t})]}),u=e=>e.toLowerCase().replace(/[^a-z0-9]+/g,"-").replace(/(^-|-$)/g,""),m=e=>{if(Array.isArray(e.oneOf)){const t=[...new Set(e.oneOf.map(e=>e.type).filter(Boolean))];return t.length?t.join(" | "):"object"}return Array.isArray(e.type)?e.type.join(" | "):e.type||"string"},h=e=>e.length>12||e.map(l).join(" ").length>100,g=({values:e})=>{if(!e.length)return null;const t=(0,a.jsx)("ul",{className:"atlas-params__values",children:e.map((e,t)=>(0,a.jsx)("li",{children:"number"==typeof e?e:`"${e}"`},t))});return(0,a.jsxs)("div",{className:"atlas-params__enum",children:[(0,a.jsx)("span",{className:"atlas-params__enum-label",children:"Enum"})," ",h(e)?(0,a.jsxs)("details",{className:"atlas-params__values-more",children:[(0,a.jsx)("summary",{children:`${e.length} possible values`}),t]}):t]})},y=(0,s.createContext)(void 0),_="Empty in this example",f=({property:e,title:t,id:n,schema:r,required:o,example:l})=>{const p=(0,s.useContext)(y),c=t??r?.title,h=n??(c?u(c):e);if((0,i.A)().collectAnchor(h),!r)return null;const f=r.enum??[],b=[];r.format&&b.push({label:"Format",value:r.format}),void 0!==r.default&&b.push({label:"Default",value:String(r.default)});const v=l??p?.[e]??r.example;return["string","number","boolean"].includes(typeof v)&&b.push({label:"Example",value:String(v),empty:""===v}),(0,a.jsxs)("div",{className:"atlas-params__row",id:h,children:[(0,a.jsxs)("dt",{className:"atlas-params__ident",children:[(0,a.jsx)("code",{className:"atlas-params__name",children:e})," ",(0,a.jsx)("span",{className:"atlas-params__type",children:m(r)})," ",o&&(0,a.jsx)("span",{className:"atlas-params__required",children:"required"})]}),(0,a.jsxs)("dd",{className:"atlas-params__body",children:[c&&(0,a.jsx)("div",{className:"atlas-params__title",children:c}),(0,a.jsx)(d,{...r}),b.length>0&&(0,a.jsx)("div",{className:"atlas-params__meta",children:b.map(e=>(0,a.jsxs)("span",{children:[(0,a.jsx)("span",{children:e.label})," ",e.empty?(0,a.jsx)("span",{className:"atlas-params__empty",children:_}):(0,a.jsx)("code",{children:e.value})]},e.label))}),(0,a.jsx)(g,{values:f})]})]})},b=({children:e,example:t})=>(0,a.jsx)(y.Provider,{value:t,children:(0,a.jsx)("dl",{className:"atlas-params atlas-params--fields",children:e})})},36249(e,t,n){n.r(t),n.d(t,{PATH:()=>h,addressLinks:()=>y,assets:()=>m,contentTitle:()=>u,default:()=>b,frontMatter:()=>c,metadata:()=>s,operation:()=>g,toc:()=>_});const s=JSON.parse('{"id":"api/resolve-address","title":"Resolve Address","description":"Resolves an address autocompletion by its ID into a full UK-formatted address record.","source":"@site/docs/api/resolve-address.mdx","sourceDirName":"api","
1slug":"/api/resolve-address","permalink":"/docs/api/resolve-address","draft":false,"unlisted":false,"tags":[],"version":"current","frontMatter":{"title":"Resolve Address","description":"Resolves an address autocompletion by its ID into a full UK-formatted address record.","sidebar_label":"Resolve Address","slug":"/api/resolve-address","hide_table_of_contents":true},"sidebar":"openApiSidebar","previous":{"title":"Find Address","permalink":"/docs/api/find-address"},"next":{"title":"Overview","permalink":"/docs/api/uk"}}');var i=n(65723),r=n(34056),a=n(40333),o=n(76215),d=n(35061),l=n(53105),p=n(56125);const c={title:"Resolve Address",description:"Resolves an address autocompletion by its ID into a full UK-formatted address record.",sidebar_label:"Resolve Address",slug:"/api/resolve-address",hide_table_of_contents:!0},u=void 0,m={},h="/autocomplete/addresses/{address}/gbr",g=p.paths[h].get,y={PafAddress:"/docs/data/paf",MrAddress:"/docs/data/mr",NybAddress:"/docs/data/nyb",PafaAddress:"/docs/data/paf-aliases",PafwAddress:"/docs/data/welsh-paf",AbAddress:"/docs/data/addressbase-core",AbpAddress:"/docs/data/addressbase-premium",UspsAddress:"/docs/data/usps",EcadAddress:"/docs/data/ecad",EcafAddress:"/docs/data/ecaf",HereAddress:"/docs/data/here",GnafAddress:"/docs/data/gnaf",KadasterAddress:"/docs/data/kadaster",KartverketAddress:"/docs/data/kartverket",SdfiAddress:"/docs/data/sdfi",CannarAddress:"/docs/data/cannar",FodbosaAddress:"/docs/data/fodbosa",MoisAddress:"/docs/data/mois",UpujpAddress:"/docs/data/upujp",SwtAddress:"/docs/data/swt",BevAddress:"/docs/data/bev",BanAddress:"/docs/data/ban"},_=[{value:"Path parameters",id:"path-parameters",level:2},{value:"Query parameters",id:"query-parameters",level:2},{value:"Response",id:"response",level:2}];function f(e){const t={code:"code",h2:"h2",p:"p",...(0,r.R)(),...e.components};return(0,i.jsxs)("div",{className:"apidoc",children:[(0,i.jsxs)("article",{className:"apidoc__main",children:[(0,i.jsxs)("div",{className:"apidoc__header",children:[(0,i.jsx)("span",{className:"apidoc__method apidoc__method--get",children:"GET"}),(0,i.jsxs)("code",{className:"apidoc__path",children:["/v1/autocomplete/addresses/","{address}","/gbr"]})]}),(0,i.jsx)(o.o,{children:g.description}),(0,i.jsx)(t.h2,{id:"path-parameters",children:"Path parameters"}),(0,i.jsx)(a.H$,{path:h,in:"path"}),(0,i.jsx)(t.h2,{id:"query-parameters",children:"Query parameters"}),(0,i.jsx)(a.H$,{path:h,in:"query"}),(0,i.jsx)(t.h2,{id:"response",children:"Response"}),(0,i.jsxs)(t.p,{children:["Response is framed in the standard ",(0,i.jsx)(t.code,{children:"{ result, code, message }"})," envelope where\n",(0,i.jsx)(t.code,{children:"result"})," is a single ",(0,i.jsx)(t.code,{children:"Address"})," record."]}),(0,i.jsx)(a.lh,{property:"result",schema:p.components.schemas.GbrResolveAddressResponse.properties.result,links:y})]}),(0,i.jsxs)("aside",{className:"apidoc__aside",children:[(0,i.jsx)("div",{className:"apidoc__sample-label",children:"Request"}),(0,i.jsx)(a.ty,{path:h}),(0,i.jsx)("div",{className:"apidoc__sample-label",children:"Response"}),(0,i.jsx)(d.A,{groupId:"status",children:(0,i.jsx)(l.A,{value:"200",label:"200 OK",default:!0,children:(0,i.jsx)(a.st,{path:h})})})]})]})}function b(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(f,{...e})}):f(e)}},40333(e,t,n){n.d(t,{Ae:()=>m,C8:()=>i.C8,D0:()=>i.D0,H$:()=>o,IC:()=>s,JL:()=>l,QY:()=>i.QY,lh:()=>p,mA:()=>a,st:()=>u,ty:()=>c,yM:()=>h});var s=n(56125),i=n(59256);const r=(0,i.JL)(s),{Property:a,Parameters:o,Response:d,ResponseInline:l,ResponseLinked:p,RequestSamples:c,ResponseSample:u,RequestBody:m,RequestBodySample:h,schemas:g,components:y}=r},52539(e,t,n){n.d(t,{VD:()=>r,xB:()=>k,yS:()=>S});var s=n(26114),i=n(65723);const r="schema-",a=new Set,o=e=>{const t=e&&"object"==typeof e?e.$ref:void 0;return"string"==typeof t?t.split("/").pop():void 0},d=(e,t)=>{if(!Array.isArray(e.allOf))return e;const n={type:"object",properties:{},required:[]};for(const s of e.allOf){const e=d(t(s),t);Object.assign(n.properties,e.properties||{}),Array.isArray(e.required)&&n.required.push(...e.required)}return e.description&&(n.description=e.description),e.title&&(n.title=e.title),n},l=(e,t)=>
1{if("array"===e.type){const n=t(e.items||{});return`${l(n,t)}[]`}return Array.isArray(e.type)?e.type.join(" | "):e.type?e.type:Array.isArray(e.enum)&&e.enum.length?"number"==typeof e.enum[0]?"number":"string":"object"},p=e=>Array.isArray(e.oneOf)&&e.oneOf||Array.isArray(e.anyOf)&&e.anyOf||null,c=({name:e,type:t,required:n,badges:s="optional",foldable:a,defaultOpen:o=!0,extra:d,path:l,children:p})=>{const c=l?r+l:void 0,u=!1===n?"optional":!0===n&&"both"===s?"required":void 0,m=(0,i.jsxs)(i.Fragment,{children:[e&&(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("code",{className:"atlas-schema__name",children:e})," "]}),(0,i.jsx)("span",{className:"atlas-schema__type",children:t}),u&&(0,i.jsxs)(i.Fragment,{children:[" ",(0,i.jsx)("span",{className:`atlas-schema__${u}`,children:u})]}),d]});return a?(0,i.jsx)("li",{id:c,className:"atlas-schema__row atlas-schema__row--foldable",children:(0,i.jsxs)("details",{open:o,className:"atlas-schema__details",children:[(0,i.jsx)("summary",{className:"atlas-schema__row-head",children:m}),p]})}):(0,i.jsxs)("li",{id:c,className:"atlas-schema__row",children:[(0,i.jsx)("div",{className:"atlas-schema__row-head",children:m}),p]})},u=({name:e,href:t})=>(0,i.jsx)("a",{className:"atlas-schema__link",href:t,children:e}),m=({name:e,refKey:t,label:n,resolved:r,required:a,path:o,childBase:d,defaultOpen:l=!1,titleAsType:p=!1,ctx:u,seen:m})=>{const h=u.links[t],g=r.title!==t?r.title:void 0,y=p?void 0:g;return(0,i.jsxs)(c,{name:e,required:a,badges:u.badges,path:o,type:p&&g?(0,i.jsx)("span",{className:"atlas-schema__variant",children:g}):n||t,foldable:!0,defaultOpen:l,extra:(0,i.jsxs)(i.Fragment,{children:[y&&(0,i.jsxs)(i.Fragment,{children:[" ",(0,i.jsx)("span",{className:"atlas-schema__title",children:y})]}),h&&(0,i.jsxs)(i.Fragment,{children:[" ",(0,i.jsx)("a",{className:"atlas-schema__link atlas-schema__guide",href:h,children:"Full guide"})]})]}),children:[(0,i.jsx)(s.VY,{...r}),(0,i.jsx)(_,{schema:r,depth:0,parentPath:d,ctx:u,seen:new Set(m).add(t)})]})},h=({variants:e,depth:t,path:n,ctx:s,seen:r})=>{if("linked"===s.mode){const t=new Set,a=[];return e.forEach((e,p)=>{const h=o(e),g=d(s.resolveRef(e),s.resolveRef),y=h||l(g,s.resolveRef);if(t.has(y))return;if(t.add(y),h&&g.properties&&!r.has(h)){const e=n?`${n}.${h}`:h;return void a.push((0,i.jsx)(m,{refKey:h,resolved:g,path:e,childBase:0===p?n:e,titleAsType:!0,ctx:s,seen:r},y))}const _=h?s.links[h]:void 0,f=h?g.title:void 0,b=f?(0,i.jsx)("span",{className:"atlas-schema__variant",children:f}):y;a.push((0,i.jsx)(c,{type:_?(0,i.jsx)(u,{name:f||y,href:_}):b},y))}),(0,i.jsx)("ul",{className:"atlas-schema__list atlas-schema__nested",children:a})}return(0,i.jsx)("ul",{className:"atlas-schema__list atlas-schema__nested",children:e.map((e,a)=>(0,i.jsx)(y,{schema:e,depth:t+1,path:n,ctx:s,seen:r},a))})},g=({schema:e})=>(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(s.VY,{...e}),(0,i.jsx)(s.w3,{example:e.example,enumValues:e.enum,format:e.format,defaultValue:e.default})]}),y=({name:e,schema:t,required:n,depth:r,path:y,root:f=!1,ctx:b,seen:v=a})=>{const w=o(t),k=d(b.resolveRef(t),b.resolveRef);if(w&&v.has(w))return(0,i.jsx)(c,{name:e,required:n,badges:b.badges,path:y,type:w,children:(0,i.jsx)(s.VY,{...k})});const A=w?new Set(v).add(w):v;if("linked"===b.mode&&w&&!p(k)){if(k.properties)return(0,i.jsx)(m,{name:e,refKey:w,resolved:k,required:n,path:y,childBase:y,defaultOpen:f,ctx:b,seen:v});if(b.links[w])return(0,i.jsx)(c,{name:e,required:n,badges:b.badges,path:y,type:(0,i.jsx)(u,{name:w,href:b.links[w]}),children:(0,i.jsx)(s.VY,{...k})})}const P=r<b.maxDepth,S=p(k);if(S)return(0,i.jsxs)(c,{name:e,required:n,badges:b.badges,path:y,type:w||"one of",foldable:!0,defaultOpen:P,children:[(0,i.jsx)(s.VY,{...k}),(0,i.jsx)(h,{variants:S,depth:r,path:y,ctx:b,seen:A})]});const x=l(k,b.resolveRef);if("array"===k.type){const t=d(b.resolveRef(k.items||{}),b.resolveRef),a=o(k.items),l=p(t),u=!!a&&A.has(a);if("linked"===b.mode&&a&&t.properties&&!u)return(0,i.jsx)(m,{name:e,refKey:a,label:`${a}[]`,resolved:{...t,description:k.description||t.description},required:n,path:y,childBase:y,defaultOpen:f,ctx:b,seen:A});if(!u&&(l||t.properties)){const o=a?new Set(A).add(a):A;return(0,i.jsxs)(c,{name:e,required:n,badges:b.badges,path:y,type:x,foldable:!0,defaultOpen:P,children:[(0,i.jsx)(s.VY,{...k}),l?(0,i.jsx)(h,{variants:l,depth:r,path:y,ctx:b,seen:o}):(0,i.jsx)(_,{schema:t,depth:r+1,parentPath:y,ctx:b,seen:o})]})}return(0,i.jsx)(c,{name:e,required:n,badges:b.badges,path:y,type:x,children:(0,i.jsx)(g,{schema:k})})}return k.properties?(0,i.jsxs)(c,{name:e,required:n,badges:b.badges,path:y,type:w||x,foldable:!0,defaultOpen:P,children:[(0,i.jsx)(s.VY,{...k}),(0,i.jsx)(_,{schema:k,depth:r+1,parentPath:y,ctx:b,seen:A})]}):(0,i.jsx)(c,{name:e,required:n,badges:b.badges,path:y,type:x,children:(0,i.jsx)(g,{schema:k})})}
1,_=({schema:e,depth:t,parentPath:n,ctx:s,seen:r=a})=>{const o=e.properties||{},d=e.required||[],l=Object.keys(o);return l.length?(0,i.jsx)("ul",{className:"atlas-schema__list atlas-schema__nested",children:l.map(e=>(0,i.jsx)(y,{name:e,schema:o[e],required:d.includes(e),depth:t,path:n?`${n}.${e}`:e,ctx:s,seen:r},e))}):null},f="atlas-schema__row--hover",b="atlas-json__key--hover";let v=null;const w=e=>document.querySelectorAll(`a.atlas-json__key[href="#${CSS.escape(e)}"]`),k=e=>{e!==v&&(v&&(v.classList.remove(f),v.id&&w(v.id).forEach(e=>e.classList.remove(b))),v=e,e&&(e.classList.add(f),e.id&&w(e.id).forEach(e=>e.classList.add(b))))},A=e=>{const t=e.target;k(t.closest(".atlas-schema__row"))},P=(e,t)=>{const n=e.currentTarget.closest(".atlas-schema");n&&n.querySelectorAll("details").forEach(e=>{e.open=t})},S=e=>{const t=({property:t,schema:n,mode:s="inline",badges:r="optional",maxDepth:a,links:o={}})=>{if(!n)return null;const d={mode:s,badges:r,links:o,resolveRef:e,maxDepth:a??("linked"===s?1:2)};return(0,i.jsxs)("section",{className:"atlas-schema",onMouseOver:A,onMouseLeave:()=>k(null),children:[(0,i.jsxs)("div",{className:"atlas-schema__controls",children:[(0,i.jsx)("button",{type:"button",onClick:e=>P(e,!0),children:"Expand all"}),(0,i.jsx)("button",{type:"button",onClick:e=>P(e,!1),children:"Collapse all"})]}),(0,i.jsx)("ul",{className:"atlas-schema__list",children:(0,i.jsx)(y,{name:t,schema:n,depth:0,path:t,root:!0,ctx:d})})]})};return{Response:t,ResponseInline:e=>(0,i.jsx)(t,{...e,mode:"inline"}),ResponseLinked:e=>(0,i.jsx)(t,{...e,mode:"linked"})}}},52797(e,t,n){n.d(t,{O:()=>c});var s=n(22155),i=n(35061),r=n(53105),a=n(29981),o=n(52539),d=n(65723);const l={curl:"bash",shell:"bash",bash:"bash",javascript:"javascript",js:"javascript",node:"javascript",typescript:"typescript",ts:"typescript",python:"python",py:"python",http:"http",json:"json",go:"go",php:"php",ruby:"ruby"},p={CLI:"curl"},c=(e,t)=>{const n=(t,n)=>e.paths?.[t]?.[n],s=(e,n=new Set)=>{const i=e&&"object"==typeof e?e.$ref:void 0;if("string"==typeof i){if(n.has(i))return null;n=new Set(n).add(i)}const r=t(e);if(!r||"object"!=typeof r)return null;if(void 0!==r.example)return r.example;if(void 0!==r.default)return r.default;if(Array.isArray(r.enum)&&r.enum.length)return r.enum[0];const a=r.oneOf||r.anyOf;if(Array.isArray(a)&&a.length)return s(a[0],n);if(Array.isArray(r.allOf))return r.allOf.reduce((e,t)=>Object.assign(e,s(t,n)||{}),{});if("array"===r.type)return[s(r.items||{},n)];if(r.properties||"object"===r.type){const e={};for(const[t,i]of Object.entries(r.properties||{}))e[t]=s(i,n);return e}switch(r.type){case"string":return"";case"number":case"integer":return 0;case"boolean":return!0;default:return null}};return{RequestSamples:({path:e,method:t="get"})=>{const s=n(e,t),o=s?.["x-codeSamples"]||s?.["x-code-samples"]||[];return o.length?(0,d.jsx)(i.A,{groupId:"lang",children:o.map((e,t)=>{const n=(e=>p[e]||e)(e.label||e.lang||`Sample ${t+1}`);return(0,d.jsx)(r.A,{value:n,label:n,default:0===t,children:(0,d.jsx)(a.A,{language:(s=e.lang||"",l[s.toLowerCase()]||s.toLowerCase()),children:String(e.source??"").replace(/\n$/,"")})},n);var s})}):null},ResponseSample:({path:e,method:t="get",status:i="200",example:r})=>{const a=n(e,t),o=a?.responses?.[i]?.content?.["application/json"];if(!o)return null;let l;if(void 0!==r)l=r;else if(o.examples){const e=Object.values(o.examples)[0];l=e?.value}else void 0!==o.example?l=o.example:o.schema&&(l=s(o.schema));return void 0===l?null:(0,d.jsx)(b,{value:l})},RequestBodySample:({path:e,method:t="post"})=>{const i=n(e,t),r=i?.requestBody?.content?.["application/json"];if(!r)return null;let a;if(r.examples){const e=Object.values(r.examples)[0];a=e?.value}else void 0!==r.example?a=r.example:r.schema&&(a=s(r.schema));return void 0===a?null:(0,d.jsx)(b,{value:a,pathPrefix:"body"})},exampleFromSchema:s}},u=" ",m="atlas-schema__row--target",h=e=>{const t=e.currentTarget.getAttribute("href");if(!t||!t.startsWith("#"))return;if("undefined"==typeof document)return;const n=document.getElementById(t.slice(1));if(n){e.preventDefault();for(let e=n.parentElement;e;e=e.parentElement)e instanceof HTMLDetailsElement&&(e.open=!0);n.scrollIntoView({behavior:"smooth",block:"center"}),n.classList.remove(m),n.offsetWidth,n.classList.add(m),window.setTimeout(()=>n.classList.remove(m),1800)}},g=(e,t,n)=>null===e?(0,d.jsx)("span",{className:"atlas-json__null",children:"null"}):"boolean"==typeof e?(0,d.jsx)("span",{className:"atlas-json__bool",children:String(e)}):"number"==typeof e?(0,d.jsx)("span",{className:"atlas-json__num",children:String(e)}):"string"==typeof e?(0,d.jsx)("span",{className:"atlas-json__str",children:JSON.stringify(e)}):Array.isArray(e)?y(e,t,n):e&&"object"==typeof e?_(e,t,n):(0,d.jsx)("span",{children:String(e)}),y=(e,t,n)=>{if(0===e.length)return(0,d.jsx)(d.Fragment,{children:"[]"});const i=u.repeat(t+1),r=u.repeat(t);return(0,d.jsxs)(d.Fragment,{children:["[","\n",e.map((r,a)=>(0,d.jsxs)(s.Fragment,{children:[i,g(r,t+1,n),a<e.length-1?",":"","\n"]},a)),r,"]"]})}
1,_=(e,t,n)=>{const i=Object.keys(e);if(0===i.length)return(0,d.jsx)(d.Fragment,{children:"{}"});const r=u.repeat(t+1),a=u.repeat(t);return(0,d.jsxs)(d.Fragment,{children:["{","\n",i.map((a,l)=>{const p=n?`${n}.${a}`:a;return(0,d.jsxs)(s.Fragment,{children:[r,(0,d.jsx)("a",{className:"atlas-json__key",href:`#${o.VD}${p}`,onClick:h,children:JSON.stringify(a)}),": ",g(e[a],t+1,p),l<i.length-1?",":"","\n"]},a)}),a,"}"]})},f=e=>{const t=e.target.closest("a.atlas-json__key"),n=t?.getAttribute("href")?.slice(1);(0,o.xB)(n?document.getElementById(n):null)},b=({value:e,pathPrefix:t=""})=>(0,d.jsx)("pre",{className:"atlas-json",onMouseOver:f,onMouseLeave:()=>(0,o.xB)(null),children:(0,d.jsx)("code",{children:g(e,0,t)})})},56125(e){e.exports=JSON.parse('{"openapi":"3.0.3","info":{"version":"5.0.0","license":{"name":"Copyright (C) IDDQD Limited - All Rights Reserved","url":"https://terms.ideal-postcodes.co.uk"},"title":"API Reference","termsOfService":"https://terms.ideal-postcodes.co.uk","description":"## Getting Started\\n\\nAll API methods are either a `GET`, `POST` or `OPTIONS` request.\\n\\nThe API communicates over both HTTPS and plain HTTP using IPv4 and IPv6.\\n\\nWe use appropriate HTTP status codes where possible to indicate the request status. Every error body also carries a numeric `code`. The [error codes guide](https://docs.ideal-postcodes.co.uk/docs/guides/error-codes) lists each code and how to fix it.\\n\\n## OpenAPI Spec\\n\\nOur OpenAPI specification is available at:\\n\\n- [npm package](https://www.npmjs.com/package/@ideal-postcodes/openapi)\\n- [API Reference](https://
1openapi.ideal-postcodes.co.uk)\\n- [OpenAPI v3 JSON File](https://openapi.ideal-postcodes.co.uk/openapi.json)\\n- [OpenAPI v3 YAML File](https://openapi.ideal-postcodes.co.uk/openapi.yaml)\\n\\n## Rate Limiting\\n\\nEach IP address is rate limited at 30 requests per second. Exceeding the limit returns a 503 response.\\n\\nThe autocomplete API has an additional rate limit.\\n\\nIf you expect to exceed the limit, contact us and we can move you to an endpoint with a higher limit.\\n\\n## Authentication\\n\\nMost requests require an **API key** for authentication. Authenticate by passing an `api_key` as part of the query string. For example:\\n\\n```\\napi.ideal-postcodes.co.uk/v1/autocomplete/addresses?api_key=ak_test&q=parkside\\n```\\n\\nAlternatively, pass the key in the `Authorization` header:\\n\\n```\\nAuthorization: api_key=\\"ak_test\\" [other_key=\\"foo\\"]\\n```\\n\\n## Versioning\\n\\nThis API is versioned with a simple prefix in the URL. The current version is `/v1/`. We will maintain backwards-compatibility by releasing breaking changes under a new version.\\n\\nThe following changes are backwards-compatible:\\n\\n- Adding new properties to existing API responses\\n- Adding new API endpoints\\n- Adding new optional request parameters to existing API endpoints\\n- Changing the order of properties in existing API responses\\n- Changing the autocomplete address suggestion format\\n\\n## Error Handling\\n\\nA successful lookup returns an HTTP status code of 200 and a response code of 2000 in the body.\\n\\nAny other status code means an error. These range from a benign 404 (resource not found) to more urgent problems, such as an API Key out of credit or a failed authentication.\\n\\n## Testing\\n\\nTo test the API, create an account. Each new account comes with a free test balance. Contact us if you need more for testing and integration.\\n\\nThe code samples in this reference use the `ak_test` key. You can use it too, but it is capped at 5 requests per day.\\n\\n## Metadata\\n\\nYou can annotate requests that affect your balance with arbitrary metadata. We store it with your lookup history, and you can query it later via the API or the dashboard. We call the ability to label your requests [tagging](https://docs.ideal-postcodes.co.uk/docs/guides/tags).\\n\\n## Response Codes\\n\\nThe API returns two indicators to help you determine the status of each HTTP request.\\n\\nThe first is the **HTTP Status**, which is found in the status line of every HTTP response. The API will return status codes that adhere to HTTP/1.1 Specifications wherever possible.\\n\\n`2XX` status codes indicate success while `4XX` and `5XX` indicate client and server errors respectively.\\n\\nThe second is the **API response code**, which can be found in the `code` property of the response body. This code gives a more specific reason for a failure and points you in the right direction when debugging.\\n","contact":{"email":"[email protected]","name":"Support","url":"https://ideal-postcodes.co.uk/support"}},"servers":[{"url":"https://api.ideal-postcodes.co.uk/v1","description":"API Server","variables":{}}],"tags":[{"name":"Address Search","description":"Global address autocomplete, for search-as-you-type"},{"name":"Place Search","description":"Global places search to identify geographical names and places"},{"name":"UK","description":"UK Address and Postcode Search"},{"name":"Keys","description":"Monitor and manage API Keys"},{"name":"Licensees","description":"The Licensee resource represents an alternate legal End User of our data who may not be the same entity as the owners of the account.\\n\\nLicensees underpin our sublicensing platform, which lets you license multiple external organisations or individuals to access data under one account.\\n\\nSublicensing suits platform vendors who serve multiple clients, each with their own users.\\n"},{"name":"Configs","description":"The Config resource assigns serialised configuration data to an API Key. Retrieve the payload later to configure your integration at runtime.\\n\\nUseful if you need to configure your integration remotely rather than editing code in situ.\\n"},{"name":"suggestion","x-displayName":"Address Suggestion","description":"Address Suggestions are simple, human readable representations of an address. This format is sufficient for a user to determine an address match in an address autocomplete interface. A second request must be made to the API to gather fully validated address.\\n\\nSee our Address Search APIs for more information on address autocompletion.\\n\\n<SchemaDefinition schemaRef=\\"#/components/schemas/AddressSuggestion\\" />\\n"},{"name":"address","x-displayName":"Address","description":"The address format returned by every endpoint bar the postcode and address list, for every dataset, UK and non-UK alike. `dataset` identifies the source; `native` carries the raw dataset record and is always present.\\n\\n<SchemaDefinition schemaRef=\\"#/components/schemas/Address\\" />\\n"},{"name":"address_list_item","x-displayName":"Address (list endpoints)","description":"The same fields as `Address`, returned by the postcode and address list endpoints. `native` is present for AddressBase and non-UK datasets only, never for the Royal Mail PAF family.\\n\\n<SchemaDefinition schemaRef=\\"#/components/schemas/AddressListItem\\" />\\n"},{"name":"paf_native","x-displayName":"PAF","description":"Raw Royal Mail Postcode Address File record.\\n\\n<SchemaDefinition schemaRef=\\"#/components/schemas/PafAddress\\" />\\n"},{"name":"mr_native","x-displayName":"Multiple Residence","description":"Raw Royal Mail Multiple Residence record.\\n\\n<SchemaDefinition schemaRef=\\"#/components/schemas/
1MrAddress\\" />\\n"},{"name":"nyb_native","x-displayName":"Not Yet Built","description":"Raw Royal Mail Not Yet Built record.\\n\\n<SchemaDefinition schemaRef=\\"#/components/schemas/NybAddress\\" />\\n"},{"name":"pafa_native","x-displayName":"PAF Alias","description":"Raw Royal Mail Alias record.\\n\\n<SchemaDefinition schemaRef=\\"#/components/schemas/PafaAddress\\" />\\n"},{"name":"pafw_native","x-displayName":"Welsh PAF","description":"Raw Royal Mail Welsh language record.\\n\\n<SchemaDefinition schemaRef=\\"#/components/schemas/PafwAddress\\" />\\n"},{"name":"ecaf_address","x-displayName":"IE Eircode ECAF","description":"Standard Republic of Ireland Address format as reported by the Eircode ECAF file.\\n\\n<SchemaDefinition schemaRef=\\"#/components/schemas/EcafAddress\\" />\\n"},{"name":"ecad_address","x-displayName":"IE Eircode ECAD","description":"ECAF file including additional data for each address.\\n\\n<SchemaDefinition schemaRef=\\"#/components/schemas/EcadAddress\\" />\\n"},{"name":"ab_address","x-displayName":"AddressBase Core","description":"AddressBase Core Address. An alternative to UK PAF dataset from Ordnance Survey.\\n\\nPlease contact us to have this enabled on your account.\\n\\n<SchemaDefinition schemaRef=\\"#/components/schemas/AbAddress\\" />\\n"},{"name":"abp_address","x-displayName":"AddressBase Premium","description":"AddressBase Premium Address. The full property-level record from Ordnance\\nSurvey AddressBase Premium - the flat `abp.addresses` row (BLPU, DPA,\\nClassification, Organisation, LPI, Street and cross references).\\n\\nPlease contact us to have this enabled on your account.\\n\\n<SchemaDefinition schemaRef=\\"#/components/schemas/AbpAddress\\" />\\n"},{"name":"bev_address","x-displayName":"AT BEV","description":"Standard Austrian Address format as reported by the BEV (Bundesamt\\nf\xfcr Eich- und Vermessungswesen) address register.\\n\\n<SchemaDefinition schemaRef=\\"#/components/schemas/BevAddress\\" />\\n"},{"name":"swt_address","x-displayName":"CH Swisstopo","description":"Standard Swiss and Liechtenstein Address format from the Swisstopo\\nofficial directories of buildings, streets and localities.\\n\\n<SchemaDefinition schemaRef=\\"#/components/schemas/SwtAddress\\" />\\n"},{"name":"gnaf_address","x-displayName":"AU G-NAF","description":"Standard Australian Address format from Geoscape\'s Geocoded National\\nAddress File (G-NAF).\\n\\n<SchemaDefinition schemaRef=\\"#/components/schemas/GnafAddress\\" />\\n"},{"name":"fodbosa_address","x-displayName":"BE BeST","description":"Standard Belgian Address format from the federal BeST address dataset\\n(FOD BOSA).\\n\\n<SchemaDefinition schemaRef=\\"#/components/schemas/FodbosaAddress\\" />\\n"},{"name":"cannar_address","x-displayName":"CA National Address Register","description":"Standard Canadian Address format from the National Address Register.\\n\\n<SchemaDefinition schemaRef=\\"#/components/schemas/CannarAddress\\" />\\n"},{"name":"sdfi_address","x-displayName":"DK SDFI","description":"Standard Danish Address format from the Danish Agency for Data Supply\\nand Infrastructure (SDFI).\\n\\n<SchemaDefinition schemaRef=\\"#/components/schemas/SdfiAddress\\" />\\n"},{"name":"ban_address","x-displayName":"FR BAN","description":"Standard French Address format from the Base Adresse Nationale (BAN).\\n\\n<SchemaDefinition schemaRef=\\"#/components/schemas/BanAddress\\" />\\n"},{"name":"upujp_address","x-displayName":"JP UPU","description":"Standard Japanese Address format from the Japan UPU address file.\\n\\n<SchemaDefinition schemaRef=\\"#/components/schemas/UpujpAddress\\" />\\n"},{"name":"mois_address","x-displayName":"KR MOIS","description":"Standard South Korean Address format from the Korean Ministry of the\\nInterior and Safety (MOIS).\\n\\n<SchemaDefinition schemaRef=\\"#/components/schemas/MoisAddress\\" />\\n"},{"name":"kadaster_address","x-displayName":"NL Kadaster","description":"Standard Dutch Address format from Kadaster BAG 2.0.\\n\\n<SchemaDefinition schemaRef=\\"#/components/schemas/KadasterAddress\\" />\\n"},{"name":"kartverket_address","x-displayName":"NO Kartverket","description":"Standard Norweg
1ian Address format from the Norwegian Mapping Authority\\n(Kartverket).\\n\\n<SchemaDefinition schemaRef=\\"#/components/schemas/KartverketAddress\\" />\\n"},{"name":"here_address","x-displayName":"HERE","description":"Address from the global HERE dataset, covering regions not served by a\\nnational address file.\\n\\n<SchemaDefinition schemaRef=\\"#/components/schemas/HereAddress\\" />\\n"},{"name":"geonames_place","x-displayName":"GeoNames Place","description":"GeoNames place record\\n\\n<SchemaDefinition schemaRef=\\"#/components/schemas/GeonamesPlace\\" />\\n"}],"externalDocs":{"description":"More on our APIs, libraries with guides and examples","url":"https://docs.ideal-postcodes.co.uk"},"paths":{"/postcodes/{postcode}":{"get":{"tags":["UK"],"summary":"Lookup Postcode","operationId":"Postcodes","description":"Returns the complete list of addresses for a postcode. Postcode searches are space and case insensitive.\\n\\nEach request looks up one postcode. To extract the addresses for several postcodes, send one request per postcode.\\n\\nUse it to power postcode driven address searches, like [Postcode Lookup](/docs/postcode-lookup/).\\n\\nPostcode lookup covers the United Kingdom, the Republic of Ireland, the Netherlands and Singapore. The API detects the format of the postcode you submit. UK and Irish postcodes are searched by default. For a Dutch or Singapore postcode, set `context` to `NLD` or `SGP`, or to `GLOBAL` to accept any supported format.\\n\\nUK postcodes need PAF, Multiple Residence, Not Yet Built, PAF Alias, PAF Welsh, AddressBase or AddressBase Premium on your key. Eircodes need ECAD or ECAF. Dutch postcodes need Kadaster. Singapore postcodes need HERE Asia Pacific. Without a matching licence the request is rejected.\\n\\nAn unfound postcode costs no lookup. A postcode that returns addresses costs one.\\n\\n## Postcode Not Found\\n\\nInvalid postcodes do not affect your lookup balance. The API returns a `404` response with this body:\\n\\n```json\\n{\\n \\"code\\": 4040,\\n \\"message\\": \\"Postcode not found\\",\\n \\"suggestions\\": [\\"SW1A 0AA\\"]\\n}\\n```\\n\\n### Suggestions\\n\\nIf a postcode cannot be found, the API returns up to 5 of the closest matching postcodes. It corrects common errors first (e.g. mixing up `O` and `0` or `I` and `1`).\\n\\nIf the suggestion list is small (fewer than 3), the correct postcode is likely to be among them. Notify the user or trigger new searches immediately.\\n\\nThe suggestion list is empty if the postcode has deviated too far from a valid postcode format.\\n\\n## Multiple Residence\\n\\nA small number of postcodes return more than 100 premises. The API returns 100 addresses per page, so use `page` to paginate the result set.\\n\\n## Testing\\n\\n- **ID1 1QD** Returns a successful postcode lookup response `2000`\\n- **ID1 KFA** Returns \\"postcode not found\\" error `4040`\\n- **ID1 CLIP** Returns \\"no lookups remaining\\" error `4020`\\n- **ID1 CHOP** Returns \\"daily (or individual) lookup limit breached\\" error `4021`\\n\\nTest requests undergo the usual authentication and restriction rules. They surface any issues during implementation and do not cost you a lookup.\\n","parameters":[{"name":"postcode","in":"path","description":"Postcode to retrieve","required":true,"style":"simple","explode":false,"example":"SW1A 2AA","schema":{"type":"string"}},{"$ref":"#/components/parameters/ApiKeyParam"},{"$ref":"#/components/parameters/FilterParam"},{"$ref":"#/components/parameters/PageParam"},{"$ref":"#/components/parameters/TagsParam"},{"$ref":"#/components/parameters/DatasetParam"},{"$ref":"#/components/parameters/ContextParam"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostcodeResponse"},"examples":{"Postcode Found":{"value":{"result":[{"postcode":"SW1A 2AA","postcode_inward":"2AA","postcode_outward":"SW1A","post_town":"London","dependant_locality":"","double_dependant_locality":"","thoroughfare":"Downing Street","dependant_thoroughfare":"","building_number":"10","building_name":"","sub_building_name":"","po_box":"","department_name":"","organisation_name":"Prime Minister & First Lord Of The Treasury","udprn":23747771,"postcode_type":"S","su_organisation_indicator":"","delivery_point_suffix":"1A","line_1":"Prime Minister & First Lord Of The Treasury","line_2":"10 Downing Street","line_3":"","premise":"10","longitude":-0.12767,"latitude":51.503541,"eastings":530047,"northings":179951,"country":"England","traditional_county":"Greater London","administrative_county":"","postal_county":"London","county":"London","district":"Westminster","ward":"St. James\'s","uprn":"100023336956","id":"paf_23747771","country_iso":"GBR","country_iso_2":"GB","county_code":"","language":"en","umprn":"","dataset":"paf"}],"code":2000,"message":"Success","limit":100,"page":0,"total":1}}}}}},"404":{"description":"Postcode Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostcodeNotFoundResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-codeSamples":[{"lang":"http","label":"URL","source":"https://api.ideal-postcodes.co.uk/v1/postcodes/SW1A2AA?api_key=ak_test\\n"},{"lang":"cURL","label":"curl","source":"curl -G \'https://api.ideal-postcodes.co.uk/v1/postcodes/SW1A2AA\' \\\\\\n -d \'api_key=ak_test\'\\n"},{"lang":"JavaScript","label":"JavaScript","source":"const response = await fetch(\\n \'https://api.ideal-postcodes.co.uk/v1/postcodes/SW1A2AA?\' +\\n new URLSearchParams({\\n api_key: \'ak_test\',\\n })\\n);\\n\\nconst { result } = await response.json();\\n"},{"lang":"Python","label":"Python","source":"import requests\\n\\nresponse = requests.get(\\n \\"https://api.ideal-postcodes.co.uk/v1/postcodes/SW1A2AA\\",\\n params={\\n \\"api_key\\": \\"ak_test\\",\\n }
1,\\n)\\nresult = response.json()[\\"result\\"]\\n"},{"lang":"Ruby","label":"Ruby","source":"require \\"net/http\\"\\nrequire \\"json\\"\\n\\nuri = URI(\\"https://api.ideal-postcodes.co.uk/v1/postcodes/SW1A2AA\\")\\nuri.query = URI.encode_www_form(api_key: \\"ak_test\\")\\nresult = JSON.parse(Net::HTTP.get(uri))[\\"result\\"]\\n"},{"lang":"PHP","label":"PHP","source":"<?php\\n$response = file_get_contents(\\n \\"https://api.ideal-postcodes.co.uk/v1/postcodes/SW1A2AA?\\" .\\n http_build_query([\\n \\"api_key\\" => \\"ak_test\\",\\n ])\\n);\\n$result = json_decode($response, true)[\\"result\\"];\\n"}]}},"/udprn/{udprn}":{"get":{"tags":["UK"],"summary":"Retrieve by UDPRN","operationId":"UDPRN","description":"Returns the full address for a Unique Delivery Point Reference Number (UDPRN).\\n\\nStoring the UDPRN lets you retrieve the most recent information for an address, and test whether an address has been deleted.\\n\\nUDPRNs are an eight digit unique numeric code (e.g. `25962203`) for any premise on the Postcode Address File, Royal Mail\'s database of UK addresses. The API searches PAF first, then Not Yet Built if your key is licensed for it. A UDPRN on neither dataset returns `404`.\\n\\nEach address returned costs a lookup.\\n\\n## Testing\\n\\nWe provide test UDPRNs that yield both successful and unsuccessful responses. They are:\\n\\n- `0` Returns a successful UDPRN lookup response `2000`\\n- `-1` Returns \\"UDPRN not found\\", error `4044`\\n- `-2` Returns \\"no lookups remaining\\", error `4020`\\n- `-3` Returns \\"daily (or individual) lookup limit breached\\", error `4021`\\n\\nTest requests undergo the usual authentication and restriction rules. They surface any issues during implementation and do not cost you a lookup.\\n","parameters":[{"name":"udprn","in":"path","description":"UDPRN to retrieve","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"$ref":"#/components/parameters/ApiKeyParam"},{"$ref":"#/components/parameters/FilterParam"}],"responses":{"200":{"description":"Success","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UDPRNResponse"},"examples":{"Valid UDPRN":{"value":{"result":{"postcode":"SW1A 2AA","postcode_inward":"2AA","postcode_outward":"SW1A","post_town":"London","dependant_locality":"","double_dependant_locality":"","thoroughfare":"Downing Street","dependant_thoroughfare":"","building_number":"10","building_name":"","sub_building_name":"","po_box":"","department_name":"","organisation_name":"Prime Minister & First Lord Of The Treasury","udprn":23747771,"postcode_type":"S","su_organisation_indicator":"","delivery_point_suffix":"1A","line_1":"Prime Minister & First Lord Of The Treasury","line_2":"10 Downing Street","line_3":"","premise":"10","longitude":-0.12767,"latitude":51.503541,"eastings":530047,"northings":179951,"country":"England","traditional_county":"Greater London","administrative_county":"","postal_county":"London","county":"London","district":"Westminster","ward":"St. James\'s","uprn":"100023336956","id":"paf_23747771","country_iso":"GBR","country_iso_2":"GB","county_code":"","language":"en","umprn":"","dataset":"paf","native":{"dataset":"paf","postcode":"SW1A 2AA","post_town":"London","dependant_locality":"","double_dependant_locality":"","thoroughfare":"Downing Street","dependant_thoroughfare":"","building_number":"10","building_name":"","sub_building_name":"","po_box":"","department_name":"","organisation_name":"Prime Minister & First Lord Of The Treasury","udprn":23747771,"postcode_type":"S","su_organisation_indicator":"","delivery_point_suffix":"1A"}},"code":2000,"message":"Success"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-codeSamples":[{"lang":"http","label":"URL","source":"https://api.ideal-postcodes.co.uk/v1/udprn/0?api_key=ak_test\\n"},{"lang":"cURL","label":"curl","source":"curl -G \'https://api.ideal-postcodes.co.uk/v1/udprn/0\' \\\\\\n -d \'api_key=ak_test\'\\n"},{"lang":"JavaScript","label":"JavaScript","source":"const response = await fetch(\\n \'https://api.ideal-postcodes.co.uk/v1/udprn/0?\' +\\n new URLSearchParams({\\n api_key: \'ak_test\',\\n })\\n);\\n\\nconst { result } = await response.json();\\n"},{"lang":"Python","label":"Python","source":"import requests\\n\\nresponse = requests.get(\\n \\"https://api.ideal-postcodes.co.uk/v1/udprn/0\\",\\n params={\\n \\"api_key\\": \\"ak_test\\",\\n }
1,\\n)\\nresult = response.json()[\\"result\\"]\\n"},{"lang":"Ruby","label":"Ruby","source":"require \\"net/http\\"\\nrequire \\"json\\"\\n\\nuri = URI(\\"https://api.ideal-postcodes.co.uk/v1/udprn/0\\")\\nuri.query = URI.encode_www_form(api_key: \\"ak_test\\")\\nresult = JSON.parse(Net::HTTP.get(uri))[\\"result\\"]\\n"},{"lang":"PHP","label":"PHP","source":"<?php\\n$response = file_get_contents(\\n \\"https://api.ideal-postcodes.co.uk/v1/udprn/0?\\" .\\n http_build_query([\\n \\"api_key\\" => \\"ak_test\\",\\n ])\\n);\\n$result = json_decode($response, true)[\\"result\\"];\\n"}]}},"/umprn/{umprn}":{"get":{"tags":["UK"],"summary":"Retrieve by UMPRN","operationId":"UMPRN","description":"Returns the address for a multiple occupancy household, identified by its UMPRN (Multiple Residence Unique ID).\\n\\nUMPRNs are a unique numeric code for any Multiple Residence household on the optional Multiple Residence dataset. Your key needs that dataset enabled. Without it, and for any UMPRN we cannot find, the API returns `404`.\\n\\n## Pricing\\n\\nPer lookup charges apply. We do not charge for empty responses.\\n\\n## Testing\\n\\nWe provide test UMPRNs that yield both successful and unsuccessful responses. They are:\\n\\n- `0` Returns a successful UMPRN lookup response `2000`\\n- `-1` Returns \\"UMPRN not found\\", error `4046`\\n- `-2` Returns \\"no lookups remaining\\", error `4020`\\n- `-3` Returns \\"daily (or individual) lookup limit breached\\", error `4021`\\n\\nTest requests undergo the usual authentication and restriction rules. They surface any issues during implementation and do not cost you a lookup.\\n","parameters":[{"name":"umprn","in":"path","description":"UMPRN to retrieve","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"$ref":"#/components/parameters/ApiKeyParam"},{"$ref":"#/components/parameters/FilterParam"}],"responses":{"200":{"description":"Success","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UMPRNResponse"},"examples":{"Valid UMPRN":{"value":{"result":{"postcode":"CV4 7AL","postcode_inward":"7AL","postcode_outward":"CV4","post_town":"Coventry","dependant_locality":"","double_dependant_locality":"","thoroughfare":"Gibbet Hill Road","dependant_thoroughfare":"","building_number":"","building_name":"Block 1 Arthur Vick","sub_building_name":"Room 249a","po_box":"","department_name":"","organisation_name":"","udprn":5770157,"postcode_type":"S","su_organisation_indicator":"","delivery_point_suffix":"1A","line_1":"Room 249a, Block 1 Arthur Vick","line_2":"Gibbet Hill Road","line_3":"","premise":"Room 249a, Block 1 Arthur Vick","longitude":-1.5648072,"latitude":52.3858227,"eastings":429716,"northings":276509,"country":"England","traditional_county":"Warwickshire","administrative_county":"","postal_county":"West Midlands","county":"West Midlands","district":"Coventry","ward":"Wainbody","uprn":"200001572050","id":"mr_50906058","country_iso":"GBR","country_iso_2":"GB","county_code":"","language":"en","umprn":50906058,"dataset":"mr","native":{"dataset":"mr","postcode":"CV4 7AL","post_town":"Coventry","dependant_locality":"","double_dependant_locality":"","thoroughfare":"Gibbet Hill Road","dependant_thoroughfare":"","building_number":"","building_name":"Block 1 Arthur Vick","sub_building_name":"Room 249a","department_name":"","organisation_name":"","udprn":5770157,"postcode_type":"S","su_organisation_indicator":"","delivery_point_suffix":"1A","umprn":50906058}},"code":2000,"message":"Success"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-codeSamples":[{"lang":"http","label":"URL","source":"https://api.ideal-postcodes.co.uk/v1/umprn/0?api_key=ak_test\\n"},{"lang":"cURL","label":"curl","source":"curl -G \'https://api.ideal-postcodes.co.uk/v1/umprn/0\' \\\\\\n -d \'api_key=ak_test\'\\n"},{"lang":"JavaScript","label":"JavaScript","source":"const response = await fetch(\\n \'https://api.ideal-postcodes.co.uk/v1/umprn/0?\' +\\n new URLSearchParams({\\n api_key: \'ak_test\',\\n })\\n);\\n\\nconst { result } = await response.json();\\n"},{"lang":"Python","label":"Python","source":"import requests\\n\\nresponse = requests.get(\\n \\"https://api.ideal-postcodes.co.uk/v1/umprn/0\\",\\n params={\\n \\"api_key\\": \\"ak_test\\",\\n }
1,\\n)\\nresult = response.json()[\\"result\\"]\\n"},{"lang":"Ruby","label":"Ruby","source":"require \\"net/http\\"\\nrequire \\"json\\"\\n\\nuri = URI(\\"https://api.ideal-postcodes.co.uk/v1/umprn/0\\")\\nuri.query = URI.encode_www_form(api_key: \\"ak_test\\")\\nresult = JSON.parse(Net::HTTP.get(uri))[\\"result\\"]\\n"},{"lang":"PHP","label":"PHP","source":"<?php\\n$response = file_get_contents(\\n \\"https://api.ideal-postcodes.co.uk/v1/umprn/0?\\" .\\n http_build_query([\\n \\"api_key\\" => \\"ak_test\\",\\n ])\\n);\\n$result = json_decode($response, true)[\\"result\\"];\\n"}]}},"/keys/{key}":{"get":{"tags":["Keys"],"summary":"Availability","operationId":"KeyAvailability","description":"Returns public information on an API Key: whether it can be used right now (`available`), the search contexts the key is licensed for (`contexts`) and the context that best matches the caller\'s IP address (`context`).\\n\\nThe endpoint accepts API Keys (beginning `ak_`) and sub-licensed keys (beginning `sl_`), and needs no `user_token`.\\n\\nA key that exists but cannot be used, because it has no lookups left or has breached a limit, returns `200` with `\\"available\\": false`. An unknown or malformed key returns an error.\\n\\nSupply a valid `user_token` and the endpoint returns the key\'s private details instead, as `GET /keys/{key}/details` does. A `user_token` that does not own the key is rejected.\\n","parameters":[{"$ref":"#/components/parameters/ApiKeyPathParam"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyResponse"}}}},"404":{"description":"Invalid Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-codeSamples":[{"lang":"http","label":"URL","source":"https://api.ideal-postcodes.co.uk/v1/keys/ak_test\\n"},{"lang":"cURL","label":"curl","source":"curl \'https://api.ideal-postcodes.co.uk/v1/keys/ak_test\'\\n"},{"lang":"JavaScript","label":"JavaScript","source":"const response = await fetch(\'https://api.ideal-postcodes.co.uk/v1/keys/ak_test\');\\n\\nconst { result } = await response.json();\\n"},{"lang":"Python","label":"Python","source":"import requests\\n\\nresponse = requests.get(\\"https://api.ideal-postcodes.co.uk/v1/keys/ak_test\\")\\nresult = response.json()[\\"result\\"]\\n"},{"lang":"Ruby","label":"Ruby","source":"require \\"net/http\\"\\nrequire \\"json\\"\\n\\nuri = URI(\\"https://api.ideal-postcodes.co.uk/v1/keys/ak_test\\")\\nresult = JSON.parse(Net::HTTP.get(uri))[\\"result\\"]\\n"},{"lang":"PHP","label":"PHP","source":"<?php\\n$response = file_get_contents(\\"https://api.ideal-postcodes.co.uk/v1/keys/ak_test\\");\\n$result = json_decode($response, true)[\\"result\\"];\\n"}]}},"/keys/{key}/details":{"get":{"tags":["Keys"],"summary":"Details","operationId":"KeyDetails","description":"Returns private data on a key: remaining lookups, licensed datasets, usage limits, notification settings and the search contexts the key can serve.","parameters":[{"$ref":"#/components/parameters/ApiKeyPathParam"},{"$ref":"#/components/parameters/UserTokenParam"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyDetailsResponse"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"deprecated":false,"x-codeSamples":[{"lang":"http","label":"URL","source":"https://api.ideal-postcodes.co.uk/v1/keys/ak_test/details?user_token=uk_secret\\n"},{"lang":"cURL","label":"curl","source":"curl -G \'https://api.ideal-postcodes.co.uk/v1/keys/ak_test/details\' \\\\\\n -d \'user_token=uk_secret\'\\n"},{"lang":"JavaScript","label":"JavaScript","source":"const response = await fetch(\\n \'https://api.ideal-postcodes.co.uk/v1/keys/ak_test/details?\' +\\n new URLSearchParams({\\n user_token: \'uk_secret\',\\n })\\n);\\n\\nconst { result } = await response.json();\\n"},{"lang":"Python","label":"Python","source":"import requests\\n\\nresponse = requests.get(\\n \\"https://api.ideal-postcodes.co.uk/v1/keys/ak_test/details\\",\\n params={\\n \\"user_token\\"
1: \\"uk_secret\\",\\n },\\n)\\nresult = response.json()[\\"result\\"]\\n"},{"lang":"Ruby","label":"Ruby","source":"require \\"net/http\\"\\nrequire \\"json\\"\\n\\nuri = URI(\\"https://api.ideal-postcodes.co.uk/v1/keys/ak_test/details\\")\\nuri.query = URI.encode_www_form(user_token: \\"uk_secret\\")\\nresult = JSON.parse(Net::HTTP.get(uri))[\\"result\\"]\\n"},{"lang":"PHP","label":"PHP","source":"<?php\\n$response = file_get_contents(\\n \\"https://api.ideal-postcodes.co.uk/v1/keys/ak_test/details?\\" .\\n http_build_query([\\n \\"user_token\\" => \\"uk_secret\\",\\n ])\\n);\\n$result = json_decode($response, true)[\\"result\\"];\\n"}]},"put":{"tags":["Keys"],"summary":"Update Details","description":"Updates a key\'s settings and returns its private details. Only the fields you send change. A key on an unlimited plan ignores changes to `datasets`, `daily_limit` and `monthly_limit`.","operationId":"UpdateKeyDetails","parameters":[{"$ref":"#/components/parameters/ApiKeyPathParam"},{"$ref":"#/components/parameters/UserTokenParam"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyDetailsEditable"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyDetailsResponse"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-codeSamples":[{"lang":"cURL","label":"curl","source":"curl -X PUT \'https://api.ideal-postcodes.co.uk/v1/keys/ak_test/details?user_token=uk_secret\' \\\\\\n -H \'Content-Type: application/json\' \\\\\\n -d \'{\\n \\"name\\": \\"My Updated Key\\",\\n \\"daily_limit\\": 1000,\\n \\"notifications\\": {\\n \\"enabled\\": true\\n }\\n }\'\\n"},{"lang":"JavaScript","label":"JavaScript","source":"const response = await fetch(\'https://api.ideal-postcodes.co.uk/v1/keys/ak_test/details?user_token=uk_secret\', {\\n method: \'PUT\',\\n headers: { \'Content-Type\': \'application/json\' },\\n body: JSON.stringify({\\n name: \'My Updated Key\',\\n daily_limit: 1000,\\n notifications: {\\n enabled: true,\\n },\\n }),\\n});\\n\\nconst { result } = await response.json();\\n"},{"lang":"Python","label":"Python","source":"import requests\\n\\nresponse = requests.put(\\n \\"https://api.ideal-postcodes.co.uk/v1/keys/ak_test/details\\",\\n params={\\"user_token\\": \\"uk_secret\\"},\\n json={\\n \\"name\\": \\"My Updated Key\\",\\n \\"daily_limit\\": 1000,\\n \\"notifications\\": {\\n \\"enabled\\": True,\\n },\\n },\\n)\\nresult = response.json()[\\"result\\"]\\n"},{"lang":"Ruby","label":"Ruby","source":"require \\"net/http\\"\\nrequire \\"json\\"\\n\\nuri = URI(\\"https://api.ideal-postcodes.co.uk/v1/keys/ak_test/details?user_token=uk_secret\\")\\nbody = {\\n name: \\"My Updated Key\\",\\n daily_limit: 1000,\\n notifications: {\\n enabled: true,\\n },\\n}\\nresponse = Net::HTTP.put(uri, body.to_json, \\"Content-Type\\" => \\"application/json\\")\\nresult = JSON.parse(response.body)[\\"result\\"]\\n"},{"lang":"PHP","label":"PHP","source":"<?php\\n$ch = curl_init(\\"https://api.ideal-postcodes.co.uk/v1/keys/ak_test/details?user_token=uk_secret\\");\\ncurl_setopt_array($ch, [\\n CURLOPT_CUSTOMREQUEST => \\"PUT\\",\\n CURLOPT_HTTPHEADER => [\\"Content-Type: application/json\\"],\\n CURLOPT_POSTFIELDS => json_encode([\\n \\"name\\" => \\"My Updated Key\\",\\n \\"daily_limit\\" => 1000,\\n \\"notifications\\" => [\\n \\"enabled\\" => true,\\n ],\\n ]),\\n CURLOPT_RETURNTRANSFER => true,\\n]);\\n$result = json_decode(curl_exec($ch), true)[\\"result\\"];\\n"}]}},"/keys/{key}/usage":{"get":{"tags":["Keys"],"summary":"Usage Stats","operationId":"KeyUsage","description":"Reports the number of lookups a key consumed over a date range, as a total and a daily breakdown.\\n\\nThe range defaults to the last 21 days. `start` and `end` take UNIX timestamps in milliseconds, and `end` defaults to the current time. The maximum range is 90 days.\\n\\nQuery at most three tags at once.\\n","parameters":[{"$ref":"#/components/parameters/ApiKeyPathParam"},{"$ref":"#/components/parameters/UserTokenParam"},{"$ref":"#/components/parameters/StartParam"},{"$ref":"#/components/parameters/EndParam"},{"$ref":"#/components/parameters/TagsParam"},{"$ref":"#/components/parameters/LicenseeParam"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyUsageResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-codeSamples":[{"lang":"http","label":"URL","source":"https://api.ideal-postcodes.co.uk/v1/keys/ak_test/usage?user_token=uk_secret\\n"},{"lang":"cURL","label":"curl","source":"curl -G \'https://api.ideal-postcodes.co.uk/v1/keys/ak_test/usage\' \\\\\\n -d \'user_token=uk_secret\'\\n"},{"lang":"JavaScript","label":"JavaScript","source":"const response = await fetch(\\n \'https://api.ideal-postcodes.co.uk/v1/keys/ak_test/usage?\' +\\n new URLSearchParams({\\n user_token: \'uk_secret\',\\n })\\n);\\n\\nconst { result } = await response.json();\\n"},{"lang":"Python","label":"Python","source":"import requests\\n\\nresponse = requests.get(\\n \\"https://api.ideal-postcodes.co.uk/v1/keys/ak_test/usage\\",\\n params={\\n \\"user_token\\"
1: \\"uk_secret\\",\\n },\\n)\\nresult = response.json()[\\"result\\"]\\n"},{"lang":"Ruby","label":"Ruby","source":"require \\"net/http\\"\\nrequire \\"json\\"\\n\\nuri = URI(\\"https://api.ideal-postcodes.co.uk/v1/keys/ak_test/usage\\")\\nuri.query = URI.encode_www_form(user_token: \\"uk_secret\\")\\nresult = JSON.parse(Net::HTTP.get(uri))[\\"result\\"]\\n"},{"lang":"PHP","label":"PHP","source":"<?php\\n$response = file_get_contents(\\n \\"https://api.ideal-postcodes.co.uk/v1/keys/ak_test/usage?\\" .\\n http_build_query([\\n \\"user_token\\" => \\"uk_secret\\",\\n ])\\n);\\n$result = json_decode($response, true)[\\"result\\"];\\n"}]}},"/keys/{key}/lookups":{"get":{"tags":["Keys"],"summary":"Logs (CSV)","operationId":"KeyLogs","description":"Returns a CSV of the paid lookups made on a key, with the information recorded against each one.\\n\\nThis method requires a `user_token`, which can be found on your [accounts page](https://account.ideal-postcodes.co.uk/account).\\n\\nYou can request a maximum interval of 90 days. Without a start or end date, the interval defaults to the last 21 days.\\n\\nThe `Content-Type` returned is CSV (text/csv). For a non-200 response it reverts to JSON, with the error code and message in the body.\\n\\n## CSV Format\\n\\nThe CSV has no header row. Columns, in order:\\n\\n1. Timestamp (ISO 8601)\\n2. IP address the request was received from\\n3. Search term\\n4. URL the request originated from\\n5. Lookup type\\n6. Tags\\n7. Lookups consumed\\n8. Licensee name (sublicensing keys only)\\n9. Source IP address\\n\\nThe source IP column carries the address forwarded in the `IDPC-Source-IP` header. It is only recorded for keys with IP address forwarding enabled, and only when the header holds a valid IP address. It is empty otherwise.\\n\\n## Data Redaction\\n\\nWe redact Personally Identifiable Data (PII) in your usage log (including IP, source IP, search term and URL data) weekly.\\n\\nBy default we redact PII older than 28 days. You can change this period from your dashboard.\\n\\nSet the interval to `0` days to prevent PII collection altogether.\\n","parameters":[{"$ref":"#/components/parameters/ApiKeyPathParam"},{"$ref":"#/components/parameters/UserTokenParam"},{"$ref":"#/components/parameters/StartParam"},{"$ref":"#/components/parameters/EndParam"},{"$ref":"#/components/parameters/LicenseeParam"}],"responses":{"200":{"description":"Success","content":{"text/csv":{"example":"2015-02-21T16:05:22.991Z,82.85.128.18,
1SW12AA,https://www.example.com/,Postcode Lookup,,1,,\\n2015-02-21T16:05:38.298Z,82.85.128.18,10 Downing Street London,https://www.example.com/,Address Lookup,CRM,1,,\\n2015-02-21T16:06:49.227Z,82.85.128.18,OX44PP,https://www.example.com/,Postcode Lookup,\\"Website,Live\\",1,,203.0.113.44\\n2015-02-21T16:07:02.706Z,82.85.128.18,PL9 9HE,https://www.example.com/,Postcode Lookup,,2,Acme Ltd,203.0.113.44\\n","schema":{"type":"string","description":"Success"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-codeSamples":[{"lang":"http","label":"URL","source":"https://api.ideal-postcodes.co.uk/v1/keys/ak_test/lookups?user_token=uk_secret\\n"},{"lang":"cURL","label":"curl","source":"curl -G \'https://api.ideal-postcodes.co.uk/v1/keys/ak_test/lookups\' \\\\\\n -d \'user_token=uk_secret\'\\n"},{"lang":"JavaScript","label":"JavaScript","source":"const response = await fetch(\\n \'https://api.ideal-postcodes.co.uk/v1/keys/ak_test/lookups?\' +\\n new URLSearchParams({\\n user_token: \'uk_secret\',\\n })\\n);\\n\\nconst { result } = await response.json();\\n"},{"lang":"Python","label":"Python","source":"import requests\\n\\nresponse = requests.get(\\n \\"https://api.ideal-postcodes.co.uk/v1/keys/ak_test/lookups\\",\\n params={\\n \\"user_token\\": \\"uk_secret\\",\\n },\\n)\\nresult = response.json()[\\"result\\"]\\n"},{"lang":"Ruby","label":"Ruby","source":"require \\"net/http\\"\\nrequire \\"json\\"\\n\\nuri = URI(\\"https://api.ideal-postcodes.co.uk/v1/keys/ak_test/lookups\\")\\nuri.query = URI.encode_www_form(user_token: \\"uk_secret\\")\\nresult = JSON.parse(Net::HTTP.get(uri))[\\"result\\"]\\n"},{"lang":"PHP","label":"PHP","source":"<?php\\n$response = file_get_contents(\\n \\"https://api.ideal-postcodes.co.uk/v1/keys/ak_test/lookups?\\" .\\n http_build_query([\\n \\"user_token\\" => \\"uk_secret\\",\\n ])\\n);\\n$result = json_decode($response, true)[\\"result\\"];\\n"}]}},"/cleanse/addresses":{"post":{"tags":["UK"],"summary":"Cleanse Address","description":"Returns the closest matching address for a freeform address input, with Match Level indicators describing how closely each element of the suggested address matches the input. The more impaired the input address, the harder it is to cleanse.\\n\\nA cleanse that returns a match costs a lookup. A no-match response is free.\\n\\n## Confidence Score\\n\\nEach incorrect, missing or misspelled element subtracts from the overall confidence score.\\n\\n### Deciding on an Acceptable Confidence Score Threshold\\n\\nInputs differ widely between address cleanse projects. Within a project, though, they tend to repeat the same errors. Some datasets are keyed in by hand and prone to typos. Others have a persistently missing datapoint such as organisation name or postcode. There is no absolute Confidence Score threshold. Set the acceptable score project by project, based on the systematic errors in the data and your business goals.\\n\\nTo set a threshold, load a subset of the dataset into a spreadsheet application like Excel and sort on the score. Scrolling from top to bottom shows matches from best to worst. As you reach the lower quality searches you can judge roughly:\\n\\n- Which confidence scores indicate ambiguous matches (i.e. up to building level only)\\n- Which confidence scores indicate a poor or no match (i.e. the nearest matching address is too far from the input address)\\n\\nDepending on your business goals, you can also use the Match Levels to determine an acceptable match. You may need to match only up to the thoroughfare or building name, or accurate organisation names may matter.\\n","operationId":"AddressCleanse","parameters":[{"$ref":"#/components/parameters/ApiKeyParam"},{"$ref":"#/components/parameters/TagsParam"},{"name":"context","in":"query","schema":{"type":"string"},"description":"Identify the country of the address to cleanse. Defaults to UK (GBR)\\n","example":"gbr"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["query"],"properties":{"query":{"type":"string","description":"Freeform address input to cleanse\\n","example":"10 Downing Street, London, SW2A 2BN"},"postcode":{"type":"string","description":"Optionally specify the postal code for the address.\\n","example":"SW1A 2BN"},"post_town":{"type":"string","description":"Optionally specify the city or town of the address.\\n\\nThis should be the \\"post town\\" of the address.\\n","example":"London"},"county":{"type":"string","description":"Optionally specify the county of the address.\\n\\nWe recommend omitting this field as county data is unreliable.\\n","example":"Kent"}}
1}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CleanseResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-codeSamples":[{"lang":"cURL","label":"curl","source":"curl -X POST \'https://api.ideal-postcodes.co.uk/v1/cleanse/addresses\' \\\\\\n -H \'Authorization: api_key=\\"ak_test\\"\' \\\\\\n -H \'Content-Type: application/json\' \\\\\\n -d \'{\\n \\"query\\": \\"10 downing street sw1a\\"\\n }\'\\n"},{"lang":"JavaScript","label":"JavaScript","source":"const response = await fetch(\'https://api.ideal-postcodes.co.uk/v1/cleanse/addresses\', {\\n method: \'POST\',\\n headers: {\\n \'Authorization\': \'api_key=\\"ak_test\\"\',\\n \'Content-Type\': \'application/json\',\\n },\\n body: JSON.stringify({\\n query: \'10 downing street sw1a\',\\n }),\\n});\\n\\nconst { result } = await response.json();\\n"},{"lang":"Python","label":"Python","source":"import requests\\n\\nresponse = requests.post(\\n \\"https://api.ideal-postcodes.co.uk/v1/cleanse/addresses\\",\\n headers={\\"Authorization\\": \'api_key=\\"ak_test\\"\'},\\n json={\\n \\"query\\": \\"10 downing street sw1a\\",\\n },\\n)\\nresult = response.json()[\\"result\\"]\\n"},{"lang":"Ruby","label":"Ruby","source":"require \\"net/http\\"\\nrequire \\"json\\"\\n\\nuri = URI(\\"https://api.ideal-postcodes.co.uk/v1/cleanse/addresses\\")\\nbody = {\\n query: \\"10 downing street sw1a\\",\\n}\\nresponse = Net::HTTP.post(uri, body.to_json, \\"Authorization\\" => \'api_key=\\"ak_test\\"\', \\"Content-Type\\" => \\"application/json\\")\\nresult = JSON.parse(response.body)[\\"result\\"]\\n"},{"lang":"PHP","label":"PHP","source":"<?php\\n$ch = curl_init(\\"https://api.ideal-postcodes.co.uk/v1/cleanse/addresses\\");\\ncurl_setopt_array($ch, [\\n CURLOPT_POST => true,\\n CURLOPT_HTTPHEADER => [\'Authorization: api_key=\\"ak_test\\"\', \\"Content-Type: application/json\\"],\\n CURLOPT_POSTFIELDS => json_encode([\\n \\"query\\" => \\"10 downing street sw1a\\",\\n ]),\\n CURLOPT_RETURNTRANSFER => true,\\n]);\\n$result = json_decode(curl_exec($ch), true)[\\"result\\"];\\n"}]}},"/autocomplete/addresses":{"get":{"tags":["Address Search"],"summary":"Find Address","description":"Returns address suggestions for a partial address, ordered by relevance. Use it to power real-time address autofill.\\n\\nConsider our address autocomplete JavaScript libraries, which add address lookup to a form without calling this API directly.\\n\\n## API Usage\\n\\nImplementing our Address Autocomplete API involves:\\n\\n1. Fetch address suggestions with `/autocomplete/addresses`\\n2. Acquire the complete address using the ID from the suggestion\\n\\nStep 2 decrements your lookup balance.\\n\\nStep 1 is not a free standalone resource. We rate limit and then suspend integrations that repeatedly make autocomplete requests without a paid Step 2 request.\\n\\n## Context\\n\\n`context` limits the search, usually to a single country. It defaults to `GBR`, and an unrecognised context falls back to that default. If your key is not licensed for the datasets covering the context, the request is rejected.\\n\\nQuerying a full postcode within a supported context returns the entire address list for that postcode.\\n\\n## Query Filters\\n\\nRefine results by appending filters to your querystring, e.g. `postcode=sw1a2aa` for postcode `SW1A 2AA`. Invalid filters return an empty set without affecting your lookup count.\\n\\nTo apply multiple filter terms, use a comma-separated list, e.g. `postcode_outward=e1,e2,e3` combines result sets for E1, E2 and E3. Unless otherwise specified, all filters support multiple terms.\\n\\nFilters combine with `AND` logic, for instance `su_organisation_indicator=Y&postcode_area=n`. The maximum is **8** filter terms.\\n\\n## Address Bias\\n\\nPreface bias searches with `bias_` to boost certain address results. Unlike filters, biasing allows unmatched addresses to appear with lower priority.\\n\\nFor example, use `bias_postcode_area=SW,SE` to favour addresses in the `SW` and `SE` postcode areas. Invalid bias terms have no effect.\\n\\nMultiple bi
1as terms are allowed unless stated otherwise, with a combined maximum of **5**.\\n\\n## Suggestion Format\\n\\nThe suggestion format is subject to change. We recommend using the suggestion as-is to avoid integration issues.\\n\\n## Rate Limiting and Cost\\n\\nThe default rate limit is 3,000 requests per 5 minutes, counted per key and IP address. The `X-RateLimit-Limit`, `X-RateLimit-Remaining` and `X-RateLimit-Reset` headers report where you stand.\\n\\nAutocomplete API usage does not impact your balance, but resolving a suggestion to a full address requires a paid request. Autocomplete requests without subsequent paid requests may lead to rate limiting or suspension.\\n","operationId":"FindAddress","parameters":[{"$ref":"#/components/parameters/ApiKeyParam"},{"name":"query","description":"**Address Query**\\n\\nThe partial address string entered by the user to autocomplete.\\n","example":"10 downing street lo","explode":false,"in":"query","schema":{"type":"string","maxLength":150},"style":"form"},{"$ref":"#/components/parameters/DatasetParam"},{"$ref":"#/components/parameters/ContextParam"},{"$ref":"#/components/parameters/LimitParam"},{"$ref":"#/components/parameters/BiasLonLatParam"},{"$ref":"#/components/parameters/BiasIpParam"},{"$ref":"#/components/parameters/BoxParam"},{"$ref":"#/components/parameters/PostcodeOutwardParam"},{"$ref":"#/components/parameters/PostcodeParam"},{"$ref":"#/components/parameters/PostcodeAreaParam"},{"$ref":"#/components/parameters/PostcodeSectorParam"},{"$ref":"#/components/parameters/PostTownParam"},{"$ref":"#/components/parameters/UPRNParam"},{"$ref":"#/components/parameters/CountryParam"},{"$ref":"#/components/parameters/PostcodeTypeParam"},{"$ref":"#/components/parameters/SmallUserParam"},{"$ref":"#/components/parameters/BiasPostcodeOutwardParam"},{"$ref":"#/components/parameters/BiasPostcodeParam"},{"$ref":"#/components/parameters/BiasPostcodeAreaParam"},{"$ref":"#/components/parameters/BiasPostcodeSectorParam"},{"$ref":"#/components/parameters/BiasPosttownParam"},{"$ref":"#/components/parameters/BiasThoroughfareParam"},{"$ref":"#/components/parameters/BiasCountryParam"},{"$ref":"#/components/parameters/PostalCodeParam"},{"$ref":"#/components/parameters/PostalCode2Param"},{"$ref":"#/components/parameters/PostalCode3Param"},{"$ref":"#/components/parameters/CityParam"},{"$ref":"#/components/parameters/StateParam"},{"$ref":"#/components/parameters/StateCodeParam"},{"$ref":"#/components/parameters/BiasPostalCodeParam"},{"$ref":"#/components/parameters/BiasPostalCode2Param"},{"$ref":"#/components/parameters/BiasPostalCode3Param"},{"$ref":"#/components/parameters/BiasCityParam"},{"$ref":"#/components/parameters/BiasStateParam"},{"$ref":"#/components/parameters/BiasStateCodeParam"},{"$ref":"#/components/parameters/IsPoboxParam"},{"$ref":"#/components/parameters/IsBusinessParam"}],"responses":{"200":{"description":"Success","headers":{"X-RateLimit-Limit":{"description":"The maximum number of requests that can be made in 5 minutes","schema":{"type":"number","format":"int32"}},"X-RateLimit-Remaining":{"description":"The remaining requests within the current rate limit window","schema":{"type":"number","format":"int32"}},"X-RateLimit-Reset":{"description":"The time when the rate limit window resets in Unix Time (seconds) or UTC Epoch seconds.\\n","schema":{"type":"number","format":"int32"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AutocompleteResponse"},"examples":{"GBR":{"summary":"Example response for GBR context","value":{"result":{"hits":[{"id":"paf_23747771","suggestion":"Prime Minister & First Lord Of The Treasury, 10 Downing Street, London, SW1A","udprn":23747771,"urls":{"udprn":"/v1/udprn/23747771"}},{"id":"paf_26245117","suggestion":"Flat 10, Downing Court, Grenville Street, London, WC1N","udprn":26245117,"urls":{"udprn":"/v1/udprn/26245117"}}]},"code":2000,"message":"Success"}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-codeSamples":[{"lang":"http","label":"URL","source":"https://api.ideal-postcodes.co.uk/v1/autocomplete/addresses?api_key=ak_test&query=10 downing\\n"},{"lang":"cURL","label":"curl","source":"curl -G \'https://api.ideal-postcodes.co.uk/v1/autocomplete/addresses\' \\\\\\n -d \'api_key=ak_test\' \\\\\\n --data-urlencode \'query=10 downing\'\\n"},{"lang":"JavaScript","label":"JavaScript","source":"const response = await fetch(\\n \'https://api.ideal-postcodes.co.uk/v1/autocomplete/addresses?\' +\\n new URLSearchParams({\\n api_key: \'ak_test\',\\n query: \'10 downing\',\\n })\\n);\\n\\nconst { result } = await response.json();\\n"},{"lang":"Python","label":"Python","source":"import requests\\n\\nresponse = requests.get(\\n \\"https://api.ideal-postcodes.co.uk/v1/autocomplete/addresses\\",\\n params={\\n \\"api_key\\": \\"ak_test\\",\\n \\"query\\": \\"10 downing\\",\\n }
1,\\n)\\nresult = response.json()[\\"result\\"]\\n"},{"lang":"Ruby","label":"Ruby","source":"require \\"net/http\\"\\nrequire \\"json\\"\\n\\nuri = URI(\\"https://api.ideal-postcodes.co.uk/v1/autocomplete/addresses\\")\\nuri.query = URI.encode_www_form(api_key: \\"ak_test\\", query: \\"10 downing\\")\\nresult = JSON.parse(Net::HTTP.get(uri))[\\"result\\"]\\n"},{"lang":"PHP","label":"PHP","source":"<?php\\n$response = file_get_contents(\\n \\"https://api.ideal-postcodes.co.uk/v1/autocomplete/addresses?\\" .\\n http_build_query([\\n \\"api_key\\" => \\"ak_test\\",\\n \\"query\\" => \\"10 downing\\",\\n ])\\n);\\n$result = json_decode($response, true)[\\"result\\"];\\n"}]}},"/autocomplete/addresses/{address}/gbr":{"get":{"tags":["Address Search"],"summary":"Resolve Address","operationId":"ResolveAddress","description":"Returns the complete address for an autocomplete suggestion, identified by its address ID.\\n\\nThis is the step of the autocomplete flow that costs a lookup. Fetching suggestions is free.\\n\\nThe API returns resolved addresses, including addresses outside the UK, in a UK format (up to 3 address lines) using UK nomenclature such as postcode and county.\\n\\nAn ID that matches no address returns `404`.\\n","parameters":[{"name":"address","in":"path","description":"**ID of address suggestion**\\n\\nID of address suggestion provided by the API to fully resolve.\\n","required":true,"style":"simple","explode":false,"example":"paf_23747771","schema":{"type":"string"}},{"$ref":"#/components/parameters/ApiKeyParam"},{"$ref":"#/components/parameters/TagsParam"}],"responses":{"200":{"description":"Success","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GbrResolveAddressResponse"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-codeSamples":[{"lang":"http","label":"URL","source":"https://api.ideal-postcodes.co.uk/v1/autocomplete/addresses/paf_23747771/gbr?api_key=ak_test\\n"},{"lang":"cURL","label":"curl","source":"curl -G \'https://api.ideal-postcodes.co.uk/v1/autocomplete/addresses/paf_23747771/gbr\' \\\\\\n -d \'api_key=ak_test\'\\n"},{"lang":"JavaScript","label":"JavaScript","source":"const response = await fetch(\\n \'https://api.ideal-postcodes.co.uk/v1/autocomplete/addresses/paf_23747771/gbr?\' +\\n new URLSearchParams({\\n api_key: \'ak_test\',\\n })\\n);\\n\\nconst { result } = await response.json();\\n"},{"lang":"Python","label":"Python","source":"import requests\\n\\nresponse = requests.get(\\n \\"https://api.ideal-postcodes.co.uk/v1/autocomplete/addresses/paf_23747771/gbr\\",\\n params={\\n \\"api_key\\": \\"ak_test\\",\\n },\\n)\\nresult = response.json()[\\"result\\"]\\n"},{"lang":"Ruby","label":"Ruby","source":"require \\"net/http\\"\\nrequire \\"json\\"\\n\\nuri = URI(\\"https://api.ideal-postcodes.co.uk/v1/autocomplete/addresses/paf_23747771/gbr\\")\\nuri.query = URI.encode_www_form(api_key: \\"ak_test\\")\\nresult = JSON.parse(Net::HTTP.get(uri))[\\"result\\"]\\n"},{"lang":"PHP","label":"PHP","source":"<?php\\n$response = file_get_contents(\\n \\"https://api.ideal-postcodes.co.uk/v1/autocomplete/addresses/paf_23747771/gbr?\\" .\\n http_build_query([\\n \\"api_key\\" => \\"ak_test\\",\\n ])\\n);\\n$result = json_decode($response, true)[\\"result\\"];\\n"}]}},"/addresses":{"get":{"tags":["UK"],"summary":"Extract Addresses","description":"Returns a list of UK addresses matching the query, ordered by relevance score. `limit` defaults to 10 and caps at 100. `page` defaults to 0.\\n\\nYou may only extract a single address from each request. To extract multiple addresses, you must perform an individual request for each address.\\n\\nIf the query is a valid postcode, the API returns the whole address list for that postcode and raises the limit to 100. Use `page` to reach the rest of a postcode holding more than 100 premises. You cannot page beyond 10,000 results.\\n\\nYour key needs at least one of PAF, Multiple Residence, Not Yet Built, PAF Alias, PAF Welsh, AddressBase or AddressBase Premium. Without one the request is rejected.\\n\\nA request that returns at least one address costs a lookup. Empty result sets are free.\\n\\n## Reverse Geocoding\\n\\nReturn the addresses around a point with the `lon=` and `lat=` querystring arguments. The search radius is 100m and the API sorts addresses by distance from the point.\\n\\n## Filters\\n\\nNarrow your results by adding filters to your query string that correspond with an address attribute.\\n\\nFor instance, you can restrict to postcode `SW1A 2AA` by appending `postcode=sw1a2aa`.\\n\\nIf a filter term is invali
1d, e.g. `postcode=SW1A2AAA`, the API returns an empty result set and charges no lookup.\\n\\nYou can also scope using multiple terms for the same filter with a comma separated list of terms. E.g. Restrict results to E1, E2 and E3 outward codes: `postcode_outward=e1,e2,e3`. Multiple terms are `OR`\'ed, i.e. the matching result sets are combined.\\n\\nAll filters can accept multiple terms unless stated otherwise below.\\n\\nMultiple filters can also be combined. E.g. Restrict results to small user organisations in the N postcode area: `su_organisation_indicator=Y&postcode_area=n`. Multiple filters are `AND`\'ed, i.e. each additional filter narrows the result set.\\n\\nA combined maximum of 8 terms is allowed across all filters.\\n\\n## Biases\\n\\nYou can boost address results that correspond with a given address attribute. All bias searches are prefixed with `bias_`.\\n\\nBiased searches, unlike filtered searches, still allow unmatched addresses to appear. They rank lower.\\n\\nFor instance, you can boost addresses with postcode areas `SW` and `SE` by appending `bias_postcode_area=SW,SE`.\\n\\nIf a bias term is invalid, e.g. `bias_postcode=SW1A2AAA`, no bias is applied.\\n\\nYou may scope using multiple terms for the same bias with a comma separated list of terms. E.g. Prefer results in the `E1`, `E2` and `E3` outward codes: `bias_postcode_outward=e1,e2,e3`.\\n\\nAll biases can accept multiple terms unless stated otherwise below.\\n\\nA combined maximum of 5 terms is allowed across all biases.\\n\\n## Search by Postcode and Building Name or Number\\n\\nSearch by postcode and building attribute with the postcode filter and query argument. E.g. For \\"SW1A 2AA Prime Minister\\" `/v1/addresses?postcode=sw1a2aa&q=prime minister`.\\n\\nUsing a filter means a postcode mismatch returns no results and costs no lookup.\\n\\n### Search by UPRN\\n\\nSearch by UPRN using the `uprn` filter and excluding the query argument. E.g. `/v1/addresses?uprn=100`.\\n\\n## Testing\\n\\n- **ID1 1QD** Returns a successful query response `2000`\\n- **ID1 KFA** Returns an empty query response `2000`\\n- **ID1 CLIP** Returns \\"no lookups remaining\\" error `4020`\\n- **ID1 CHOP** Returns \\"daily (or individual) lookup limit breached\\" error `4021`\\n\\nTest requests undergo the usual authentication and restriction rules. They surface any issues during implementation and do not cost you a lookup.\\n","operationId":"Addresses","parameters":[{"$ref":"#/components/parameters/ApiKeyParam"},{"name":"query","in":"query","description":"Specifies the address to query.","style":"form","explode":false,"schema":{"type":"string"}},{"$ref":"#/components/parameters/LimitParam"},{"$ref":"#/components/parameters/PageParam"},{"$ref":"#/components/parameters/FilterParam"},{"$ref":"#/components/parameters/AddressLongitudeParam"},{"$ref":"#/components/parameters/AddressLatitudeParam"},{"$ref":"#/components/parameters/PostcodeOutwardParam"},{"$ref":"#/components/parameters/PostcodeParam"},{"$ref":"#/components/parameters/PostcodeAreaParam"},{"$ref":"#/components/parameters/PostcodeSectorParam"},{"$ref":"#/components/parameters/PostTownParam"},{"$ref":"#/components/parameters/UPRNParam"},{"$ref":"#/components/parameters/CountryParam"},{"$ref":"#/components/parameters/PostcodeTypeParam"},{"$ref":"#/components/parameters/SmallUserParam"},{"$ref":"#/components/parameters/BoxParam"},{"$ref":"#/components/parameters/BiasPostcodeOutwardParam"},{"$ref":"#/components/parameters/BiasPostcodeParam"},{"$ref":"#/components/parameters/BiasPostcodeAreaParam"},{"$ref":"#/components/parameters/BiasPostcodeSectorParam"},{"$ref":"#/components/parameters/BiasPosttownParam"},{"$ref":"#/components/parameters/BiasThoroughfareParam"},{"$ref":"#/components/parameters/BiasCountryParam"},{"$ref":"#/components/parameters/BiasLonLatParam"},{"$ref":"#/components/parameters/TagsParam"},{"$ref":"#/components/parameters/DatasetParam"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddressResponse"}}}},"404":{"description":"Postcode Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostcodeNotFoundResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-codeSamples":[{"lang":"http","label":"URL","source":"https://api.ideal-postcodes.co.uk/v1/addresses?api_key=ak_test&query=10 downing street london\\n"},{"lang":"cURL","label":"curl","source":"curl -G \'https://api.ideal-postcodes.co.uk/v1/addresses\' \\\\\\n -d \'api_key=ak_test\' \\\\\\n --data-urlencode \'query=10 downing street london\'\\n"},{"lang":"JavaScript","label":"JavaScript","source":"const response = await fetch(\\n \'https://api.ideal-postcodes.co.uk/v1/addresses?\' +\\n new URLSearchParams({\\n api_key: \'ak_test\',\\n query: \'10 downing street london\',\\n })\\n);\\n\\nconst { result } = await response.json();\\n"},{"lang":"Python","label":"Python","source":"import requests\\n\\nresponse = requests.get(\\n \\"https://api.ideal-postcodes.co.uk/v1/addresses\\",\\n params={\\n \\"api_key\\": \\"ak_test\\",\\n \\"query\\": \\"10 downing street london\\",\\n }
1,\\n)\\nresult = response.json()[\\"result\\"]\\n"},{"lang":"Ruby","label":"Ruby","source":"require \\"net/http\\"\\nrequire \\"json\\"\\n\\nuri = URI(\\"https://api.ideal-postcodes.co.uk/v1/addresses\\")\\nuri.query = URI.encode_www_form(api_key: \\"ak_test\\", query: \\"10 downing street london\\")\\nresult = JSON.parse(Net::HTTP.get(uri))[\\"result\\"]\\n"},{"lang":"PHP","label":"PHP","source":"<?php\\n$response = file_get_contents(\\n \\"https://api.ideal-postcodes.co.uk/v1/addresses?\\" .\\n http_build_query([\\n \\"api_key\\" => \\"ak_test\\",\\n \\"query\\" => \\"10 downing street london\\",\\n ])\\n);\\n$result = json_decode($response, true)[\\"result\\"];\\n"}]}},"/places":{"get":{"tags":["Place Search"],"summary":"Find Place","description":"Returns place suggestions for a query, ranked by relevance. Places cover countries, administrative areas, capitals and other administrative seats.\\n\\n## Implementing Place Autocomplete\\n\\nRetrieving a full place takes two requests:\\n\\n1. Fetch suggestions from `/places`\\n2. Fetch the place using the `id` on a suggestion\\n\\nA query returns at most 10 suggestions. An empty query returns an empty result set. Show users the `descriptive_name`. The API drops suggestions that share one, so each name in a response identifies a single place.\\n\\n## Rate Limiting and Cost\\n\\nThe rate limit is 3,000 requests per 5 minutes.\\n\\n`/places` does not decrement your lookup balance, but resolving a suggestion to a full place does. We rate limit and then suspend integrations that repeatedly call `/places` without resolving.\\n","operationId":"FindPlace","parameters":[{"$ref":"#/components/parameters/ApiKeyParam"},{"name":"query","in":"query","description":"Specifies the place to query. Can be shortened to `q=`","style":"form","explode":false,"schema":{"type":"string"},"allowReserved":true},{"$ref":"#/components/parameters/CountryIsoParam"},{"$ref":"#/components/parameters/BiasCountryIsoParam"},{"$ref":"#/components/parameters/BiasLonLatParam"},{"$ref":"#/components/parameters/BiasIpParam"}],"responses":{"200":{"description":"Success","headers":{"X-RateLimit-Limit":{"description":"The maximum number of requests that can be made in 5 minutes","schema":{"type":"number","format":"int32"}},"X-RateLimit-Remaining":{"description":"The remaining requests within the current rate limit window","schema":{"type":"number","format":"int32"}},"X-RateLimit-Reset":{"description":"The time when the rate limit window resets in Unix Time (seconds) or UTC Epoch seconds.\\n","schema":{"type":"number","format":"int32"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlaceResponse"},"examples":{"Result":{"value":{"result":{"hits":[{"id":"geonames_2643743","name":"London","descriptive_name":"London, Greater London, England","country_iso":"GBR"},{"id":"geonames_4517009","name":"London","descriptive_name":"London, Madison County, Ohio","country_iso":"USA"},{"id":"geonames_4298960","name":"London","descriptive_name":"London, Laurel County, Kentucky","country_iso":"USA"}]},"code":2000,"message":"Success"}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-codeSamples":[{"lang":"http","label":"URL","source":"https://api.ideal-postcodes.co.uk/v1/places?api_key=ak_test&query=london\\n"},{"lang":"cURL","label":"curl","source":"curl -G \'https://api.ideal-postcodes.co.uk/v1/places\' \\\\\\n -d \'api_key=ak_test\' \\\\\\n -d \'query=london\'\\n"},{"lang":"JavaScript","label":"JavaScript","source":"const response = await fetch(\\n \'https://api.ideal-postcodes.co.uk/v1/places?\' +\\n new URLSearchParams({\\n api_key: \'ak_test\',\\n query: \'london\',\\n })\\n);\\n\\nconst { result } = await response.json();\\n"},{"lang":"Python","label":"Python","source":"import requests\\n\\nresponse = requests.get(\\n \\"https://api.ideal-postcodes.co.uk/v1/places\\",\\n params={\\n \\"api_key\\": \\"ak_test\\",\\n \\"query\\": \\"london\\",\\n },\\n)\\nresult = response.json()[\\"result\\"]\\n"},{"lang":"Ruby","label":"Ruby","source":"require \\"net/http\\"\\nrequire \\"json\\"\\n\\nuri = URI(\\"https://api.ideal-postcodes.co.uk/v1/places\\")\\nuri.query = URI.encode_www_form(api_key: \\"ak_test\\", query: \\"london\\")\\nresult = JSON.parse(Net::HTTP.get(uri))[\\"result\\"]\\n"},{"lang":"PHP","label":"PHP","source":"<?php\\n$response = file_get_contents(\\n \\"https://api.ideal-postcodes.co.uk/v1/places?\\" .\\n http_build_query([\\n \\"api_key\\" => \\"ak_test\\",\\n \\"query\\" => \\"london\\",\\n ])\\n);\\n$result = json_decode($response, true)[\\"result\\"];\\n"}]}},"/places/{place}":{"get":{"tags":["Place Search"],"summary":"Resolve Place","operationId":"ResolvePlace","description":"Returns the full place for a place ID taken from a `/places` suggestion.\\n\\nOn top of the fields carried by the suggestion, the response adds coordinates, language and the underlying dataset record.\\n\\nEach request decrements your lookup balance. An unknown ID returns `404`.\\n","parameters":[{"name":"place","in":"path","description":"ID of place suggestion","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"$ref":"#/components/parameters/ApiKeyParam"},{"$ref":"#/components/parameters/TagsParam"}],"responses":{"200":{"description":"Success","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResolvePlaceResponse"},"examples":{"Valid Place":{"value":{"result":{"id":"geonames_2643743","dataset":"geonames","name":"London","descriptive_name":"London, Greater London, England","language":"en","longitude":-0.12574,"latitude":51.50853,"country_iso":"GBR","native":{"admin1_code":"ENG","admin2_name":"Greater London","geonameid":2643743,"timezone":"Europe/London","latitude":51.50853,"language":"en","dem":25,"admin4_code":"","admin1_geonameid":6269131,"alternatenames":["ILondon","
1LON","Lakana","Landan","Landen","Ljondan","Llundain","Lodoni","Londain","Londan","Londar","Londe","Londen","Londin","Londinium","Londino","Londn","London","London osh","Londona","Londonas","Londoni","Londono","Londons","Londonu","Londra","Londres","Londrez","Londri","Londro","Londye","Londyn","Lond\xfdn","Lonn","Lontoo","Loundres","Luan GJon","Lun-tun","Lunden","Lundra","Lundun","Lundunir","Lund\xfanir","Lung-dung","Lunnainn","Lunnin","Lunnon","Lu\xe2n \u0110\xf4n","L\xf9n-t\xfbn","L\xf9ng-d\u016dng","L\xfbn-tun","L\u0101kana","L\u016fnd\u016fn","L\u1ecdnd\u1ecdnu","Ranana","R\u0101nana","ilantan","ladana","landan","landana","leondeon","lndn","london","londoni","lun dui","lun dun","lwndwn","lxndxn","rondon","\u0141ondra","\u039b\u03bf\u03bd\u03b4\u03af\u03bd\u03bf","\u041b\u043e\u043d\u0434\u0430\u043d","\u041b\u043e\u043d\u0434\u043e\u043d","\u041b\u043e\u043d\u0434\u043e\u043d \u043e\u0448","\u041b\u043e\u043d\u0434\u043e\u043d\u044a","\u041b\u0451\u043d\u0434\u0430\u043d","\u053c\u0578\u0576\u0564\u0578\u0576","\u05dc\u05d0\u05e0\u05d3\u05d0\u05df","\u05dc\u05d5\u05e0\u05d3\u05d5\u05df","\u0644\u0623\u0646\u062f\u0623\u0646","\u0644\u0646\u062f\u0646","\u0644\u0648\u0646\u062f\u0648\u0646","\u0644\u06d5\u0646\u062f\u06d5\u0646","\u0720\u0718\u0722\u0715\u0718\u0722","\u0932\u0902\u0921\u0928","\u0932\u0902\u0926\u0928","\u0932\u0923\u094d\u0921\u0928","\u0932\u0928\u094d\u0921\u0928\u094d","\u0932\u0928\u094d\u0926\u0928","\u09b2\u09a8\u09cd\u09a1\u09a8","\u0a32\u0a70\u0a21\u0a28","\u0ab2\u0a82\u0aa1\u0aa8","\u0b32\u0b4d\u0b21\u0b28","\u0b87\u0bb2\u0ba3\u0bcd\u0b9f\u0ba9\u0bcd","\u0c32\u0c02\u0c21\u0c28\u0c4d","\u0cb2\u0c82\u0ca1\u0ca8\u0ccd","\u0d32\u0d23\u0d4d\u0d1f\u0d7b","\u0dbd\u0db1\u0dca\u0da9\u0db1\u0dca","\u0e25\u0e2d\u0e19\u0e14\u0e2d\u0e19","\u0ea5\u0ead\u0e99\u0e94\u0ead\u0e99","\u0f63\u0f7c\u0f53\u0f0b\u0f4a\u0f7c\u0f53\u0f0d","\u101c\u1014\u103a\u1012\u1014\u103a\u1019\u103c\u102d\u102f\u1037","\u10da\u10dd\u10dc\u10d3\u10dd\u10dc\u10d8","\u1208\u1295\u12f0\u1295","\u13ab\u13b4 \u13d7\u13cd\u13aa\u13c2\u13af\u13f1","\u30ed\u30f3\u30c9\u30f3","\u4f26\u6566","\u502b\u6566","\ub7f0\ub358"],"cc2":[],"admin2_code":"GLA","modification_date":"2022-03-09T00:00:00.000Z","asciiname":"London","id":"geonames_2643743","feature_code":"PPLC","country_iso":"GBR","longitude":-0.12574,"elevation":null,"admin2_geonameid":2648110,"admin1_name":"England","population":"8961989","country_code":"GB","feature_class":"P","name":"London","admin3_code":"","dataset":"geonames"}},"code":2000,"message":"Success"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-codeSamples":[{"lang":"http","label":"URL","source":"https://api.ideal-postcodes.co.uk/v1/places/geonames_5353?api_key=ak_test\\n"},{"lang":"cURL","label":"curl","source":"curl -G \'https://api.ideal-postcodes.co.uk/v1/places/geonames_5353\' \\\\\\n -d \'api_key=ak_test\'\\n"},{"lang":"JavaScript","label":"JavaScript","source":"const response = await fetch(\\n \'https://api.ideal-postcodes.co.uk/v1/places/geonames_5353?\' +\\n new URLSearchParams({\\n api_key: \'ak_test\',\\n })\\n);\\n\\nconst { result } = await response.json();\\n"},{"lang":"Python","label":"Python","source":"import requests\\n\\nresponse = requests.get(\\n \\"https://api.ideal-postcodes.co.uk/v1/places/geonames_5353\\",\\n params={\\n \\"api_key\\": \\"ak_test\\",\\n },\\n)\\nresult = response.json()[\\"result\\"]\\n"},{"lang":"Ruby","label":"Ruby","source":"require \\"net/http\\"\\nrequire \\"json\\"\\n\\nuri = URI(\\"https://api.ideal-postcodes.co.uk/v1/places/geonames_5353\\")\\nuri.query = URI.encode_www_form(api_key: \\"ak_test\\")\\nresult = JSON.parse(Net::HTTP.get(uri))[\\"result\\"]\\n"},{"lang":"PHP","label":"PHP","source":"<?php\\n$response = file_get_contents(\\n \\"https://api.ideal-postcodes.co.uk/v1/places/geonames_5353?\\" .\\n http_build_query([\\n \\"api_key\\" => \\"ak_test\\",\\n ])\\n);\\n$result = json_decode($response, true)[\\"result\\"];\\n"}]}},"/keys/{key}/licensees":{"get":{"tags":["Licensees"],"summary":"List","description":"Returns a key\'s licensees, oldest first, up to 100 per request. The list omits cancelled licensees. The key must be enabled for sub-licensing.","operationId":"ListLicensees","parameters":[{"$ref":"#/components/parameters/ApiKeyPathParam"},{"name":"starting_after","in":"query","description":"ID of the licensee after which to list results","style":"form","explode":false,"schema":{"type":"integer","format":"int32"}},{"$ref":"#/components/parameters/UserTokenParam"},{"$ref":"#/components/parameters/LimitParam"},{"name":"query","in":"query","description":"Filter results by licensee name. Can be shortened to `q=`","style":"form","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LicenseesResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-codeSamples":[{"lang":"http","label":"URL","source":"https://api.ideal-postcodes.co.uk/v1/keys/ak_test/lice
1nsees?user_token=uk_secret\\n"},{"lang":"cURL","label":"curl","source":"curl -G \'https://api.ideal-postcodes.co.uk/v1/keys/ak_test/licensees\' \\\\\\n -d \'user_token=uk_secret\'\\n"},{"lang":"JavaScript","label":"JavaScript","source":"const response = await fetch(\\n \'https://api.ideal-postcodes.co.uk/v1/keys/ak_test/licensees?\' +\\n new URLSearchParams({\\n user_token: \'uk_secret\',\\n })\\n);\\n\\nconst { result } = await response.json();\\n"},{"lang":"Python","label":"Python","source":"import requests\\n\\nresponse = requests.get(\\n \\"https://api.ideal-postcodes.co.uk/v1/keys/ak_test/licensees\\",\\n params={\\n \\"user_token\\": \\"uk_secret\\",\\n },\\n)\\nresult = response.json()[\\"result\\"]\\n"},{"lang":"Ruby","label":"Ruby","source":"require \\"net/http\\"\\nrequire \\"json\\"\\n\\nuri = URI(\\"https://api.ideal-postcodes.co.uk/v1/keys/ak_test/licensees\\")\\nuri.query = URI.encode_www_form(user_token: \\"uk_secret\\")\\nresult = JSON.parse(Net::HTTP.get(uri))[\\"result\\"]\\n"},{"lang":"PHP","label":"PHP","source":"<?php\\n$response = file_get_contents(\\n \\"https://api.ideal-postcodes.co.uk/v1/keys/ak_test/licensees?\\" .\\n http_build_query([\\n \\"user_token\\" => \\"uk_secret\\",\\n ])\\n);\\n$result = json_decode($response, true)[\\"result\\"];\\n"}]},"post":{"tags":["Licensees"],"summary":"Create","description":"Creates a licensee on a key and returns it with its generated `sl_` key. The key must be enabled for sub-licensing.","operationId":"CreateLicensee","parameters":[{"$ref":"#/components/parameters/ApiKeyPathParam"},{"$ref":"#/components/parameters/UserTokenParam"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LicenseeEditable"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LicenseeResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-codeSamples":[{"lang":"cURL","label":"curl","source":"curl -X POST \'https://api.ideal-postcodes.co.uk/v1/keys/ak_test/licensees?user_token=uk_secret\' \\\\\\n -H \'Content-Type: application/json\' \\\\\\n -d \'{\\n \\"name\\": \\"Qwerty Widgets Limited\\",\\n \\"address\\": \\"12 High Street, Manchester\\",\\n \\"postcode\\": \\"ID1 1QD\\",\\n \\"whitelist\\": [],\\n \\"daily\\": {\\n \\"limit\\": 10000\\n }\\n }\'\\n"},{"lang":"JavaScript","label":"JavaScript","source":"const response = await fetch(\'https://api.ideal-postcodes.co.uk/v1/keys/ak_test/licensees?user_token=uk_secret\', {\\n method: \'POST\',\\n headers: { \'Content-Type\': \'application/json\' },\\n body: JSON.stringify({\\n name: \'Qwerty Widgets Limited\',\\n address: \'12 High Street, Manchester\',\\n postcode: \'ID1 1QD\',\\n whitelist: [],\\n daily: {\\n limit: 10000,\\n },\\n }),\\n});\\n\\nconst { result } = await response.json();\\n"},{"lang":"Python","label":"Python","source":"import requests\\n\\nresponse = requests.post(\\n \\"https://api.ideal-postcodes.co.uk/v1/keys/ak_test/licensees\\",\\n params={\\"user_token\\": \\"uk_secret\\"},\\n json={\\n \\"name\\": \\"Qwerty Widgets Limited\\",\\n \\"address\\": \\"12 High Street, Manchester\\",\\n \\"postcode\\": \\"ID1 1QD\\",\\n \\"whitelist\\": [],\\n \\"daily\\": {\\n \\"limit\\": 10000,\\n },\\n },\\n)\\nresult = response.json()[\\"result\\"]\\n"},{"lang":"Ruby","label":"Ruby","source":"require \\"net/http\\"\\nrequire \\"json\\"\\n\\nuri = URI(\\"https://api.ideal-postcodes.co.uk/v1/keys/ak_test/licensees?user_token=uk_secret\\")\\nbody = {\\n name: \\"Qwerty Widgets Limited\\",\\n address: \\"12 High Street, Manchester\\",\\n postcode: \\"ID1 1QD\\",\\n whitelist: [],\\n daily: {\\n limit: 10000,\\n },\\n}\\nresponse = Net::HTTP.post(uri, body.to_json, \\"Content-Type\\" => \\"application/json\\")\\nresult = JSON.parse(response.body)[\\"result\\"]\\n"},{"lang":"PHP","label":"PHP","source":"<?php\\n$ch = curl_init(\\"https://api.ideal-postcodes.co.uk/v1/keys/ak_test/lice
1nsees?user_token=uk_secret\\");\\ncurl_setopt_array($ch, [\\n CURLOPT_POST => true,\\n CURLOPT_HTTPHEADER => [\\"Content-Type: application/json\\"],\\n CURLOPT_POSTFIELDS => json_encode([\\n \\"name\\" => \\"Qwerty Widgets Limited\\",\\n \\"address\\" => \\"12 High Street, Manchester\\",\\n \\"postcode\\" => \\"ID1 1QD\\",\\n \\"whitelist\\" => [],\\n \\"daily\\" => [\\n \\"limit\\" => 10000,\\n ],\\n ]),\\n CURLOPT_RETURNTRANSFER => true,\\n]);\\n$result = json_decode(curl_exec($ch), true)[\\"result\\"];\\n"}]}},"/keys/{key}/licensees/{licensee}":{"get":{"tags":["Licensees"],"summary":"Retrieve","description":"Returns a licensee by its `sl_` key. A cancelled or unknown licensee returns `404`.","operationId":"RetrieveLicensee","parameters":[{"$ref":"#/components/parameters/ApiKeyPathParam"},{"$ref":"#/components/parameters/LicenseePathParam"},{"$ref":"#/components/parameters/UserTokenParam"}],"responses":{"200":{"description":"Success","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LicenseeResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-codeSamples":[{"lang":"http","label":"URL","source":"https://api.ideal-postcodes.co.uk/v1/keys/ak_test/licensees/sl_ijoiqsxeQgXW2gkiE0X94?user_token=uk_secret\\n"},{"lang":"cURL","label":"curl","source":"curl -G \'https://api.ideal-postcodes.co.uk/v1/keys/ak_test/licensees/sl_ijoiqsxeQgXW2gkiE0X94\' \\\\\\n -d \'user_token=uk_secret\'\\n"},{"lang":"JavaScript","label":"JavaScript","source":"const response = await fetch(\\n \'https://api.ideal-postcodes.co.uk/v1/keys/ak_test/licensees/sl_ijoiqsxeQgXW2gkiE0X94?\' +\\n new URLSearchParams({\\n user_token: \'uk_secret\',\\n })\\n);\\n\\nconst { result } = await response.json();\\n"},{"lang":"Python","label":"Python","source":"import requests\\n\\nresponse = requests.get(\\n \\"https://api.ideal-postcodes.co.uk/v1/keys/ak_test/licensees/sl_ijoiqsxeQgXW2gkiE0X94\\",\\n params={\\n \\"user_token\\": \\"uk_secret\\",\\n },\\n)\\nresult = response.json()[\\"result\\"]\\n"},{"lang":"Ruby","label":"Ruby","source":"require \\"net/http\\"\\nrequire \\"json\\"\\n\\nuri = URI(\\"https://api.ideal-postcodes.co.uk/v1/keys/ak_test/licensees/sl_ijoiqsxeQgXW2gkiE0X94\\")\\nuri.query = URI.encode_www_form(user_token: \\"uk_secret\\")\\nresult = JSON.parse(Net::HTTP.get(uri))[\\"result\\"]\\n"},{"lang":"PHP","label":"PHP","source":"<?php\\n$response = file_get_contents(\\n \\"https://api.ideal-postcodes.co.uk/v1/keys/ak_test/licensees/sl_ijoiqsxeQgXW2gkiE0X94?\\" .\\n http_build_query([\\n \\"user_token\\" => \\"uk_secret\\",\\n ])\\n);\\n$result = json_decode($response, true)[\\"result\\"];\\n"}]},"delete":{"tags":["Licensees"],"summary":"Cancel","description":"Cancels a licensee. Its key stops working and it drops out of the licensee list. Contact us to reverse it.","operationId":"DeleteLicensee","parameters":[{"$ref":"#/components/parameters/ApiKeyPathParam"},{"$ref":"#/components/parameters/LicenseePathParam"},{"$ref":"#/components/parameters/UserTokenParam"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"required":["result","code","message"],"title":"Licensee Delete Response","type":"object","properties":{"result":{"type":"object","required":["deleted"],"properties":{"deleted":{"type":"number","format":"int32","example":1,"minimum":0}}},"code":{"type":"integer","format":"int32","enum":[2000]},"message":{"type":"string","enum":["Success"]}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-codeSamples":[{"lang":"cURL","label":"curl","source":"curl -X DELETE \'https://api.ideal-postcodes.co.uk/v1/keys/ak_test/licensees/sl_ijoiqsxeQgXW2gkiE0X94?user_token=uk_secret\'\\n"},{"lang":"JavaScript","label":"JavaScript","source":"const response = await fetch(\'https://api.ideal-postcodes.co.uk/v1/keys/ak_test/licensees/sl_ijoiqsxeQgXW2gkiE0X94?user_token=uk_secret\', {\\n method: \'DELETE\',\\n});\\n"},{"lang":"Python","label":"Python","source":"import requests\\n\\nresponse = requests.delete(\\n \\"https://api.ideal-postcodes.co.uk/v1/keys/ak_test/lice
1nsees/sl_ijoiqsxeQgXW2gkiE0X94\\",\\n params={\\"user_token\\": \\"uk_secret\\"},\\n)\\nresponse.raise_for_status()\\n"},{"lang":"Ruby","label":"Ruby","source":"require \\"net/http\\"\\n\\nuri = URI(\\"https://api.ideal-postcodes.co.uk/v1/keys/ak_test/licensees/sl_ijoiqsxeQgXW2gkiE0X94?user_token=uk_secret\\")\\nNet::HTTP.start(uri.host, use_ssl: true) do |http|\\n http.delete(uri.request_uri)\\nend\\n"},{"lang":"PHP","label":"PHP","source":"<?php\\n$ch = curl_init(\\"https://api.ideal-postcodes.co.uk/v1/keys/ak_test/licensees/sl_ijoiqsxeQgXW2gkiE0X94?user_token=uk_secret\\");\\ncurl_setopt_array($ch, [\\n CURLOPT_CUSTOMREQUEST => \\"DELETE\\",\\n CURLOPT_RETURNTRANSFER => true,\\n]);\\ncurl_exec($ch);\\n"}]},"put":{"tags":["Licensees"],"summary":"Update","description":"Updates a licensee\'s address, postcode, allowed URLs and daily limit. Returns the updated licensee. The name is fixed at creation.","operationId":"UpdateLicensee","parameters":[{"$ref":"#/components/parameters/ApiKeyPathParam"},{"$ref":"#/components/parameters/LicenseePathParam"},{"$ref":"#/components/parameters/UserTokenParam"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LicenseeEditable"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LicenseeResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-codeSamples":[{"lang":"cURL","label":"curl","source":"curl -X PUT \'https://api.ideal-postcodes.co.uk/v1/keys/ak_test/licensees/sl_ijoiqsxeQgXW2gkiE0X94?user_token=uk_secret\' \\\\\\n -H \'Content-Type: application/json\' \\\\\\n -d \'{\\n \\"daily\\": {\\n \\"limit\\": 20000\\n }\\n }\'\\n"},{"lang":"JavaScript","label":"JavaScript","source":"const response = await fetch(\'https://api.ideal-postcodes.co.uk/v1/keys/ak_test/licensees/sl_ijoiqsxeQgXW2gkiE0X94?user_token=uk_secret\', {\\n method: \'PUT\',\\n headers: { \'Content-Type\': \'application/json\' },\\n body: JSON.stringify({\\n daily: {\\n limit: 20000,\\n },\\n }),\\n});\\n\\nconst { result } = await response.json();\\n"},{"lang":"Python","label":"Python","source":"import requests\\n\\nresponse = requests.put(\\n \\"https://api.ideal-postcodes.co.uk/v1/keys/ak_test/licensees/sl_ijoiqsxeQgXW2gkiE0X94\\",\\n params={\\"user_token\\": \\"uk_secret\\"},\\n json={\\n \\"daily\\": {\\n \\"limit\\": 20000,\\n },\\n },\\n)\\nresult = response.json()[\\"result\\"]\\n"},{"lang":"Ruby","label":"Ruby","source":"require \\"net/http\\"\\nrequire \\"json\\"\\n\\nuri = URI(\\"https://api.ideal-postcodes.co.uk/v1/keys/ak_test/licensees/sl_ijoiqsxeQgXW2gkiE0X94?user_token=uk_secret\\")\\nbody = {\\n daily: {\\n limit: 20000,\\n },\\n}\\nresponse = Net::HTTP.put(uri, body.to_json, \\"Content-Type\\" => \\"application/json\\")\\nresult = JSON.parse(response.body)[\\"result\\"]\\n"},{"lang":"PHP","label":"PHP","source":"<?php\\n$ch = curl_init(\\"https://api.ideal-postcodes.co.uk/v1/keys/ak_test/licensees/sl_ijoiqsxeQgXW2gkiE0X94?user_token=uk_secret\\");\\ncurl_setopt_array($ch, [\\n CURLOPT_CUSTOMREQUEST => \\"PUT\\",\\n CURLOPT_HTTPHEADER => [\\"Content-Type: application/json\\"],\\n CURLOPT_POSTFIELDS => json_encode([\\n \\"daily\\" => [\\n \\"limit\\" => 20000,\\n ],\\n ]),\\n CURLOPT_RETURNTRANSFER => true,\\n]);\\n$result = json_decode(curl_exec($ch), true)[\\"result\\"];\\n"}]}},"/keys/{key}/licensees/{licensee}/regenerate-key":{"post":{"tags":["Licensees"],"summary":"Regenerate Key","description":"Regenerates a licensee\'s key and returns the licensee with the new key. The previous key stops working immediately, so update any integration that uses it.","operationId":"RegenerateLicenseeKey","parameters":[{"$ref":"#/components/parameters/ApiKeyPathParam"},{"$ref":"#/components/parameters/LicenseePathParam"},{"$ref":"#/components/parameters/UserTokenParam"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LicenseeResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/keys/{key}/configs":{"get":{"tags":["Configs"],"summary":"List","description":"Returns every configuration stored against a key, oldest first.","operationId":"ListConfigs","parameters":[{"$ref":"#/components/parameters/ApiKeyPathParam"},{"$ref":"#/components/parameters/UserTokenParam"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigsResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-codeSamples":[{"lang":"http","label":"URL","source":"https://api.ideal-postcodes.co.uk/v1/keys/ak_test/configs?user_token=uk_secret\\n"},{"lang":"cURL","label":"curl","source":"curl -G \'https://api.ideal-postcodes.co.uk/v1/keys/ak_test/configs\' \\\\\\n -d \'user_token=uk_secret\'\\n"},{"lang":"JavaScript","label":"JavaScript","source":"const response = await fetch(\\n \'https://api.ideal-postcodes.co.uk/v1/keys/ak_test/configs?\' +\\n new URLSearchParams({\\n user_token: \'uk_secret\',\\n })\\n);\\n\\nconst { result } = await response.json();\\n"},{"lang":"Python","label":"Python","source":"import requests\\n\\nresponse = requests.get(\\n \\"https://api.ideal-postcodes.co.uk/v1/keys/ak_test/configs\\",\\n params={\\n \\"user_token\\"
1: \\"uk_secret\\",\\n },\\n)\\nresult = response.json()[\\"result\\"]\\n"},{"lang":"Ruby","label":"Ruby","source":"require \\"net/http\\"\\nrequire \\"json\\"\\n\\nuri = URI(\\"https://api.ideal-postcodes.co.uk/v1/keys/ak_test/configs\\")\\nuri.query = URI.encode_www_form(user_token: \\"uk_secret\\")\\nresult = JSON.parse(Net::HTTP.get(uri))[\\"result\\"]\\n"},{"lang":"PHP","label":"PHP","source":"<?php\\n$response = file_get_contents(\\n \\"https://api.ideal-postcodes.co.uk/v1/keys/ak_test/configs?\\" .\\n http_build_query([\\n \\"user_token\\" => \\"uk_secret\\",\\n ])\\n);\\n$result = json_decode($response, true)[\\"result\\"];\\n"}]},"post":{"tags":["Configs"],"summary":"Create","description":"Creates a named configuration on a key and returns it.","operationId":"CreateConfig","parameters":[{"$ref":"#/components/parameters/ApiKeyPathParam"},{"$ref":"#/components/parameters/UserTokenParam"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigNewParam"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-codeSamples":[{"lang":"cURL","label":"curl","source":"curl -X POST \'https://api.ideal-postcodes.co.uk/v1/keys/ak_test/configs?user_token=uk_secret\' \\\\\\n -H \'Content-Type: application/json\' \\\\\\n -d \'{\\n \\"name\\": \\"woocommerce\\",\\n \\"payload\\": \\"{\\\\\\"removeOrganisation\\\\\\": false}\\"\\n }\'\\n"},{"lang":"JavaScript","label":"JavaScript","source":"const response = await fetch(\'https://api.ideal-postcodes.co.uk/v1/keys/ak_test/configs?user_token=uk_secret\', {\\n method: \'POST\',\\n headers: { \'Content-Type\': \'application/json\' },\\n body: JSON.stringify({\\n name: \'woocommerce\',\\n payload: \'{\\"removeOrganisation\\": false}\',\\n }),\\n});\\n\\nconst { result } = await response.json();\\n"},{"lang":"Python","label":"Python","source":"import requests\\n\\nresponse = requests.post(\\n \\"https://api.ideal-postcodes.co.uk/v1/keys/ak_test/configs\\",\\n params={\\"user_token\\": \\"uk_secret\\"},\\n json={\\n \\"name\\": \\"woocommerce\\",\\n \\"payload\\": \\"{\\\\\\"removeOrganisation\\\\\\": false}\\",\\n },\\n)\\nresult = response.json()[\\"result\\"]\\n"},{"lang":"Ruby","label":"Ruby","source":"require \\"net/http\\"\\nrequire \\"json\\"\\n\\nuri = URI(\\"https://api.ideal-postcodes.co.uk/v1/keys/ak_test/configs?user_token=uk_secret\\")\\nbody = {\\n name: \\"woocommerce\\",\\n payload: \'{\\"removeOrganisation\\": false}\',\\n}\\nresponse = Net::HTTP.post(uri, body.to_json, \\"Content-Type\\" => \\"application/json\\")\\nresult = JSON.parse(response.body)[\\"result\\"]\\n"},{"lang":"PHP","label":"PHP","source":"<?php\\n$ch = curl_init(\\"https://api.ideal-postcodes.co.uk/v1/keys/ak_test/configs?user_token=uk_secret\\");\\ncurl_setopt_array($ch, [\\n CURLOPT_POST => true,\\n CURLOPT_HTTPHEADER => [\\"Content-Type: application/json\\"],\\n CURLOPT_POSTFIELDS => json_encode([\\n \\"name\\" => \\"woocommerce\\",\\n \\"payload\\" => \'{\\"removeOrganisation\\": false}\',\\n ]),\\n CURLOPT_RETURNTRANSFER => true,\\n]);\\n$result = json_decode(curl_exec($ch), true)[\\"result\\"];\\n"}]}},"/keys/{key}/configs/{config}":{"get":{"tags":["Configs"],"summary":"Retrieve","description":"Returns a configuration by name. This request needs no `user_token`, so a browser integration can read its own configuration at runtime.","operationId":"RetrieveConfig","parameters":[{"$ref":"#/components/parameters/ApiKeyPathParam"},{"$ref":"#/components/parameters/ConfigParam"}],"responses":{"200":{"description":"Success","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-codeSamples":[{"lang":"http","label":"URL","source":"https://api.ideal-postcodes.co.uk/v1/keys/ak_test/configs/woocommerce?user_token=uk_secret\\n"},{"lang":"cURL","label":"curl","source":"curl -G \'https://api.ideal-postcodes.co.uk/v1/keys/ak_test/configs/woocommerce\' \\\\\\n -d \'user_token=uk_secret\'\\n"},{"lang":"JavaScript","label":"JavaScript","source":"const response = await fetch(\\n \'https://api.ideal-postcodes.co.uk/v1/keys/ak_test/configs/woocommerce?\' +\\n new URLSearchParams({\\n user_token: \'uk_secret\',\\n })\\n);\\n\\nconst { result } = await response.json();\\n"},{"lang":"Python","label":"Python","source":"import requests\\n\\nresponse = requests.get(\\n \\"https://api.ideal-postcodes.co.uk/v1/keys/ak_test/configs/woocommerce\\",\\n params={\\n \\"user_token\\"
1: \\"uk_secret\\",\\n },\\n)\\nresult = response.json()[\\"result\\"]\\n"},{"lang":"Ruby","label":"Ruby","source":"require \\"net/http\\"\\nrequire \\"json\\"\\n\\nuri = URI(\\"https://api.ideal-postcodes.co.uk/v1/keys/ak_test/configs/woocommerce\\")\\nuri.query = URI.encode_www_form(user_token: \\"uk_secret\\")\\nresult = JSON.parse(Net::HTTP.get(uri))[\\"result\\"]\\n"},{"lang":"PHP","label":"PHP","source":"<?php\\n$response = file_get_contents(\\n \\"https://api.ideal-postcodes.co.uk/v1/keys/ak_test/configs/woocommerce?\\" .\\n http_build_query([\\n \\"user_token\\" => \\"uk_secret\\",\\n ])\\n);\\n$result = json_decode($response, true)[\\"result\\"];\\n"}]},"delete":{"tags":["Configs"],"summary":"Delete","description":"Permanently deletes a configuration object.","operationId":"DeleteConfig","parameters":[{"$ref":"#/components/parameters/ApiKeyPathParam"},{"$ref":"#/components/parameters/ConfigParam"},{"$ref":"#/components/parameters/UserTokenParam"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"title":"Config Delete Response","type":"object","required":["result","code","message"],"properties":{"result":{"type":"object","required":["deleted"],"properties":{"deleted":{"type":"number","format":"int32","example":1,"minimum":0}}},"code":{"type":"integer","format":"int32","enum":[2000]},"message":{"type":"string","enum":["Success"]}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-codeSamples":[{"lang":"cURL","label":"curl","source":"curl -X DELETE \'https://api.ideal-postcodes.co.uk/v1/keys/ak_test/configs/woocommerce?user_token=uk_secret\'\\n"},{"lang":"JavaScript","label":"JavaScript","source":"const response = await fetch(\'https://api.ideal-postcodes.co.uk/v1/keys/ak_test/configs/woocommerce?user_token=uk_secret\', {\\n method: \'DELETE\',\\n});\\n"},{"lang":"Python","label":"Python","source":"import requests\\n\\nresponse = requests.delete(\\n \\"https://api.ideal-postcodes.co.uk/v1/keys/ak_test/configs/woocommerce\\",\\n params={\\"user_token\\": \\"uk_secret\\"},\\n)\\nresponse.raise_for_status()\\n"},{"lang":"Ruby","label":"Ruby","source":"require \\"net/http\\"\\n\\nuri = URI(\\"https://api.ideal-postcodes.co.uk/v1/keys/ak_test/configs/woocommerce?user_token=uk_secret\\")\\nNet::HTTP.start(uri.host, use_ssl: true) do |http|\\n http.delete(uri.request_uri)\\nend\\n"},{"lang":"PHP","label":"PHP","source":"<?php\\n$ch = curl_init(\\"https://api.ideal-postcodes.co.uk/v1/keys/ak_test/configs/woocommerce?user_token=uk_secret\\");\\ncurl_setopt_array($ch, [\\n CURLOPT_CUSTOMREQUEST => \\"DELETE\\",\\n CURLOPT_RETURNTRANSFER => true,\\n]);\\ncurl_exec($ch);\\n"}]},"post":{"tags":["Configs"],"summary":"Update","description":"Replaces a configuration\'s payload and returns the updated configuration. The name is fixed at creation.","operationId":"UpdateConfig","parameters":[{"$ref":"#/components/parameters/ApiKeyPathParam"},{"$ref":"#/components/parameters/ConfigParam"},{"$ref":"#/components/parameters/UserTokenParam"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigUpdateParam"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-codeSamples":[{"lang":"cURL","label":"curl","source":"curl -X POST \'https://api.ideal-postcodes.co.uk/v1/keys/ak_test/configs/woocommerce?user_token=uk_secret\' \\\\\\n -H \'Content-Type: application/json\' \\\\\\n -d \'{\\n \\"payload\\": \\"{\\\\\\"removeOrganisation\\\\\\": true}\\"\\n }\'\\n"},{"lang":"JavaScript","label":"JavaScript","source":"const response = await fetch(\'https://api.ideal-postcodes.co.uk/v1/keys/ak_test/configs/woocommerce?user_token=uk_secret\', {\\n method: \'POST\',\\n headers: { \'Content-Type\': \'application/json\' },\\n body: JSON.stringify({\\n payload: \'{\\"removeOrganisation\\": true}\',\\n }),\\n});\\n\\nconst { result } = await response.json();\\n"},{"lang":"Python","label":"Python","source":"import requests\\n\\nresponse = requests.post(\\n \\"https://api.ideal-postcodes.co.uk/v1/keys/ak_test/configs/woocommerce\\",\\n params={\\"user_token\\"
1: \\"uk_secret\\"},\\n json={\\n \\"payload\\": \\"{\\\\\\"removeOrganisation\\\\\\": true}\\",\\n },\\n)\\nresult = response.json()[\\"result\\"]\\n"},{"lang":"Ruby","label":"Ruby","source":"require \\"net/http\\"\\nrequire \\"json\\"\\n\\nuri = URI(\\"https://api.ideal-postcodes.co.uk/v1/keys/ak_test/configs/woocommerce?user_token=uk_secret\\")\\nbody = {\\n payload: \'{\\"removeOrganisation\\": true}\',\\n}\\nresponse = Net::HTTP.post(uri, body.to_json, \\"Content-Type\\" => \\"application/json\\")\\nresult = JSON.parse(response.body)[\\"result\\"]\\n"},{"lang":"PHP","label":"PHP","source":"<?php\\n$ch = curl_init(\\"https://api.ideal-postcodes.co.uk/v1/keys/ak_test/configs/woocommerce?user_token=uk_secret\\");\\ncurl_setopt_array($ch, [\\n CURLOPT_POST => true,\\n CURLOPT_HTTPHEADER => [\\"Content-Type: application/json\\"],\\n CURLOPT_POSTFIELDS => json_encode([\\n \\"payload\\" => \'{\\"removeOrganisation\\": true}\',\\n ]),\\n CURLOPT_RETURNTRANSFER => true,\\n]);\\n$result = json_decode(curl_exec($ch), true)[\\"result\\"];\\n"}]}},"/emails":{"get":{"tags":["Emails"],"summary":"Email Validation","description":"Validates an email address and reports whether it is deliverable.\\n\\nRequires an API Key licensed for email validation. A query over 320 characters is rejected.\\n\\nA validated address decrements your lookup balance. An address the API cannot check returns `unknown` and costs no lookup. An address whose domain does not resolve, or publishes no MX records, returns `not_deliverable` and also costs no lookup. Only those two domain failures populate `suggestions`. Every other response returns an empty list.\\n","operationId":"EmailValidation","parameters":[{"$ref":"#/components/parameters/ApiKeyParam"},{"name":"query","in":"query","description":"Specifies the email address to validate","required":true,"explode":false,"style":"form","schema":{"type":"string"},"allowReserved":true},{"$ref":"#/components/parameters/TagsParam"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailResponse"},"examples":{"Valid Email":{"value":{"result":{"result":"deliverable","deliverable":true,"catchall":false,"free":false,"role":true,"disposable":false,"suggestions":[]},"code":2000,"message":"Success"}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-codeSamples":[{"lang":"http","label":"URL","source":"https://api.ideal-postcodes.co.uk/v1/emails?api_key=ak_test&[email protected]\\n"},{"lang":"cURL","label":"curl","source":"curl -G \'https://api.ideal-postcodes.co.uk/v1/emails\' \\\\\\n -d \'api_key=ak_test\' \\\\\\n --data-urlencode \'[email protected]\'\\n"},{"lang":"JavaScript","label":"JavaScript","source":"const response = await fetch(\\n \'https://api.ideal-postcodes.co.uk/v1/emails?\' +\\n new URLSearchParams({\\n api_key: \'ak_test\',\\n query: \'[email protected]\',\\n })\\n);\\n\\nconst { result } = await response.json();\\n"},{"lang":"Python","label":"Python","source":"import requests\\n\\nresponse = requests.get(\\n \\"https://api.ideal-postcodes.co.uk/v1/emails\\",\\n params={\\n \\"api_key\\": \\"ak_test\\",\\n \\"query\\": \\"[email protected]\\",\\n },\\n)\\nresult = response.json()[\\"result\\"]\\n"},{"lang":"Ruby","label":"Ruby","source":"require \\"net/http\\"\\nrequire \\"json\\"\\n\\nuri = URI(\\"https://api.ideal-postcodes.co.uk/v1/emails\\")\\nuri.query = URI.encode_www_form(api_key: \\"ak_test\\", query: \\"[email protected]\\")\\nresult = JSON.parse(Net::HTTP.get(uri))[\\"result\\"]\\n"},{"lang":"PHP","label":"PHP","source":"<?php\\n$response = file_get_contents(\\n \\"https://api.ideal-postcodes.co.uk/v1/emails?\\" .\\n http_build_query([\\n \\"api_key\\" => \\"ak_test\\",\\n \\"query\\" => \\"[email protected]\\",\\n ])\\n);\\n$result = json_decode($response, true)[\\"result\\"];\\n"}]}},"/phone_numbers":{"get":{"tags":["Phone Numbers"],"summary":"Phone Number Validation","description":"Validates a phone number and returns its country, its national and international formats, and the network it was originally assigned to.\\n\\nRequires an API Key licensed for phone validation.\\n\\nEvery query decrements your lookup balance, including a number that fails to parse and a number reported as invali
1d.\\n","operationId":"PhoneNumberValidation","parameters":[{"$ref":"#/components/parameters/ApiKeyParam"},{"name":"query","in":"query","description":"Specifies the phone number to validate. Phone number must include a country code in an acceptable format. For instance, UK phone numbers should be prefixed with `+44`, `44` or `0044`.","required":true,"explode":false,"style":"form","schema":{"type":"string"},"allowReserved":true},{"name":"current_carrier","in":"query","required":false,"description":"When set to `true`, the API retrieves and populates the current network of the phone number.\\n\\nThis operation can be slow, depending on the network and local conditions.\\n","explode":false,"style":"form","schema":{"type":"string","enum":["true"]}},{"$ref":"#/components/parameters/TagsParam"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PhoneNumberResponse"},"examples":{"Valid Phone Number":{"value":{"result":{"valid":true,"national_format":"020 7112 8019","international_format":"+44 20 7112 8019","iso_country":"GBR","iso_country_2":"GB","country":"United Kingdom","current_carrier":{"network_code":null,"name":"Invomo Ltd","country":"GB","network_type":"landline"},"original_carrier":{"network_code":null,"name":"Invomo Ltd","country":"GB","network_type":"landline"}},"code":2000,"message":"Success"}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-codeSamples":[{"lang":"http","label":"URL","source":"https://api.ideal-postcodes.co.uk/v1/phone_numbers?api_key=ak_test&query=02071128019\\n"},{"lang":"cURL","label":"curl","source":"curl -G \'https://api.ideal-postcodes.co.uk/v1/phone_numbers\' \\\\\\n -d \'api_key=ak_test\' \\\\\\n -d \'query=02071128019\'\\n"},{"lang":"JavaScript","label":"JavaScript","source":"const response = await fetch(\\n \'https://api.ideal-postcodes.co.uk/v1/phone_numbers?\' +\\n new URLSearchParams({\\n api_key: \'ak_test\',\\n query: \'02071128019\',\\n })\\n);\\n\\nconst { result } = await response.json();\\n"},{"lang":"Python","label":"Python","source":"import requests\\n\\nresponse = requests.get(\\n \\"https://api.ideal-postcodes.co.uk/v1/phone_numbers\\",\\n params={\\n \\"api_key\\": \\"ak_test\\",\\n \\"query\\": \\"02071128019\\",\\n },\\n)\\nresult = response.json()[\\"result\\"]\\n"},{"lang":"Ruby","label":"Ruby","source":"require \\"net/http\\"\\nrequire \\"json\\"\\n\\nuri = URI(\\"https://api.ideal-postcodes.co.uk/v1/phone_numbers\\")\\nuri.query = URI.encode_www_form(api_key: \\"ak_test\\", query: \\"02071128019\\")\\nresult = JSON.parse(Net::HTTP.get(uri))[\\"result\\"]\\n"},{"lang":"PHP","label":"PHP","source":"<?php\\n$response = file_get_contents(\\n \\"https://api.ideal-postcodes.co.uk/v1/phone_numbers?\\" .\\n http_build_query([\\n \\"api_key\\" => \\"ak_test\\",\\n \\"query\\" => \\"02071128019\\",\\n ])\\n);\\n$result = json_decode($response, true)[\\"result\\"];\\n"}]}},"/sign_up":{"post":{"tags":["Sign Up"],"summary":"Mint CLI Signup Token","description":"Mints a one-shot `cli_token` and returns a prefilled signup URL. The user opens the URL, clears the captcha, accepts the Terms of Service and creates the account. The CLI then polls `GET /sign_up/{cli_token}` until the accounts service has propagated the new user and its first API key, at which point the API returns the credentials exactly once.\\n\\nThe API does not store the `cli_token` when it mints it. The token becomes known to the API only once the accounts service propagates the new user, so the CLI must set its own polling deadline. If the user never completes signup, `GET /sign_up/{cli_token}` returns `202 Accepted` indefinitely.\\n","operationId":"SignUpMintToken","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["email","name","org_name","org_address_line_one","org_post_town","org_postcode","org_country_code"],"properties":{"email":{"type":"string","format":"email","minLength":1,"description":"Account holder\'s email address."}
1,"name":{"type":"string","minLength":1,"description":"Account holder\'s full name."},"org_name":{"type":"string","minLength":1,"description":"Organisation name."},"org_address_line_one":{"type":"string","minLength":1},"org_address_line_two":{"type":"string"},"org_address_line_three":{"type":"string"},"org_post_town":{"type":"string","minLength":1},"org_postcode":{"type":"string","minLength":1},"org_country_code":{"type":"string","minLength":2,"description":"ISO 3166-1 alpha-2 country code."}}}}}},"responses":{"200":{"description":"Token minted","content":{"application/json":{"schema":{"type":"object","required":["code","message","result"],"properties":{"code":{"type":"integer","example":2000},"message":{"type":"string","example":"Success"},"result":{"type":"object","required":["cli_token","signup_url"],"properties":{"cli_token":{"type":"string","description":"Random URL-safe token (base64url). Used by the CLI to poll for credentials."},"signup_url":{"type":"string","format":"uri","description":"Prefilled accounts web URL. The user opens this in a browser to complete signup."}}}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-codeSamples":[{"lang":"cURL","label":"curl","source":"curl -X POST \'https://api.ideal-postcodes.co.uk/v1/sign_up\' \\\\\\n -H \'Content-Type: application/json\' \\\\\\n -d \'{\\n \\"email\\": \\"[email protected]\\",\\n \\"name\\": \\"Jane Smith\\",\\n \\"org_name\\": \\"Example Corp\\",\\n \\"org_address_line_one\\": \\"10 Example Street\\",\\n \\"org_post_town\\": \\"London\\",\\n \\"org_postcode\\": \\"SW1A 1AA\\",\\n \\"org_country_code\\": \\"GB\\"\\n }\'\\n"},{"lang":"JavaScript","label":"JavaScript","source":"const response = await fetch(\'https://api.ideal-postcodes.co.uk/v1/sign_up\', {\\n method: \'POST\',\\n headers: { \'Content-Type\': \'application/json\' },\\n body: JSON.stringify({\\n email: \'[email protected]\',\\n name: \'Jane Smith\',\\n org_name: \'Example Corp\',\\n org_address_line_one: \'10 Example Street\',\\n org_post_town: \'London\',\\n org_postcode: \'SW1A 1AA\',\\n org_country_code: \'GB\',\\n }),\\n});\\n\\nconst { result } = await response.json();\\n"},{"lang":"Python","label":"Python","source":"import requests\\n\\nresponse = requests.post(\\n \\"https://api.ideal-postcodes.co.uk/v1/sign_up\\",\\n json={\\n \\"email\\": \\"[email protected]\\",\\n \\"name\\": \\"Jane Smith\\",\\n \\"org_name\\": \\"Example Corp\\",\\n \\"org_address_line_one\\": \\"10 Example Street\\",\\n \\"org_post_town\\": \\"London\\",\\n \\"org_postcode\\": \\"SW1A 1AA\\",\\n \\"org_country_code\\": \\"GB\\",\\n },\\n)\\nresult = response.json()[\\"result\\"]\\n"},{"lang":"Ruby","label":"Ruby","source":"require \\"net/http\\"\\nrequire \\"json\\"\\n\\nuri = URI(\\"https://api.ideal-postcodes.co.uk/v1/sign_up\\")\\nbody = {\\n email: \\"[email protected]\\",\\n name: \\"Jane Smith\\",\\n org_name: \\"Example Corp\\",\\n org_address_line_one: \\"10 Example Street\\",\\n org_post_town: \\"London\\",\\n org_postcode: \\"SW1A 1AA\\",\\n org_country_code: \\"GB\\",\\n}\\nresponse = Net::HTTP.post(uri, body.to_json, \\"Content-Type\\" => \\"application/json\\")\\nresult = JSON.parse(response.body)[\\"result\\"]\\n"},{"lang":"PHP","label":"PHP","source":"<?php\\n$ch = curl_init(\\"https://api.ideal-postcodes.co.uk/v1/sign_up\\");\\ncurl_setopt_array($ch, [\\n CURLOPT_POST => true,\\n CURLOPT_HTTPHEADER => [\\"Content-Type: application/json\\"],\\n CURLOPT_POSTFIELDS => json_encode([\\n \\"email\\" => \\"[email protected]\\",\\n \\"name\\" => \\"Jane Smith\\",\\n \\"org_name\\" => \\"Example Corp\\",\\n \\"org_address_line_one\\" => \\"10 Example Street\\",\\n \\"org_post_town\\" => \\"London\\",\\n \\"org_postcode\\" => \\"SW1A 1AA\\",\\n \\"org_country_code\\" => \\"GB\\",\\n ]),\\n CURLOPT_RETURNTRANSFER => true,\\n]);\\n$result = json_decode(curl_exec($ch), true)[\\"result\\"];\\n"}]}},"/sign_up/{cli_token}":{"get":{"tags":["Sign Up"],"summary":"Poll CLI Signup Token","description":"Returns the account credentials for a minted `cli_token` once signup has completed, and `202 Accepted` until then. The CLI calls this endpoint repeatedly after sending the user to the `signup_url` returned by `POST /sign_up`.\\n\\n- `202 Accepted`. The accounts service has not propagated the user yet, or has propagated the user but not minted the first API key. Keep polling. An unknown token also returns `202`, because the API does not record a token at mint time, so the CLI must set its own polling deadline.\\n- `200 OK`. The user and first API key exist. The API returns the credentials once. Later polls return `410 Gone`.\\n- `410 Gone`. The token has expired or has already been claimed.\\n","operationId":"SignUpClaim","parameters":[{"name":"cli_token","in":"path","required":true,"description":"The token returned by `POST /sign_up`.","schema":{"type":"string","minLength":1}}],"responses":{"200":{"description":"Credentials ready","content":{"application/json":{"schema":{"type":"object","required":["code","message","result"],"properties":{"code":{"type":"integer","example":2000},"message":{"type":"string","example":"Success"},"result":{"type":"object","required":["user_token","test_api_key","user_id"],"properties":{"user_token":{"type":"string","description":"User-level token used to manage account resources via the api."},"test_api_key":{"type":"string","description":"Initial test API key for the account."},"user_id":{"type":"string","description":"Internal api user id."}}}}}}}},"202":{"description":"Pending, keep polling","content":{"application/json":{"schema":{"type":"object","required":["code","message","result"],"properties":{"code":{"type":"integer","example":2020},"message":{"type":"string","example":"Pending"},"result":{"type":"object","required":["status"],"properties":{"status":{"type":"string","enum":["pending"]}}}}}}}},"410":{"description":"Signup token expired or already claimed","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"integer","example":4100},"message":{"type":"string"}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-codeSamples":[{"lang":"http","label":"URL","source":"https://api.ideal-postcodes.co.uk/v1/sign_up/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...\\n"},{"lang":"cURL","label":"curl","source":"curl \'https://api.ideal-postcodes.co.uk/v1/sign_up/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...\'\\n"},{"lang":"JavaScript","label":"JavaScript","source":"const response = await fetch(\'https://api.ideal-postcodes.co.uk/v1/sign_up/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...\');\\n\\nconst { result } = await response.json();\\n"},{"lang":"Python","label":"Python","source":"import requests\\n\\nresponse = requests.get(\\"https://api.ideal-postcodes.co.uk/v1/sign_up/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...\\")\\nresult = response.json()[\\"result\\"]\\n"},{"lang":"Ruby","label":"Ruby","source":"require \\"net/http\\"\\nrequire \\"json\\"\\n\\nuri = URI(\\"https://api.ideal-postcodes.co.uk/v1/sign_up/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...\\")\\nresult = JSON.parse(Net::HTTP.get(uri))[\\"result\\"]\\n"},{"lang":"PHP","label":"PHP","source":"<?php\\n$response = file_get_contents(\\"https://api.ideal-postcodes.co.uk/v1/sign_up/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...\\");\\n$result = json_decode($response, true)[\\"result\\"];\\n"}]}}},"components":{"parameters":{"ApiKeyParam":{"description":"**API Key**\\n\\
1nYour unique identifier that allows access to our APIs.\\n\\nBegins `ak_`. Available from your dashboard.\\n","example":"ak_test","explode":false,"in":"query","name":"api_key","schema":{"type":"string"},"style":"form"},"FilterParam":{"name":"filter","in":"query","style":"form","explode":false,"schema":{"type":"string"},"description":"**Restrict Result Fields**\\n\\nComma separated whitelist of address elements to return. \\n\\nE.g. `filter=line_1,line_2,line_3` returns only the `line_1`, `line_2` and `line_3` address elements in your response.\\n","example":"line_1,line_2,line_3"},"PageParam":{"name":"page","in":"query","style":"form","explode":false,"schema":{"type":"integer","minimum":0,"maximum":100,"default":0,"format":"int32"},"description":"**Page**\\n\\n0 indexed indicator of the page of results to receive. Virtually all postcode results are returned on page 0. \\n\\nA small number of Multiple Residence postcodes may need pagination (i.e. have more than 100 premises).\\n","example":1},"TagsParam":{"name":"tags","in":"query","style":"form","explode":false,"required":false,"schema":{"type":"string"},"description":"**Tags**\\n\\nA comma separated list of tags to query over.\\n\\nUseful if you want to specify the circumstances in which the request was made.\\n\\nIf you specify multiple tags, the response comprises only requests that satisfy all of them. Searching `\\"foo,bar\\"` queries only requests tagged both `\\"foo\\"` and `\\"bar\\"`.\\n","example":"foo,bar"},"DatasetParam":{"name":"dataset","in":"query","style":"form","explode":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/Dataset"}},"description":"**Filter by Dataset**\\n\\nComma-separated list of datasets to search within.\\n\\nFilters results to only include addresses from the specified datasets. Useful for keys with multiple overlapping datasets enabled (e.g. `paf` and `abp`).\\n","example":"paf,nyb"},"ContextParam":{"name":"context","in":"query","style":"form","explode":false,"example":"GBR","description":"**Context**\\n\\nLimits search results, typically within a country.\\n","schema":{"type":"string"}},"ApiKeyPathParam":{"name":"key","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"example":"ak_test","description":"**API Key**\\n\\nThe API Key to retrieve. Begins `ak_`.\\n"},"UserTokenParam":{"in":"query","style":"form","explode":false,"schema":{"type":"string"},"name":"user_token","description":"**Private User Token**\\n\\nA secret key used for sensitive operations on your account and API Keys.\\n\\nYour user token can be retrieved and managed from your [accounts page](https://account.ideal-postcodes.co.uk/account).\\n\\nTypically begins `uk_...`\\n","example":"uk_B59ScW1p1HHouf1VqclEPZUx"},"StartParam":{"name":"start","style":"form","in":"query","schema":{"type":"integer","format":"int64","minimum":0},"description":"**Start Timestamp**\\n\\nA start date/time in the form of a UNIX Timestamp in milliseconds. E.g. `1418556452651`\\n","example":1418556452651},"EndParam":{"name":"end","style":"form","in":"query","schema":{"type":"integer","format":"int64","minimum":0},"description":"**End Timestamp**\\n\\nAn end date/time in the form of a UNIX Timestamp in milliseconds. E.g. `1418556477882`\\n","example":1418556492651},"LicenseeParam":{"example":"sl_hk71kco54zGSGvF9eXXrvvnMOLLNh","description":"**Licensee Key**\\n\\nUniquely identifies a licensee.\\n","explode":false,"in":"query","name":"licensee","schema":{"type":"string"},"style":"form"},"LimitParam":{"name":"limit","in":"query","style":"form","explode":false,"schema":{"minimum":1,"maximum":100,"default":10,"type":"integer","format":"int32"},"example":5,"description":"**Limit**\\n\\nSpecifies the maximum number of records to retrieve.\\n\\nBy default the limit is 10. Requesting a larger result set adds latency.\\n"},"BiasLonLatParam":{"name":"bias_lonlat","in":"query","style":"form","explode":false,"schema":{"type":"string"},"description":"**Bias by Geolocation**\\n\\nBias search to a geospatial circle determined by an origin and radius in metres. Max radiu
1s is `50000`. \\nUses the format bias_lonlat=[longitude],[latitude],[radius in metres].\\nOnly one geospatial bias may be provided.\\n","example":"-2.095,57.15,100"},"BiasIpParam":{"name":"bias_ip","in":"query","style":"form","explode":false,"required":false,"description":"**Bias by Geolocation of IP**\\n\\nBiases search based on approximate geolocation of IP address.\\n\\nSet `bias_ip=true` to enable.\\n","schema":{"type":"string","enum":["true"]}},"BoxParam":{"name":"box","in":"query","style":"form","explode":false,"schema":{"type":"string"},"description":"**Filter by Bounding Box**\\n\\nRestrict search to a geospatial box determined by the \\"top-left\\" and \\"bottom-right\\" geolocations.\\n\\nSupply 4 comma separated values ordered `top_left_lon,top_left_lat,bottom_right_lon,bottom_right_lat`. The top-left longitude must be less than the bottom-right longitude, and the top-left latitude greater than the bottom-right latitude. A box which fails either check is ignored.\\n\\nOnly one geospatial box can be provided.\\n","example":"-2.096,57.15,-2.095,57.14"},"PostcodeOutwardParam":{"name":"postcode_outward","in":"query","style":"form","explode":false,"schema":{"type":"string"},"description":"**Filter by Outward Code**\\n\\nRestrict result set to addresses with a matching outward code.\\n\\nThe outward code is the first half of a postcode. E.g. the outward code for `SW1A 2AA` is `SW1A`.\\n","example":"SW1A"},"PostcodeParam":{"name":"postcode","in":"query","style":"form","explode":false,"schema":{"type":"string"},"description":"**Filter by postcode**\\nRestrict result set to matching postcodes only.\\nCan be combined with query to perform a postcode and building number or name search.","example":"SW1A 2AA"},"PostcodeAreaParam":{"name":"postcode_area","in":"query","style":"form","explode":false,"schema":{"type":"string"},"description":"**Filter by Postcode Area**\\n\\nPostcode area represents the first one or two non-numeric characters of a postcode. E.g. the postcode area of `SW1A 2AA` is `SW`.\\n\\nCan be combined with query to perform a postcode and building search.\\n","example":"SW"},"PostcodeSectorParam":{"name":"postcode_sector","in":"query","style":"form","explode":false,"schema":{"type":"string"},"description":"**Filter by Postcode Sector**\\n\\nPostcode sector is the outward code plus first numeric of the inward code. E.g. postcode sector of `SW1A 2AA` is `SW1A 2`\\n","example":"SW1A 2"},"PostTownParam":{"name":"post_town","in":"query","style":"form","explode":false,"schema":{"type":"string"},"description":"**Filter by Town or City**\\n\\nRestrict addresses to matching town, city or other locality identifier.\\n","example":"London"},"UPRNParam":{"name":"uprn","in":"query","style":"form","explode":false,"schema":{"type":"integer"},"description":"**Filter by UPRN**\\n\\nDoes not accept comma separated terms. Only a single term is permitted.\\n","example":"100023336956"},"CountryParam":{"name":"country","in":"query","style":"form","explode":false,"schema":{"type":"string"},"description":"**Filter by country**\\n\\nFilters by country name.\\n\\nIn the GBR context, the country is never United Kingdom. It is England, Scotland, Wales, Northern Ireland, Jersey, Guernsey or Isle of Man.\\n","example":"England"}
1,"PostcodeTypeParam":{"name":"postcode_type","in":"query","style":"form","explode":false,"schema":{"type":"string"},"description":"**Filter by Postcode Type**\\n\\nUseful for separating organisational and residential addresses.\\n"},"SmallUserParam":{"name":"su_organisation_indicator","in":"query","style":"form","explode":false,"schema":{"type":"string"},"description":"**Filter by Organisation Indicator**\\n\\nUseful for separating organisational and residential addresses.\\n","example":"Y"},"BiasPostcodeOutwardParam":{"name":"bias_postcode_outward","in":"query","style":"form","explode":false,"schema":{"type":"string"},"description":"**Bias by Outward Code**\\nBoosts addresses with a matching outward code.\\nThe outward code is the first half of a postcode. For instance, the outward code of `SW1A 2AA` is `SW1A`.","example":"SW1A"},"BiasPostcodeParam":{"name":"bias_postcode","in":"query","style":"form","explode":false,"schema":{"type":"string"},"description":"**Bias by postcode**\\nBoost addresses which match postcode.\\nCan be combined with query to perform a postcode and building number or name search.","example":"SW1A2AA"},"BiasPostcodeAreaParam":{"name":"bias_postcode_area","in":"query","style":"form","explode":false,"schema":{"type":"string"},"description":"**Bias by Postcode Area**\\n\\nBoosts if the first one or two non-numeric characters of a postcode match\\n\\nThe postcode areas of SW1A 2AA and N1 6RT are SW and N respectively.\\n","example":"SW"},"BiasPostcodeSectorParam":{"name":"bias_postcode_sector","in":"query","style":"form","explode":false,"schema":{"type":"string"},"description":"**Bias by Postcode Sector**\\n\\nBoost postcode sector matches. The postcode sector comprises the outward code plus first numeric of the inward code.\\n","example":"SW1A 2"},"BiasPosttownParam":{"name":"bias_post_town","in":"query","style":"form","explode":false,"schema":{"type":"string"},"description":"**Bias by Town or City**\\n\\nBiases results to matching town, city or other locality name.\\n"},"BiasThoroughfareParam":{"name":"bias_thoroughfare","in":"query","style":"form","explode":false,"schema":{"type":"string"},"description":"**Bias by Street**\\n\\nBias by street or thoroughfare name.\\n"},"BiasCountryParam":{"name":"bias_country","in":"query","style":"form","explode":false,"schema":{"type":"string"},"description":"**Bias by Country**\\n\\nPossible values are England, Scotland, Wales, Northern Ireland, Jersey, Guernsey and Isle of Man.\\n"},"PostalCodeParam":{"name":"postal_code","in":"query","style":"form","explode":false,"schema":{"type":"string"},"description":"**Filter by postal code**\\n\\nRestrict results to addresses with a matching full postal code. Case, spaces and hyphens are ignored. For US addresses the full postal code is the nine digit ZIP+4 (`941021234`); filter on `postal_code_3` for a five digit ZIP. For UK addresses use `postcode`.\\n","example":"94102-1234"},"PostalCode2Param":{"name":"postal_code_2","in":"query","style":"form","explode":false,"schema":{"type":"string"},"description":"**Filter by postal code prefix**\\n\\nRestrict results to addresses whose postal code starts with the given segment. For US addresses this is the three digit ZIP prefix (sectional center), e.g. `941` for San Francisco.\\n","example":"941"},"PostalCode3Param":{"name":"postal_code_3","in":"query","style":"form","explode":false,"schema":{"type":"string"},"description":"**Filter by short postal code**\\n\\nRestrict results to addresses with a matching short postal code. For US addresses this is the five digit ZIP code.\\n","example":"94102"},"CityParam":{"name":"city","in":"query","style":"form","explode":false,"schema":{"type":"string"},"description":"**Filter by city**\\n\\nRestrict results to addresses in the named city, town or locality. Case, spaces and accents are ignored, so `San Francisco` and `sanfrancisco` match the same addresses. For UK addresses use `post_town`.\\n","example":"San Francisco"},"StateParam":{"name":"state","in":"query","style":"form","explode":false,"schema":{"type":"string"},"description":"**Filter by state**\\n\\nRestrict results to addresses in the named state, province or region, e.g. `California`. Case and spaces are ignored.\\n","example":"California"},"StateCodeParam":{"name":"state_code","in":"query","style":"form","explode":false,"schema":{"type":"string"},"description":"**Filter by state code**\\n\\nRestrict results to addresses with a matching state or region code, e.g. the two letter USPS state abbreviation `CA`. Case is ignored.\\n","example":"CA"},"BiasPostalCodeParam":{"name":"bias_postal_code","in":"query","style":"form","explode":false,"schema":{"type":"string"},"description":"**Bias by postal code**\\n\\nBoost addresses with a matching full postal code (nine digit ZIP+4 for US addresses). Unmatched addresses still appear, ranked lower.\\n","example":"94102-1234"},"BiasPostalCode2Param":{"name":"bias_postal_code_2","in":"query","style":"form","explode":false,"schema":{"type":"string"}
1,"description":"**Bias by postal code prefix**\\n\\nBoost addresses whose postal code starts with the given segment (three digit ZIP prefix for US addresses).\\n","example":"941"},"BiasPostalCode3Param":{"name":"bias_postal_code_3","in":"query","style":"form","explode":false,"schema":{"type":"string"},"description":"**Bias by short postal code**\\n\\nBoost addresses with a matching short postal code (five digit ZIP for US addresses).\\n","example":"94102"},"BiasCityParam":{"name":"bias_city","in":"query","style":"form","explode":false,"schema":{"type":"string"},"description":"**Bias by city**\\n\\nBoost addresses in the named city, town or locality. Case, spaces and accents are ignored. For UK addresses use `bias_posttown`.\\n","example":"San Francisco"},"BiasStateParam":{"name":"bias_state","in":"query","style":"form","explode":false,"schema":{"type":"string"},"description":"**Bias by state**\\n\\nBoost addresses in the named state, province or region.\\n","example":"California"},"BiasStateCodeParam":{"name":"bias_state_code","in":"query","style":"form","explode":false,"schema":{"type":"string"},"description":"**Bias by state code**\\n\\nBoost addresses with a matching state or region code, e.g. `CA`.\\n","example":"CA"},"IsPoboxParam":{"name":"is_pobox","in":"query","style":"form","explode":false,"schema":{"type":"string","enum":["true","false"]},"description":"**Filter by PO Box**\\n\\n`true` restricts results to PO Box addresses; `false` excludes them. For US addresses this is derived from the USPS record type (`P`).\\n","example":"true"},"IsBusinessParam":{"name":"is_business","in":"query","style":"form","explode":false,"schema":{"type":"string","enum":["true","false"]},"description":"**Filter by business address**\\n\\n`true` restricts results to business addresses; `false` excludes them. For US addresses this is derived from the USPS record type (`F`, a firm record).\\n","example":"true"},"AddressLongitudeParam":{"name":"lon","in":"query","style":"form","explode":false,"schema":{"type":"number","format":"float","minimum":-180,"maximum":180},"description":"**Longitude**\\n\\nLongitude query for reverse geocoding.\\n\\nA valid reverse geocode query also needs a latitude (lat=) query.\\n","example":-0.12767},"AddressLatitudeParam":{"name":"lat","in":"query","style":"form","explode":false,"schema":{"type":"number","format":"float","minimum":-90,"maximum":90},"description":"**Latitude**\\n\\nLatitude query for reverse geocoding.\\n\\nA valid reverse geocode query also needs a longitude (lon=) query.\\n","example":51.503541},"CountryIsoParam":{"name":"country_iso","in":"query","style":"form","explode":false,"schema":{"type":"string"},"description":"**Filter by Country**\\n\\nFilter by country ISO code. Uses 3 letter country code (ISO 3166-1) standard.\\n\\nFilter by multiple countries with a comma separated list. E.g. `GBR,IRL`\\n","example":"GBR"},"BiasCountryIsoParam":{"name":"bias_country_iso","in":"query","style":"form","explode":false,"description":"**Bias by Country**\\nBias by country ISO code. Uses 3 letter country code (ISO 3166-1) standard.\\nBias by multiple countries with a comma separated list. E.g. `GBR,IRL`","example":"GBR","schema":{"type":"string"}},"LicenseePathParam":{"name":"licensee","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"example":"sl_hk71kco54zGSGvF9eXXrvvnMOLLNh","description":"**Licensee Key**\\n\\nUniquely identifies a licensee.\\n"},"ConfigParam":{"name":"config","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"description":"**Configuration Name**\\n\\nUser-provided configuration object name.\\n","example":"idpc-be"}},"schemas":{"Dataset":{"title":"Dataset","type":"string","description":"Indicates the provenance of an address.","enum":["paf","pafw","pafa","mr","nyb","usps","ecaf","ecad","ab","abp","herewe","heret","heresa","hereo","herena","heremeas","heremea","herem","herei","herehk","hereee","hereap","gnaf","kadaster","kartverket","sdfi","cannar","fodbosa","mois","upujp","bev","ban","swt"]},"ErrorResponse":{"title":"Basic Error Response","type":"object","required":["code","message"],"properties":{"code":{"type":"integer","description":"API Response Code. Non `2xxx` code indicates a failure. This code will provide a more specific reason when a failure occurs and facilitates debugging.","format":"int32"},"message":{"type":"string","description":"Human readable error message supplied with every error response."}}},"ID":{"title":"Address Identifier","type":"string","description":"Global unique internally generated identifier for an address"},"CountryISO":{"title":"ISO Country Code (3)","type":"string","description":" 3 letter country code (ISO 3166-1)\\n","enum":["GBR","IMN","JEY","GGY","USA","PRI","GUM","IRL","VAT","FRA","GRL","NLD","LUX","AUT","GIB","LIE","FIN","ISL","CHE","PRT","BEL","MCO","ITA","FRO","NOR","DNK","SMR","MLT","AND","SWE","DEU","ESP","SJM","BRN","IDN","KHM","MMR","MYS","PHL","SGP","THA","TLS","VNM","ALB","ARM","AZE","BGR","BIH","BLR","CYP","CZE","EST","GEO","GRC","HRV","HUN","KAZ","KGZ","LTU","LVA","MDA","MKD","MNE","POL","ROU","RUS","SRB","SVK","SVN","TUR","UKR","UZB","XKX","HKG","BGD","IND","LKA","MAC","AGO","ARE","BFA","BHR","BWA","CMR","EGY","GHA","ISR","JOR","KEN","KWT","LBN","LSO","MAR","MOZ","MUS","MYT","NAM","NGA","OMN","QAT","REU","SAU","SEN","SWZ","TUN","ZAF","ZMB","ZWE","BHS","BLZ","BMU","CAN","CRI","CYM","DOM","GTM","HND","HTI","JAM","MEX","NIC","PAN","SLV","VGB","AUS","CCK","CXR","FJI","NCL","NFK","NZL","PYF","TON","VUT","ABW","ARG","BLM","BOL","BRA","BRB","CHL","COL","CUW","DMA","ECU","GLP","GUF","GUY","MAF","MTQ","PER","PRY","SUR","TTO","URY","VEN","TWN","CHN","JPN","KOR","LAO","MNG","PNG","PRK","SLB","TJK","TKM","BTN","IOT","MDV","NPL","PAK","AFG","BDI","BEN","CAF","CIV","COD","COG","COM","CPV","DJI","DZA","ERI","ESH","ETH","GAB","GIN","GMB","GNB","GNQ","IRN","IRQ","LBR","LBY","MDG","MLI","MRT","MWI","NER","RWA","SHN","SLE","SOM","SSD","STP","SYC","TCD","TGO","TZA","UGA","SDN","SYR","YEM","CUB","SPM","TCA","COK","KIR","NIU","NRU","PCN","TKL","TUV","WLF","WSM","AIA","ATG","BES","FLK","GRD","KNA","LCA","MSR","SGS","SXM","VCT","ASM","FSM","MHL","MNP","PLW","VIR"]},"CountryISO2":{"title":"ISO Country Code (2)","type":"string","description":" 2 letter country code (ISO 3166-1)\\n","enum":["GB","IM","JE","GG","US","PR","GU","IE","VA","FR","GL","NL","
1LU","AT","GI","LI","FI","IS","CH","PT","BE","MC","IT","FO","NO","DK","SM","MT","AD","SE","DE","ES","SJ","BS","BZ","BM","CA","CR","KY","DO","GT","HN","HT","JM","MX","NI","PA","SV","VG","AU","CC","CX","FJ","NC","NF","NZ","PF","TO","VU","AW","AR","BL","BO","BR","BB","CL","CO","CW","DM","EC","GP","GD","GF","GY","MF","MQ","PE","PY","SR","TT","UY","VE","TW","BN","ID","KH","MM","MY","PH","SG","TH","TL","VN","AL","AM","AZ","BG","BA","BY","CY","CZ","EE","GE","GR","HR","HU","KZ","KG","XK","LT","LV","MD","MK","ME","PL","RO","RU","RS","SK","SI","TR","UA","UZ","HK","BD","IN","LK","MO","AO","AE","BF","BH","BW","CM","EG","GH","IL","JO","KE","KW","LB","LS","MA","MZ","MU","YT","NA","NG","OM","QA","RE","SA","SN","SZ","TN","ZA","ZM","ZW","CN","JP","KR","LA","MN","PG","KP","SB","TJ","TM","BT","IO","MV","NP","PK","AF","BI","BJ","CF","CI","CD","CG","KM","CV","DJ","DZ","ER","EH","ET","GA","GN","GM","GW","GQ","IR","IQ","LR","LY","MG","ML","MR","MW","NE","RW","SH","SL","SO","SS","ST","SC","TD","TG","TZ","UG","SD","SY","YE","CU","PM","TC","CK","KI","NU","NR","PN","TK","TV","WF","WS","AI","AG","BQ","FK","KN","LC","MS","GS","SX","VC","AS","FM","MH","MP","PW","VI"]},"Country":{"title":"Country","type":"string","description":" Full country names (ISO 3166)\\n","enum":["United Kingdom","England","Scotland","Wales","Northern Ireland","Isle of Man","Jersey","Guernsey","Channel Islands","Guam","United States","Puerto Rico","Ireland","Vatican City","France","Greenland","Netherlands","Luxembourg","Austria","Gibraltar","Liechtenstein","Finland","Iceland","Switzerland","Portugal","Belgium","Monaco","Italy","Faroe Islands","Norway","Denmark","San Marino","Malta","Andorra","Sweden","Germany","Spain","Svalbard and Jan Mayen","Bahamas","Belize","Bermuda","Canada","Costa Rica","Cayman Islands","Dominican Republic","Guatemala","Honduras","Haiti","Jamaica","Mexico","Nicaragua","Panama","El Salvador","British Virgin Islands","Australia","Cocos (Keeling) Islands","Christmas Island","Fiji","New Caledonia","Norfolk Island","New Zealand","French Polynesia","Tonga","Vanuatu","Aruba","Argentina","Saint Barth\xe9lemy","Bolivia","Brazil","Barbados","Chile","Colombia","Cura\xe7ao","Dominica","Ecuador","Guadeloupe","Grenada","French Guiana","Guyana","Saint Martin (French part)","Martinique","Peru","Paraguay","Suriname","Trinidad and Tobago","Uruguay","Venezuela","Taiwan","Brunei Darussalam","Indonesia","Cambodia","Myanmar","Malaysia","Philippines","Singapore","Thailand","Timor-Leste","Vietnam","Albania","Armenia","Azerbaijan","Bulgaria","Bosnia and Herzegovina","Belarus","Cyprus","Czech Republic","Estonia","Georgia","Greece","Croatia","Hungary","Kazakhstan","Kyrgyzstan","Kosovo","Lithuania","Latvia","Moldova","North Macedonia","Montenegro","Poland","Romania","Russia","Serbia","Slovakia","Slovenia","Turkey","Ukraine","Uzbekistan","Hong Kong","Bangladesh","India","Sri Lanka","Macau","Angola","United Arab Emirates","Burkina Faso","Bahrain","Botswana","Cameroon","Egypt","Ghana","Israel","Jordan","Kenya","Kuwait","Lebanon","Lesotho","Morocco","Mozambique","Mauritius","Mayotte","Namibia","Nigeria","Oman","Qatar","R\xe9union","Saudi Arabia","Senegal","Eswatini","Tunisia","South Africa","Zambia","Zimbabwe","China","Japan","South Korea","Laos","Mongolia","Papua New Guinea","North Korea","Solomon Islands","Tajikistan","Turkmenistan","Bhutan","British Indian Ocean Territory","Maldives","Nepal","Pakistan","Afghanistan","Burundi","Benin","Central African Republic","C\xf4te d\'Ivoire","Democratic Republic of the Congo","Republic of the Congo","Comoros","Cape Verde","Djibouti","Algeria","Eritrea","Western Sahara","Ethiopia","Gabon","Guinea","Gambia","Guinea-Bissau","Equatorial Guinea","Iran","Iraq","Liberia","Libya","Madagascar","Mali","Mauritania","Malawi","Niger","Rwanda","Saint Helena","Sierra Leone","Somalia","South Sudan","S\xe3o Tom\xe9 and Pr\xedncipe","Seychelles","Chad","Togo","Tanzania","Uganda","Sudan","Syria","Yemen","Cuba","Saint Pierre and Miquelon","Turks and Caicos Islands","Cook Islands","Kiribati","Niue","Nauru","Pitcairn Islands","Tokelau","Tuvalu","Wallis and Futuna","Samoa","Anguilla","Antigua and Barbuda","Bonaire, Sint Eustatius and Saba","Falkland Islands (Malvinas)","Saint Kitts and Nevis","Saint Lucia","Montserrat","South Georgia and the South Sandwich Islands","Sint Maarten (Dutch part)","Saint Vincent and the Grenadines","American Samoa","Federated States of Micronesia","Marshall Islands","Northern Mariana Islands","Palau","United States Virgin Islands"]},"Language":{"title":"Language","type":"string","description":"Language represented by 2 letter ISO Code (639-1)\\n","enum":["en","ar","as","az","be","bg","bn","b
1s","ca","cs","cy","da","de","el","es","et","eu","fi","fo","fr","ga","gl","gn","he","hi","hr","hu","hy","id","is","it","ja","ka","kk","km","kn","ko","lt","lv","mk","mn","ms","mt","my","nl","no","pl","pt","rm","ro","ru","sk","sl","sq","sr","sv","ta","th","tr","uk","uz","vi","wa","zh"]},"Longitude":{"title":"Longitude","description":"The longitude of the address or postcode (WGS84).\\n\\nCan be a positive or negative decimal. E.g. -0.1283983\\n\\nReturns an empty string if no location data is available.","oneOf":[{"type":"string","description":"Empty string `\\"\\"` if not available"},{"type":"number","description":"Represents longitude","minimum":-180,"maximum":180}]},"Latitude":{"title":"Latitude","description":"The latitude of the address or postcode (WGS84).\\n\\nCan be a positive or negative decimal. E.g. `51.5083983`.\\n\\nReturns an empty string if no location data is available.","oneOf":[{"type":"string","description":"Empty string `\\"\\"` if not available"},{"type":"number","description":"Represents latitude","minimum":-90,"maximum":90}]},"Eastings":{"title":"Eastings","description":"Eastings reference using the [Ordnance Survey National Grid reference system](https://en.wikipedia.org/wiki/Ordnance_Survey_National_Grid).\\n\\nNorthern Ireland Eastings uses the [Irish Grid Reference System](https://en.wikipedia.org/wiki/Irish_grid_reference_system).\\n\\nMetres from origin. E.g. `550458`\\n\\nReturns an empty string if no location data is available. Otherwise a number is returned.","oneOf":[{"type":"string","description":"Empty string `\\"\\"` if not available"},{"type":"number","description":"Metres offset east from origin","minimum":0,"maximum":999999}]},"Northings":{"title":"Northings","description":"Northings reference using the [Ordnance Survey National Grid reference system](https://en.wikipedia.org/wiki/Ordnance_Survey_National_Grid)\\n\\nNorthern Ireland Northings uses the [Irish Grid Reference System](https://en.wikipedia.org/wiki/Irish_grid_reference_system)\\n\\nMetres from origin. E.g. `180458`\\n\\nReturns an empty string if no location data is available. Otherwise a number is returned ","oneOf":[{"type":"string","description":"Empty string `\\"\\"` if not available"},{"type":"number","description":"Metres offset north from origin","minimum":0,"maximum":999999}]},"AbAddress":{"title":"AddressBase Core Address","description":"An address from Ordnance Survey\'s AddressBase Core, a flat cut of the approved addresses in Great Britain. Each record is one UPRN drawn from the local authority gazetteers: the National Land and Property Gazetteer for England and Wales, the One Scotland Address Gazetteer for Scotland. It carries the Royal Mail delivery point where one has been matched, property level coordinates, a classification (`classification_code`), the key identifiers (`uprn`, `parent_uprn`, `udprn`, `usrn`, `toid`), the contributing authority (`gss_code`), coordinate quality (`rpc`) and the change the latest supply applied (`change_code`). Ordnance Survey publishes around 35 million records and refreshes them weekly.\\n\\nHow it differs from the neighbouring datasets:\\n\\n- **AddressBase Premium** (`abp`) is the full gazetteer: around 40 million UPRNs including historic and provisional records, the local authority address breakdown (`pao_*`, `sao_*`), lifecycle (`logical_status`, `blpu_state`), Welsh alternatives, the street record and cross references to the Valuation Office Agency and ONS, refreshed every six weeks. AddressBase Core carries none of these. Use it when one approved address per UPRN, with coordinates and a classification, is enough.\\n- **Royal Mail PAF** (`paf`) lists delivery points only, keyed by UDPRN. AddressBase Core keys on UPRN and also holds non-postal objects (substations, car parks, land parcels, parent shells) with no delivery point. On those records `udprn` is `0` and `delivery_point_suffix` is empty. Where a record matches PAF, `ab` renders the same `line_1` to `line_3` as `paf` for that UDPRN, bar a handful of records with a trailing range in the building name, which AddressBase Core keeps whole.\\n- The Ordnance Survey end of life notice for autumn 2027 covers AddressBase and AddressBase Plus, not AddressBase Core.\\n","type":"object","required":["id","country_iso","dataset","language","line_1","line_2","line_3","premise","uprn","udprn","parent_uprn","usrn","toid","classification_code","eastings","northings","latitude","longitude","single_address_line","street_name","locality","town_name","delivery_point_suffix","post_town","gss_code","rpc","last_update_date","island","change_code","building_name","building_number","sub_building","postcode","po_box","organisation","country","county","district","
1ward","traditional_county","administrative_county","postal_county"],"properties":{"id":{"$ref":"#/components/schemas/ID"},"country_iso":{"title":"ISO Country Code (3)","type":"string","description":" 3 letter country code (ISO 3166-1)\\n"},"dataset":{"title":"Dataset","type":"string","description":"Indicates the provenance of an address","enum":["ab"]},"language":{"$ref":"#/components/schemas/Language"},"line_1":{"title":"Line 1","type":"string","description":"First Address Line. Often contains premise and thoroughfare information. In the case of a commercial premise, the first line is always the full name of the registered organisation. Never empty."},"line_2":{"title":"Line 2","type":"string","description":"Second Address Line. Often contains thoroughfare and locality information. May be empty"},"line_3":{"title":"Line 3","type":"string","description":"Third address line. Takes the address elements left after `line_1` and `line_2` are filled; where the address needs more than three lines the remaining elements are joined into `line_3`, comma separated. May be empty."},"premise":{"title":"Premise","type":"string","description":"A pre-computed string which sensibly combines the building name, sub-building and building number fields into a single, simple premise string. Ideal if you want to pull premise information and thoroughfare information separately instead of using the address lines."},"uprn":{"title":"UPRN","type":"string","maxLength":16,"description":"Unique Property Reference Number (UPRN) assigned by the LLPG Custodian or Ordnance Survey."},"udprn":{"title":"UDPRN","type":"integer","description":"Royal Mail\'s Unique Delivery Point Reference Number (UDPRN). `0` where the record has no matching PAF delivery point."},"parent_uprn":{"title":"PARENT_UPRN","type":"string","maxLength":16,"description":"UPRN of the parent record where a parent-child relationship exists. Empty where the record has no parent."},"usrn":{"title":"USRN","type":"integer","description":"Unique Street Reference Number assigned by the Street Name and Numbering Custodian or by Ordnance Survey, depending on the address record."},"toid":{"title":"TOID","type":"string","maxLength":20,"description":"The Topographic Identifier taken from OS MasterMap Topography Layer. This TOID is assigned to the UPRN by performing a spatial intersection between the two identifiers. It consists of the letters \'osgb\' followed by up to sixteen digits. May be empty."},"classification_code":{"title":"Classification Code","type":"string","maxLength":4,"description":"A code that describes the classification of the address record to a maximum of a secondary level. The first letter is the primary class (e.g. `R` residential, `C` commercial, `L` land), the second the secondary class (e.g. `RD` dwelling)."},"eastings":{"title":"Easting","type":"number","description":"A value in metres defining the x location in accordance with the British National Grid."},"northings":{"title":"Northing","type":"number","description":"A value in metres defining the y location in accordance with the British National Grid."},"latitude":{"title":"Latitude","type":"number","description":"A value defining the Latitude location in accordance with the ETRS89 coordinate reference system."},"longitude":{"title":"Longitude","type":"number","description":"A value defining the Longitude location in accordance with the ETRS89 coordinate reference system."},"single_address_line":{"title":"Single Line Address","type":"string","maxLength":500,"description":"A single attribute containing text concatenation of the address elements separated by a comma."},"street_name":{"title":"Street Name","type":"string","maxLength":100,"description":"Street / Road name for the address record."},"locality":{"title":"Locality","type":"string","maxLength":35,"description":"A locality defines an area or geographical identifier within a town, village or hamlet. Locality represents the lower level geographical area. The locality field should be used in conjunction with the town name and street description fields to uniquely identify geographic area where there may be more than one within an administrative area."},"town_name":{"title":"Town Name","type":"string","maxLength":35,"description":"Geographical town name assigned by the Local Authority. Note this can differ from the post town assigned by Royal Mail."},"delivery_point_suffix":{"title":"Delivery Point Suffix","type":"string","maxLength":2,"description":"A two-character code uniquely identifying an individual delivery point within a postcode, assigned by Royal Mail. May be empty."},"post_town":{"title":"Post Town","type":"string","maxLength":30,"description":"The town or city in which the Royal Mail sorting office servicing this address record is located.\\n\\nAddressBase populates `POST_TOWN` only where it differs from `TOWN_NAME`, so this field falls back to the town name when the raw value is empty."},"gss_code":{"title":"Governmental Statistical Service","type":"string","maxLength":9,"description":"The Office for National Statistics Governmental Statistical Service (GSS) code representing the contributing Local Authority."},"rpc":{"title":"Representative Point Code","type":"integer","description":"Representative Point Code describes the accuracy of the coordinate that has been allocated to the UPRN as indicated by the Local Authority and enhanced using large scale OS data."},"last_update_date":{"title":"Last Update Date","type":"string","format":"date-time","description":"The latest date on which any of the attributes on this record were last changed."},"island":{"title":"Island","type":"string","maxLength":50,"description":"Third level of geographic area name to record island names where appropriate. May be empty."},"change_code":{"title":"Change Code","type":"string","maxLength":1,"enum":["I","U","D"],"description":"The type of change last applied to the record. `I` insert, `U` update, `D` delete."},"building_name":{"title":"Building Name","type":"string","maxLength":110,"description":"The building name is a description applied to a single address or a group of addresses. May be empty."},"building_number":{"title":"Building Number","type":"string","maxLength":13,"description":"The building number is a number or range of numbers given to a single address or a group of addresses. May be empty."},"sub_building":{"title":"Sub-building","type":"string","maxLength":110,"description":"The sub-building name and/or number for the address record. May be empty."},"postcode":{"title":"Postcode","type":"string","maxLength":8,"description":"A postcode assigned by Royal Mail for the address record."},"po_box":{"title":"PO Box","type":"string","maxLength":13,"description":"Text concatenation of \'PO BOX\' and the Post Office Box (PO Box) number or \'BFPO\' and the British Forces Post Office number. May be empty."},"organisation":{"title":"Organisation","type":"string","maxLength":100,"description":"The organisation name is the business name given, when appropriate, to an address record. May be empty."},"country":{"title":"Country","type":"string","description":" Full country names (ISO 3166)\\n"},"county":{"title":"County","type":"string","description":"Since postal, administrative or traditional counties may not apply to some addresses, the county field is designed to return whatever county data is available. Normally, the postal county is returned. If this is not present, the county field will fall back to the administrative county. If the administrative county is also not present, the county field will fall back to the traditional county. May be empty in cases where no administrative, postal or traditional county present."},"district":{"title":"District","type":"string","description":"The current district/unitary authority to which the postcode has been assigned."},"ward":{"title":"Ward","type":"string","description":"The current administrative/electoral area to which the postcode has been assigned. May be empty for a small number of addresses."},"traditional_county":{"title":"Traditional County","type":"string","description":"Traditional counties are provided by the Association of British Counties. It is historical data, and can date from the 1800s. May be empty."},"administrative_county":{"title":"Administrative County","type":"string","description":"The current administrative county to which the postcode has been assigned.\\n\\nA Unitary Authority name, where one is present. If there is no Unitary Authority, the County name is used. This information is not static, because County boundaries may change due to administrative changes.\\n\\nSource: ONS. May be empty."},"postal_county":{"title":"Postal County","type":"string","description":"Postal counties were used for the distribution of mail before the Postcode system was introduced in the 1970s. The Former Postal County was the Administrative County at the time. This data rarely changes. May be empty."}},"example":{"id":"ab_10070014461","country_iso":"GBR","dataset":"ab","language":"en","line_1":"Flat 27","line_2":"Henry House","line_3":"Ringers Road","premise":"Flat 27, Henry House","uprn":"10070014461","udprn":53705246,"parent_uprn":"10070014435","usrn":20301384,"toid":"osgb5000005186746874","classification_code":"RD","eastings":540291,"northings":168873,"latitude":51.4015451,"longitude":0.0154405,"single_address_line":"Flat 27, Henry House, Ringers Road, Bromley, BR1 1AA","street_name":"Ringers Road","locality":"","town_name":"Bromley","delivery_point_suffix":"2H","post_town":"Bromley","gss_code":"E09000006","rpc":2,"last_update_date":"2020-01-06T00:00:00.000Z","island":"","change_code":"I","building_name":"Henry House","building_number":"","sub_building":"Flat 27","postcode":"BR1 1AA","po_box":"","organisation":"","country":"England","county":"Kent","district":"Bromley","ward":"Bromley Town","traditional_county":"Kent","administrative_county":"","postal_county":"Kent"}}
1,"AbpAddress":{"title":"AddressBase Premium Address","description":"A property record from Ordnance Survey\'s AddressBase Premium, Ordnance Survey\'s most detailed address dataset for Great Britain. Each record is a Basic Land and Property Unit (BLPU) keyed by its UPRN. Alongside the Royal Mail delivery point it carries the local authority address (`pao_*`, `sao_*`, `usrn`), classification (`classification_code`), lifecycle (`logical_status`, `blpu_state`), coordinates, Welsh alternatives (`welsh_*`), the street record (`street_*`) and cross references to OS MasterMap (`toid`), the Valuation Office Agency (`council_tax_ref`, `ndr_ref`) and ONS (`ons_ward_code`, `ons_parish_code`). Ordnance Survey publishes around 40 million records and refreshes them every six weeks.\\n\\nHow it differs from the neighbouring datasets:\\n\\n- **AddressBase Core** (`ab`) is a weekly, flat cut of the current approved records: one row per UPRN with coordinates, a two-character classification and the key identifiers. It carries no history, no provisional records, no Welsh alternatives, no local authority address breakdown and no street, VOA or ONS cross references.\\n- **Royal Mail PAF** (`paf`) lists delivery points, keyed by UDPRN. The vast majority of PAF addresses are matched to a UPRN, but there will always be a small number (~1%) with no corresponding record on AddressBase Premium. PAF holds around 30 million GB delivery points against AddressBase Premium\'s 40 million UPRNs; the difference is non-postal objects (substations, car parks, sites under construction), provisional and historic records. Every GB PAF delivery point appears here as the `dpa_*` record.\\n- **OS NGD Address** carries the same content restructured into feature types with daily currency. AddressBase Premium is not being retired. The Ordnance Survey end of life notice for autumn 2027 covers AddressBase and AddressBase Plus only.\\n","type":"object","required":["uprn","logical_status","country","latitude","longitude","x_coordinate","y_coordinate","local_custodian_code","addressbase_postal","postcode_locator","multi_occ_count","postcode","id","dataset","country_iso","suggestion_line"],"properties":{"uprn":{"title":"Unique Property Reference Number","type":"string","maxLength":12,"description":"Unique Property Reference Number - a persistent identifier for a Basic\\nLand and Property Unit (BLPU). Up to 12 digits. Primary key for the\\nBLPU spine. Carried as a string to preserve precision (12-digit values\\ncan exceed Number.MAX_SAFE_INTEGER).\\n"},"parent_uprn":{"title":"Parent UPRN","type":"string","maxLength":12,"nullable":true,"description":"UPRN of the parent record where a parent-child relationship exists\\n(flats sharing a building entrance, sub-units of a parent property).\\n"},"logical_status":{"title":"Logical Status Code","type":"integer","description":"Logical lifecycle status of the BLPU. `1` Approved, `6` Provisional,\\n`8` Historical. BLPU records do not take value `3` (alternative).\\n"},"blpu_state":{"title":"BLPU State Code","type":"string","nullable":true,"description":"Physical state of the BLPU. `1` Under construction, `2` In use,\\n`3` Unoccupied / vacant / derelict, `4` No longer existing,\\n`6` Planning permission granted.\\n"},"blpu_state_date":{"title":"BLPU State Date","type":"string","format":"date-time","nullable":true,"description":"Date the BLPU achieved its current state."},"country":{"title":"Country Code","type":"string","maxLength":1,"description":"Country containing the BLPU, determined by intersection with OS\\nBoundary-Line. `E` England, `W` Wales, `S` Scotland, `N` Northern\\nIreland, `L` Channel Islands, `M` Isle of Man, `J` not assigned to a\\ncountry.\\n"},"latitude":{"title":"Latitude (ETRS89)","type":"number","format":"double","minimum":-90,"maximum":90,"description":"Latitude coordinate in the ETRS89 coordinate reference system."},"longitude":{"title":"Longitude (ETRS89)","type":"number","format":"double","minimum":-180,"maximum":180,"description":"Longitude coordinate in the ETRS89 coordinate reference system."},"x_coordinate":{"title":"Eastings (OSGB36 British National Grid)","type":"number","format":"double","description":"X location in metres on the OSGB36 British National Grid\\n(precision 8, scale 2).\\n"},"y_coordinate":{"title":"Northings (OSGB36 British National Grid)","type":"number","format":"double","description":"Y location in metres on the OSGB36 British National Grid\\n(precision 9, scale 2).\\n"},"rpc":{"title":"Representative Point Code","type":"integer","nullable":true,"description":"Representative Point Code - reliability of the BLPU\'s coordinate, as\\nassessed by the local authority custodian. `1` Central internal,\\n`2` General internal, `3` Transitional, `4` Street location,\\n`5` Postcode unit, `9` Low accuracy.\\n"},"local_custodian_code":{"title":"Local Custodian Code","type":"integer","maximum":9999,"description":"4-digit identifier of the Local Authority responsible for maintaining\\nthe record.\\n"},"addressbase_postal":{"title":"AddressBase Postal Code","type":"string","maxLength":1,"description":"Whether the address can receive mail per AddressBase rules. `D` linked\\nto PAF, `N` not a postal address, `C` postal with a PAF-linked parent,\\n`L` postal based on Local Authority information.\\n"},"postcode_locator":{"title":"Postcode Locator","type":"string","maxLength":8,"description":"Royal Mail PAF postcode, locally assigned by the custodian, or\\nspatially derived where no PAF match exists. Up to 8 characters.\\n"},"multi_occ_count":{"title":"Multi-occupancy Count","type":"integer","maximum":9999,"description":"Count of child UPRNs for this record where parent-child relationships\\nexist.\\n"},"blpu_start_date":{"title":"BLPU Start Date","type":"string","format":"date-time","nullable":true,"description":"Date the address record was inserted into the database."},"blpu_end_date":{"title":"BLPU End Date","type":"string","format":"date-time","nullable":true,"description":"Date the address record was closed in the database."},"blpu_last_update_date":{"title":"BLPU Last Update Date","type":"string","format":"date-time","nullable":true,"description":"Date of the most recent attribute change on the BLPU record."},"blpu_entry_date":{"title":"BLPU Entry Date","type":"string","format":"date-time","nullable":true,"description":"Date the record was inserted into the Local Authority database."},"udprn":{"title":"Unique Delivery Point Reference Number","type":"string","maxLength":8,"nullable":true,"description":"Royal Mail\'s Unique Delivery Point Reference Number - primary key for\\nthe Delivery Point Address (DPA) record. Up to 8 digits. NULL for\\nnon-postal UPRNs.\\n"},"organisation_name":{"title":"Organisation Name","type":"string","maxLength":100,"nullable":true,"description":"Royal Mail-recognised organisation name from DPA, falling back to the\\nAddressBase Organisation record\'s `organisation` when DPA is absent.\\nTitle-cased.\\n"},"legal_name":{"title":"Legal Name","type":"string","maxLength":60,"nullable":true,"description":"Registered legal name from the AddressBase Organisation record."},"department_name":{"title":"Department Name","type":"string","maxLength":60,"nullable":true,"description":"Subdivision of an organisation that receives mail at a distinct\\ndelivery point. Requires `organisation_name` to be present.\\nTitle-cased.\\n"},"sub_building_name":{"title":"Sub-building Name","type":"string","maxLength":30,"nullable":true,"description":"Property subdivision identifier (e.g. flat number). Requires\\n`building_name` or `building_number`. Title-cased. Falls back to the\\nLPI\'s `sao_text` when there is no delivery point.\\n"},"building_name":{"title":"Building Name","type":"string","maxLength":50,"nullable":true,"description":"Descriptive name applied to a single building or small group of\\nbuildings. Title-cased. Falls back to the LPI\'s SAO number/range plus\\n`pao_text` when there is no delivery point.\\n"},"building_number":{"title":"Building Number","type":"integer","maximum":9999,"nullable":true,"description":"Numeric identifier for a single building or small group of buildings.\\nComplex number formats (e.g. \\"12A\\") go in `building_name` or\\n`sub_building_name`. Falls back to the LPI\'s `pao_start_number` when\\nthere is no delivery point and that number is a bare integer - a\\nsuffixed or ranged PAO number is folded onto `thoroughfare` instead.\\n"}
1,"dependent_thoroughfare":{"title":"Dependent Thoroughfare","type":"string","maxLength":80,"nullable":true,"description":"Named thoroughfare within another named thoroughfare. Requires\\n`thoroughfare` to be present. Title-cased.\\n"},"thoroughfare":{"title":"Thoroughfare","type":"string","maxLength":80,"nullable":true,"description":"Road, track or named access route with Royal Mail delivery points.\\nTitle-cased. Falls back to the LPI street\'s `street_description` (with a\\nsuffixed or ranged PAO number prefixed) when there is no delivery point.\\n"},"double_dependent_locality":{"title":"Double Dependent Locality","type":"string","maxLength":35,"nullable":true,"description":"Estate or area name used to distinguish similar thoroughfares within a\\ndependent locality. Requires `dependent_locality`. Title-cased.\\n"},"dependent_locality":{"title":"Dependent Locality","type":"string","maxLength":35,"nullable":true,"description":"Subdivision of a post town to differentiate same-name thoroughfares.\\nTitle-cased. Falls back to the LPI street\'s `street_locality` when there\\nis no delivery point.\\n"},"post_town":{"title":"Post Town","type":"string","maxLength":30,"nullable":true,"description":"Town or city of the Royal Mail sorting office serving this record.\\nCapitalised. Falls back to the LPI street\'s `street_town` when there is\\nno delivery point; NULL when neither is present.\\n"},"postcode":{"title":"Postcode","type":"string","maxLength":8,"description":"Royal Mail postcode from DPA, falling back to BLPU\'s `postcode_locator`\\nwhen no Royal Mail delivery point exists. Uppercased, with single space\\nbetween outward and inward portions.\\n"},"postcode_type":{"title":"Postcode Type Code","type":"string","maxLength":1,"nullable":true,"description":"Royal Mail postal-user category. `S` Small user (e.g. a residential\\nproperty), `L` Large user (e.g. a large commercial company).\\n"},"delivery_point_suffix":{"title":"Delivery Point Suffix","type":"string","maxLength":2,"nullable":true,"description":"Two-character code uniquely identifying an individual delivery point\\nwithin a postcode (Royal Mail DPS).\\n"},"po_box_number":{"title":"PO Box Number","type":"string","maxLength":6,"nullable":true,"description":"Post Office Box number."},"welsh_dependent_thoroughfare":{"title":"Welsh Dependent Thoroughfare","type":"string","maxLength":80,"nullable":true,"description":"Welsh translation of `dependent_thoroughfare`. Requires `welsh_thoroughfare`."},"welsh_thoroughfare":{"title":"Welsh Thoroughfare","type":"string","maxLength":80,"nullable":true,"description":"Welsh translation of `thoroughfare`."},"welsh_double_dependent_locality":{"title":"Welsh Double Dependent Locality","type":"string","maxLength":36,"nullable":true,"description":"Welsh translation of `double_dependent_locality`. Requires `welsh_dependent_locality`."},"welsh_dependent_locality":{"title":"Welsh Dependent Locality","type":"string","maxLength":35,"nullable":true,"description":"Welsh translation of `dependent_locality`."},"welsh_post_town":{"title":"Welsh Post Town","type":"string","maxLength":30,"nullable":true,"description":"Welsh translation of `post_town`."},"dpa_process_date":{"title":"DPA Process Date","type":"string","format":"date-time","nullable":true,"description":"Date the PAF record was processed into the database."},"dpa_start_date":{"title":"DPA Start Date","type":"string","format":"date-time","nullable":true,"description":"Date the address record was matched to the Delivery Point Address."},"dpa_end_date":{"title":"DPA End Date","type":"string","format":"date-time","nullable":true,"description":"Date the PAF record no longer existed in the database."},"dpa_last_update_date":{"title":"DPA Last Update Date","type":"string","format":"date-time","nullable":true,"description":"Date any attribute on the DPA record was last changed."},"dpa_entry_date":{"title":"DPA Entry Date","type":"string","format":"date-time","nullable":true,"description":"Date the PAF record was first loaded by GeoPlace."},"classification_code":{"title":"Classification Code","type":"string","maxLength":6,"nullable":true,"description":"Current AddressBase classification code (e.g. `RD` residential,\\n`CR` commercial retail). Top-level categories: `R` Residential,\\n`C` Commercial, `L` Land, `M` Military, `O` Other, `P` Parent shell,\\n`U` Unclassified, `X` Dual use, `Z` Object of interest. NULL when no\\ncurrent classification row exists for the UPRN.\\n"},"class_scheme":{"title":"Classification Scheme","type":"string","maxLength":60,"nullable":true,"description":"Name of the classification scheme applied to this record."},"scheme_version":{"title":"Classification Scheme Version","type":"number","nullable":true,"description":"Version number of the classification scheme in use (e.g. `1.0`)."},"classification_start_date":{"title":"Classification Start Date","type":"string","format":"date-time","nullable":true,"description":"Date the classification record was first loaded into the database."}
1,"classification_end_date":{"title":"Classification End Date","type":"string","format":"date-time","nullable":true,"description":"Date the classification record ceased to exist."},"classification_last_update_date":{"title":"Classification Last Update Date","type":"string","format":"date-time","nullable":true,"description":"Date of the most recent attribute change on the classification record."},"classification_entry_date":{"title":"Classification Entry Date","type":"string","format":"date-time","nullable":true,"description":"Date the associated address record was inserted into the Local\\nAuthority database.\\n"},"organisation_start_date":{"title":"Organisation Start Date","type":"string","format":"date-time","nullable":true,"description":"Date the organisation record was initially loaded into the database."},"organisation_end_date":{"title":"Organisation End Date","type":"string","format":"date-time","nullable":true,"description":"Date the organisation record ceased to exist."},"organisation_last_update_date":{"title":"Organisation Last Update Date","type":"string","format":"date-time","nullable":true,"description":"Date of the most recent attribute change on the organisation record."},"organisation_entry_date":{"title":"Organisation Entry Date","type":"string","format":"date-time","nullable":true,"description":"Date the UPRN was entered into the Local Authority database."},"lpi_key":{"title":"LPI Key","type":"string","maxLength":14,"nullable":true,"description":"Unique identifier and primary key for the LPI record."},"lpi_language":{"title":"LPI Language Code","type":"string","maxLength":3,"nullable":true,"description":"Language used for this LPI record. `ENG` English, `CYM` Welsh,\\n`GAE` Gaelic (Scottish), `BIL` Bilingual.\\n"},"lpi_logical_status":{"title":"LPI Logical Status Code","type":"integer","nullable":true,"description":"Logical status of the LPI record. `1` Approved, `3` Alternative,\\n`6` Provisional, `8` Historical.\\n"},"lpi_start_date":{"title":"LPI Start Date","type":"string","format":"date-time","nullable":true,"description":"Date the LPI was first loaded into the database."},"lpi_end_date":{"title":"LPI End Date","type":"string","format":"date-time","nullable":true,"description":"Date the LPI record ceased to exist."},"lpi_last_update_date":{"title":"LPI Last Update Date","type":"string","format":"date-time","nullable":true,"description":"Date of the most recent attribute change on the LPI record."},"lpi_entry_date":{"title":"LPI Entry Date","type":"string","format":"date-time","nullable":true,"description":"Date the LPI record was inserted into the Local Authority database."},"sao_start_number":{"title":"SAO Start Number","type":"integer","maximum":9999,"nullable":true,"description":"Number of the Secondary Addressable Object, or range start. Requires\\n`pao_start_number` or `pao_text` to be present.\\n"},"sao_start_suffix":{"title":"SAO Start Suffix","type":"string","maxLength":2,"nullable":true,"description":"Suffix appended to `sao_start_number`. Requires `sao_start_number`."},"sao_end_number":{"title":"SAO End Number","type":"integer","maximum":9999,"nullable":true,"description":"End number of the SAO range. Requires `sao_start_number`."},"sao_end_suffix":{"title":"SAO End Suffix","type":"string","maxLength":2,"nullable":true,"description":"Suffix appended to `sao_end_number`. Requires `sao_end_number`."},"sao_text":{"title":"SAO Text","type":"string","maxLength":90,"nullable":true,"description":"Building name or description for the Secondary Addressable Object\\n(e.g. \\"FLAT 1\\", \\"UNIT B\\"). Requires `pao_start_number` or `pao_text`.\\n"},"pao_start_number":{"title":"PAO Start Number","type":"integer","maximum":9999,"nullable":true,"description":"Number of the Primary Addressable Object, or range start. Mandatory if\\n`pao_text` is absent.\\n"},"pao_start_suffix":{"title":"PAO Start Suffix","type":"string","maxLength":2,"nullable":true,"description":"Suffix appended to `pao_start_number`. Requires `pao_start_number`."},"pao_end_number":{"title":"PAO End Number","type":"integer","maximum":9999,"nullable":true,"description":"End number of the PAO range. Requires `pao_start_number`."},"pao_end_suffix":{"title":"PAO End Suffix","type":"string","maxLength":2,"nullable":true,"description":"Suffix appended to `pao_end_number`. Requires `pao_end_number`."},"pao_text":{"title":"PAO Text","type":"string","maxLength":90,"nullable":true,"description":"Building name or description for the Primary Addressable Object.\\nMandatory if `pao_start_number` is absent.\\n"},"usrn":{"title":"Unique Street Reference Number","type":"string","maxLength":8,"nullable":true,"description":"Unique Street Reference Number linking this LPI to its Street record.\\nUp to 8 digits.\\n"},"usrn_match_indicator":{"title":"USRN Match Indicator Code","type":"string","nullable":true,"description":"Confidence of the LPI to Street linkage. `1` Matched manually to the\\nnearest accessible Street, `2` Matched spatially to the nearest USRN.\\n"},"area_name":{"title":"Area Name","type":"string","maxLength":40,"nullable":true,"description":"Third-level geographic area name such as island or property group."},"level":{"title":"Level","type":"string","maxLength":30,"nullable":true,"description":"Vertical position of the property (e.g. \\"GROUND FLOOR\\")."},"official_flag":{"title":"Official Flag Code","type":"string","maxLength":1,"nullable":true,"description":"Whether the LPI corresponds to an entry in the official Street Name and\\nNumbering register. `Y` Official address, `N` Unofficial address.\\n"},"street_record_type":{"title":"Street Record Type Code","type":"integer","nullable":true,"description":"Description of the street record type. `1` Official designated Street\\nName, `2` Street Description, `3` Numbered Street, `4` Unofficial\\nStreet Description, `9` Description used for LLPG Acce
1ss.\\n"},"swa_org_ref_naming":{"title":"SWA Org Ref (Naming)","type":"integer","maximum":9999,"nullable":true,"description":"Code identifying the Street Naming and Numbering Authority or Local\\nHighway Authority (DfT-allocated).\\n"},"street_state":{"title":"Street State Code","type":"string","nullable":true,"description":"Current state of the street. `1` Under construction, `2` Open,\\n`4` Permanently closed.\\n"},"street_state_date":{"title":"Street State Date","type":"string","format":"date-time","nullable":true,"description":"Date when the street achieved its current state."},"street_surface":{"title":"Street Surface Code","type":"string","nullable":true,"description":"Surface finish of the street. `1` Metalled, `2` Unmetalled, `3` Mixed.\\n"},"street_classification":{"title":"Street Classification Code","type":"string","nullable":true,"description":"Primary classification of the street record. `4` Pedestrian way or\\nfootpath, `6` Cycletrack or cycleway, `8` All vehicles, `9` Restricted\\nbyway, `10` Bridleway.\\n"},"street_start_date":{"title":"Street Start Date","type":"string","format":"date-time","nullable":true,"description":"Date this street record or version was inserted into the database."},"street_last_update_date":{"title":"Street Last Update Date","type":"string","format":"date-time","nullable":true,"description":"Date when any attribute of the street record was last changed."},"street_record_entry_date":{"title":"Street Record Entry Date","type":"string","format":"date-time","nullable":true,"description":"Date the street record was entered into the Local Authority database."},"street_start_x":{"title":"Street Start Eastings","type":"number","format":"double","nullable":true,"description":"X coordinate (BNG) for the street start point."},"street_start_y":{"title":"Street Start Northings","type":"number","format":"double","nullable":true,"description":"Y coordinate (BNG) for the street start point."},"street_start_lat":{"title":"Street Start Latitude","type":"number","format":"double","nullable":true,"description":"Latitude (ETRS89) for the street start point."},"street_start_long":{"title":"Street Start Longitude","type":"number","format":"double","nullable":true,"description":"Longitude (ETRS89) for the street start point."},"street_end_x":{"title":"Street End Eastings","type":"number","format":"double","nullable":true,"description":"X coordinate (BNG) for the street end point."},"street_end_y":{"title":"Street End Northings","type":"number","format":"double","nullable":true,"description":"Y coordinate (BNG) for the street end point."},"street_end_lat":{"title":"Street End Latitude","type":"number","format":"double","nullable":true,"description":"Latitude (ETRS89) for the street end point."},"street_end_long":{"title":"Street End Longitude","type":"number","format":"double","nullable":true,"description":"Longitude (ETRS89) for the street end point."},"street_tolerance":{"title":"Street Tolerance","type":"integer","nullable":true,"description":"Accuracy of street-coordinate data capture, in metres."},"street_description":{"title":"Street Description","type":"string","maxLength":100,"nullable":true,"description":"Street name, description or street number."},"street_locality":{"title":"Street Locality","type":"string","maxLength":35,"nullable":true,"description":"Geographical area within a town."},"street_town":{"title":"Street Town","type":"string","maxLength":30,"nullable":true,"description":"Name of the town. Required for Street Record Types `1` and `2`;\\noptional for types `3`, `4` and `9`.\\n"},"adminstrative_area":{"title":"Administrative Area","type":"string","maxLength":30,"nullable":true,"description":"Local Highway Authority name (administrative area / county / unitary\\nauthority). Field name spelling preserved verbatim from OS\\n(`ADMINSTRATIVE_AREA`).\\n"},"sd_language":{"title":"Street Descriptor Language Code","type":"string","maxLength":3,"nullable":true,"description":"Language of the street descriptor. `ENG` English, `CYM` Welsh,\\n`GAE` Gaelic (Scottish), `BIL` Bilingual.\\n"},"sd_start_date":{"title":"Street Descriptor Start Date","type":"string","format":"date-time","nullable":true,"description":"Date the street descriptor record was first created in the database."},"sd_end_date":{"title":"Street Descriptor End Date","type":"string","format":"date-time","nullable":true,"description":"Date the street descriptor record ceased to exist."},"sd_last_update_date":{"title":"Street Descriptor Last Update Date","type":"string","format":"date-time","nullable":true,"description":"Date of the most recent attribute change on the street descriptor record."},"sd_entry_date":{"title":"Street Descriptor Entry Date","type":"string","format":"date-time","nullable":true,"description":"Date the street descriptor record was entered into the Local Authority\\ndatabase.\\n"},"toid":{"title":"TOID (Topography)","type":"string","maxLength":20,"nullable":true,"description":"OS MasterMap Topography Layer TOID (cross-reference source `7666MT`)\\nlinked to the UPRN.\\n"},"toid_address":{"title":"TOID (Address Layer)","type":"string","maxLength":20,"nullable":true,"description":"OS MasterMap Address Layer 2 TOID (cross-reference source `7666MA`)\\nlinked to the UPRN.\\n"},"toid_highways":{"title":"TOID (Highways)","type":"string","maxLength":20,"nullable":true,"description":"OS MasterMap Highways TOID (cross-reference source `7666MI`) linked to\\nthe UPRN.\\n"},"council_tax_ref":{"title":"Council Tax Reference","type":"string","maxLength":50,"nullable":true,"description":"Centrally created Valuation Office Agency council tax reference\\n(cross-reference source `7666VC`) linked to the UPRN.\\n"},"ndr_ref":{"title":"Non-Domestic Rates Reference","type":"string","maxLength":50,"nullable":true,"description":"Centrally created Valuation Office Agency non-domestic rates reference\\n(cross-reference source `7666VN`) linked to the UPRN.\\n"},"ons_ward_code":{"title":"ONS Ward Code","type":"string","maxLength":50,"nullable":true,"description":"Office for National Statistics ward code (cross-reference source\\n`7666OW`) linked to the UPRN.\\n"},"ons_parish_code":{"title":"ONS Parish Code","type":"string","maxLength":50,"nullable":true,"description":"Office for National Statistics parish code (cross-reference source\\n`7666OP`) linked to the UPRN.\\n"},"id":{"title":"Record ID","type":"string","description":"Stable identifier for the record, `abp_` prefixed to the UPRN. Accepted\\nby the resolve endpoints.\\n"},"dataset":{"title":"Dataset","type":"string","enum":["abp"],"description":"Dataset this record belongs to."},"country_iso":{"title":"Country ISO Code","type":"string","enum":["GBR"],"description":"ISO 3166-1 alpha-3 code for the country covered by the dataset. Always\\n`GBR` - use `country` for the England / Wales / Scotland split.\\n"},"suggestion_line":{"title":"Suggestion Line","type":"string","description":"Single-line address used for autocomplete suggestions: the address line\\ncomponents, then the post town, then the outward half of the postcode,\\ncomma separated. Repeated components are collapsed.\\n"}},"example":{"uprn":"49020496","parent_uprn":"49020495","logical_status":1,"blpu_state":"2","blpu_state_date":"2011-10-06T00:00:00.000Z","country":"W","latitude":52.4121999,"longitude":-4.0883772,"x_coordinate":258053.87,"y_coordinate":281405.95,"rpc":2,"local_custodian_code":6820,"addressbase_postal":"D","postcode_locator":"SY23 1JT","multi_occ_count":4,"blpu_start_date":"2007-10-24T00:00:00.000Z","blpu_end_date":null,"blpu_last_update_date":"2025-10-13T00:00:00.000Z","blpu_entry_date":"2006-11-24T00:00:00.000Z","udprn":"24255522","organisation_name":null,"legal_name":null,"department_name":null,"sub_building_name":null,"building_name":null,"building_number":1,"depen
1dent_thoroughfare":"Castle Terrace","thoroughfare":"South Road","double_dependent_locality":null,"dependent_locality":null,"post_town":"Aberystwyth","postcode":"SY23 1JT","postcode_type":"S","delivery_point_suffix":"1A","po_box_number":null,"welsh_dependent_thoroughfare":"HEOL Y CASTELL","welsh_thoroughfare":"TAN Y CAE","welsh_double_dependent_locality":null,"welsh_dependent_locality":null,"welsh_post_town":"ABERYSTWYTH","dpa_process_date":"2016-01-18T00:00:00.000Z","dpa_start_date":"2012-04-23T00:00:00.000Z","dpa_end_date":null,"dpa_last_update_date":"2016-02-10T00:00:00.000Z","dpa_entry_date":"2012-03-19T00:00:00.000Z","classification_code":"RD04","class_scheme":"AddressBase Premium Classification Scheme","scheme_version":1,"classification_start_date":"2007-10-24T00:00:00.000Z","classification_end_date":null,"classification_last_update_date":"2018-09-23T00:00:00.000Z","classification_entry_date":"2006-11-24T00:00:00.000Z","organisation_start_date":null,"organisation_end_date":null,"organisation_last_update_date":null,"organisation_entry_date":null,"lpi_key":"6820L000054880","lpi_language":"CYM","lpi_logical_status":1,"lpi_start_date":"2007-10-24T00:00:00.000Z","lpi_end_date":null,"lpi_last_update_date":"2025-09-26T00:00:00.000Z","lpi_entry_date":"2007-09-04T00:00:00.000Z","sao_start_number":null,"sao_start_suffix":null,"sao_end_number":null,"sao_end_suffix":null,"sao_text":null,"pao_start_number":1,"pao_start_suffix":null,"pao_end_number":null,"pao_end_suffix":null,"pao_text":"HEOL Y CASTELL","usrn":"47114724","usrn_match_indicator":"1","area_name":null,"level":null,"official_flag":"Y","street_record_type":1,"swa_org_ref_naming":6820,"street_state":"2","street_state_date":"1990-01-01T00:00:00.000Z","street_surface":"1","street_classification":null,"street_start_date":"2007-10-24T00:00:00.000Z","street_last_update_date":"2022-01-14T00:00:00.000Z","street_record_entry_date":"1998-07-14T00:00:00.000Z","street_start_x":257968,"street_start_y":281400,"street_start_lat":52.4121241,"street_start_long":-4.0896363,"street_end_x":258266,"street_end_y":281393,"street_end_lat":52.4121386,"street_end_long":-4.0852551,"street_tolerance":10,"street_description":"SOUTH ROAD","street_locality":null,"street_town":"ABERYSTWYTH","adminstrative_area":"CEREDIGION","sd_language":"ENG","sd_start_date":"2007-10-24T00:00:00.000Z","sd_end_date":null,"sd_last_update_date":"2016-02-06T00:00:00.000Z","sd_entry_date":"1998-07-14T00:00:00.000Z","toid":"osgb1000020592167","toid_address":"osgb1000002175099422","toid_highways":"osgb5000005181786114","council_tax_ref":null,"ndr_ref":null,"ons_ward_code":"W05001302","ons_parish_code":"W04000359","id":"abp_49020496","dataset":"abp","country_iso":"GBR","suggestion_line":"1 Castle Terrace South Road, Aberystwyth, SY23"}},"UspsAddress":{"title":"USPS Address","description":"The USPS ZIP + 4 record backing a `usps` address.\\nCarries the complete USPS field set for the delivery point, including elements the standard address format does not expose.","required":["id","dataset","country","country_iso","country_iso_2","language","primary_number","secondary_number","plus_4_code","line_1","line_2","last_line","zip_code","zip_plus_4_code","update_key_number","record_type_code","carrier_route_id","street_pre_directional_abbreviation","street_name","street_suffix_abbreviation","street_post_directional_abbreviation","building_or_firm_name","address_secondary_abbreviation","base_alternate_code","lacs_status_indicator","government_building_indicator","state_abbreviation","state","municipality_city_state_key","urbanization_city_state_key","preferred_last_line_city_state_key","county","city","city_abbreviation","preferred_city","city_state_name_facility_code","zip_classification_code","city_state_mailing_name_indicator","carrier_route_rate_sortation","finance_number","congressional_district_number","county_number"],"properties":{"id":{"$ref":"#/components/schemas/ID"},"dataset":{"title":"USA Dataset","type":"string","description":"Identifies the address as sourced from USPS","enum":["usps"]},"country":{"title":"Country","type":"string","description":" Full country names (ISO 3166)\\n","enum":["American Samoa","Federated States of Micronesia","Guam","Marshall Islands","Northern Mariana Islands","Palau","Puerto Rico","United States","United States Virgin Islands"]},"country_iso":{"title":"ISO Country Code (3)","type":"string","description":" 3 letter country code (ISO 3166-1)\\n","enum":["ASM","FSM","GUM","MHL","MNP","PLW","PRI","USA","VIR"]},"country_iso_2":{"title":"ISO Country Code (2)","type":"string","description":" 2 letter country code (ISO 3166-1)\\n","enum":["AS","FM","GU","MH","MP","PR","PW","US","VI"]},"language":{"title":"Language","type":"string","description":"Language represented by 2 letter ISO Code (639-1)\\n","enum":["en"]},"primary_number":{"title":"Primary Number","type":"string","description":"A house, rural route, contract box, or Post Office Box number. The numeric or alphanumeric component of an address preceding the street name. Often referred to as house number."},"secondary_number":{"title":"Secondary Number","type":"string","description":"Number of the sub unit, apartment, suite etc"},"plus_4_code":{"title":"Plus 4 Code","type":"string","description":"4 digit ZIP add-on code."},"line_1":{"title":"First Address Line","type":"string","description":"The primary delivery line (usually the street address) of the address."},"line_2":{"title":"Second Address Line","type":"string","description":"Secondary delivery line of the address. Typically populated if the first line is the firm or building name."},"last_line":{"title":"Last Line","type":"string","description":"Last line of the address comprising of city, state, zip code and zip+4"},"zip_code":{"title":"ZIP Code","type":"string","maxLength":5,"description":"A 5-digit code that identifies a specific geographic delivery area. ZIP Co
1des can represent an area within a state, or a single building or company that has a very high mail volume. "},"zip_plus_4_code":{"title":"ZIP + 4 Code","type":"string","maxLength":10,"description":"Nine-digit code that identifies a small geographic delivery area that is serviceable by a single carrier; appears in the last line of the address on a mail piece."},"update_key_number":{"title":"Update Key Number","type":"string","maxLength":10,"description":"Field that contains a number that uniquely identifies a record; used to identify the base record to which an add or delete transaction is being directed. The Update Key Number field is used only when applying transactions to the base file; it is not used in address matching and remains fixed for the life of the record. The field is alphanumeric and consists of the database segment code (V1, V2, W1, W2, X1, X2, Y1, Y2, Z1, or Z2) and eight characters containing an alphanumeric value ranging from 00000001 to AAAAAAAA."},"record_type_code":{"title":"Record Type Code","type":"string","maxLength":1,"description":"An alphabetic value that identifies the type of data in the record. - G = General delivery (5-Digit ZIP, ZIP + 4, and Carrier Route products) - H = High-rise (ZIP + 4 only) - F = Firm (ZIP + 4 only) - S = Street (5-Digit ZIP, ZIP + 4, and Carrier Route products) - P = PO Box (5-Digit ZIP, ZIP + 4, and Carrier Route products) - R = Rural route/contract (5-Digit ZIP, ZIP + 4, and Carrier Route products) - M = Multi-carrier (Carrier Route product only)","enum":["G","H","F","S","P","R","M",""]},"carrier_route_id":{"title":"Carrier Route ID","type":"string","maxLength":4,"description":"A 4 character ID identifying the postal route for the address.\\nThe first character indicates the route type. Specifically:\\n- \\"B\\" indicates PO Box\\n- \\"H\\" indicates highway\\n- \\"C\\" indicates city\\n- \\"G\\" indicates general\\n- \\"R\\" indicates rural"},"street_pre_directional_abbreviation":{"title":"Street Pre-Directional Abbreviation","type":"string","maxLength":2,"description":"A geographic direction that precedes the street name."},"street_name":{"title":"Street Name","type":"string","maxLength":28,"description":"The official name of a street as assigned by a local governing authority. The Street Name field contains only the street name and does not include directionals (EAST, WEST, etc.) or suffixes (ST, DR, BLVD, etc.). This element may also contain literals, such as PO BOX, GENERAL DELIVERY, USS, PSC, or UNIT."},"street_suffix_abbreviation":{"title":"Street Suffix Abbreviation","type":"string","maxLength":4,"description":"Code that is the standard USPS abbreviation for the trailing designator in a street address. "},"street_post_directional_abbreviation":{"title":"Street Post Directional Abbreviation","type":"string","maxLength":2,"description":"A geographic direction that follows the street name."},"building_or_firm_name":{"title":"Building or Firm Name","type":"string","maxLength":40,"description":"The name of a company, building, apartment complex, shopping center, or other distinguishing secondary address information.\\nThis field is normally used with firm and highrise records but may also contain literals such as \u201cPostmaster\u201d or \u201cUnited States Postal Service.\u201d"},"address_secondary_abbreviation":{"title":"Address Secondary Abbreviation","type":"string","maxLength":4,"description":"A descriptive code used to identify the type of address secondary range information in the Address Secondary Range field. \\nThis code may be useful in address matching, e.g., the secondary address numbers may indicate apartment, suite, or trailer numbers."},"base_alternate_code":{"title":"Base Alternate Code","type":"string","maxLength":1,"description":"Code that specifies whether a record is a base (preferred) or alternate record. \\nBase records (represented as \\"B\\") can represent a range of addresses or an individual address, such as a firm record, while alternate records (represented as \\"A\\") are individual delivery points. Base records are generally preferred over alternate records.\\nGovernment deliveries will only be listed on alternate records with the appropriate government building indicator (federal, state, or city) set.","enum":["A","B",""]},"lacs_status_indicator":{"title":"LACS Status Indicator","type":"string","maxLength":1,"description":"The Locatable Address Conversion Service (LACS) indicator describes records that have been converted to the LACS system (a product/system in a different USPS\xae product line that allows mailers to identify and convert a rural route address to a city-style address). Rural route and some city addresses are being modified to city-style addresses so that emergency services (e.g., ambulances, police) can find these addresses more efficiently.\\n- L = LACS address: The old (usually rural-route) address that has been converted for the LACS system.\\n- Blank = Not applicable","enum":["","L"]},"government_building_indicator":{"title":"Government Building Indicator","type":"string","maxLength":1,"description":"An alphabetic value that identifies the type of government agency at the delivery point and/or whether a firm is the only delivery at an address. For this purpose, \\"address\\" is defined as the complete delivery line (e.g., complete street address and, if included as part of the firm record, the secondary abbreviation and/or address secondary number).\\n- A = City government building - alternates only\\n- B = Federal government building - alternates only\\n- C = State government building - alternates only\\n- D = Firm only - base and alternates\\n- E = City government building and firm only - alternates only\\n- F = Federal government building and firm only - alternates only\\n- G = State government building and firm only - alternates only","enum":["","A","B","C","D","E","F","G"]},"state_abbreviation":{"title":"State Abbreviation","type":"string","maxLength":2,"description":"A 2-character abbreviation for the name of a state, U.S. territory, or armed forces ZIP Code designation. If APO/FPO/DPO, then the state abbreviation will be \u201cAA,\u201d \u201cAE,\u201d or \u201cAP.\u201d"},"state":{"title":"State","type":"string","description":"Full name of a state, U.S. territory, or armed forces ZIP Code designation."},"municipality_city_state_key":{"title":"Municipality City State Key","type":"string","maxLength":6,"description":"Municipality City State Key. Currently blank."},"urbanization_city_state_key":{"title":"Urbanization City State Key","type":"string","maxLength":6,"description":"An index to the City State file that provides the urbanization name for this delivery range."},"preferred_last_line_city_state_key":{"title":"Preferred Last Line City State Key","type":"string","maxLength":6,"description":"In the Carrier Route, Five-Digit ZIP Co
1de, Delivery Statistics, and ZIP + 4 products, an index to the City State product record that provides the preferred last-line name for this address range. In the City State product, the preferred last line city/state key contains the key value of a City State product record that has the default preferred or alternate preferred last-line key for a given ZIP Code."},"county":{"title":"County Name","type":"string","description":"The name of the county or parish in which the 5-digit ZIP Code resides. If APO/FPO/DPO, then the county name will be blank."},"city":{"title":"City Name","type":"string","description":"A valid city name for mailing purposes; appears in the last line of an address on a mail piece."},"city_abbreviation":{"title":"City State Name Abbreviation","type":"string","description":"A standard 13-character abbreviation for a city/state name. This field is only used for names that are greater than 13 characters in length and have a city/state mailing name indicator of \\"Y.\\" If the field is longer than 13 characters and the city/state mailing name indicator is \\"N,\\" the field will be blank."},"preferred_city":{"title":"Preferred Last Line City State Name","type":"string","description":"Field that contains the default preferred or alternate preferred last-line name for a ZIP Code."},"city_state_name_facility_code":{"title":"City State Name Facility Code","type":"string","maxLength":1,"description":"The type of locale identified in the city/state name. The facility may be a USPS facility, such as a post office, station, or branch, or it may be a non-postal place name. City/state name facility codes include the following:\\n- B = Branch\\n- C = Community post office (CPO)\\n- N = Non-postal community name, former USPS facility, or place name\\n- P = Post Office\\n- S = Station\\n- U = Urbanization","enum":["B","C","N","P","S","U","Y",""]},"zip_classification_code":{"title":"ZIP Classification Code","type":"string","maxLength":1,"description":"A field that describes the type of ZIP area that a 5-digit ZIP Code serves, e.g., a single educational institution, post office boxes only, or a single address that has unusually high mail volume or many different addresses. - M = Military ZIP Code - P = ZIP Code having only Post Office Boxes - U = Unique ZIP Code (ZIP assigned to a single organization) - Blank = Standard ZIP with many addresses assigned to it","enum":["","M","P","U"]},"city_state_mailing_name_indicator":{"title":"City State Mailing Name Indicator","type":"string","maxLength":1,"description":"Specifies whether or not the city state name can be used as a last line of address on a mail piece.\\n- \\"Y = City/state name is a USPS-approved mailing name.\\"\\n- \\"N = City/state name is not approved for mailing purposes.\\""},"carrier_route_rate_sortation":{"title":"Carrier Route Rate Sortation and Merged 5-Digit Indicator","type":"string","maxLength":1,"description":"Identifies where automation Carrier Route rates are available and where the commingling of automation and non-automation mail, including Enhanced Carrier Routes and 5-digit presort, on the same pallet or in the same container is allowed."},"finance_number":{"title":"Finance Number","oneOf":[{"type":"string","description":"Empty string `\\"\\"` if not available"},{"type":"number","description":"Finance Number"}],"description":"A code assigned to Postal Service facilities (primarily Post Offices) to collect cost and statistical data and compile revenue and expense data."},"congressional_district_number":{"title":"Congressional District Number","oneOf":[{"type":"string","description":"Empty string `\\"\\"` if not available"},{"type":"number","description":"Congressional district number"}],"description":"A standard value identifying a geographic area within the United States served by a member of the U.S. House of Representatives. If Army/Air Force (APO), Fleet Post Office (FPO), or Diplomatic/Defense Post Office (DPO), this field will be blank. If there is only one member of Congress within a state, the code will be \\"AL\\" (at large)."},"county_number":{"title":"County Number","oneOf":[{"type":"string","description":"Empty string `\\"\\"` if not available"},{"type":"number","description":"FIPS code"}],"description":"The Federal Information Processing Standard (FIPS) code assigned to a given county or parish within a state. In Alaska, it identifies a region within the state. If APO/FPO/DPO, and the record type is \u201cS,\u201d \u201cH,\u201d or \u201cF,\u201d the county number will be blank."}},"example":{"id":"usps_V124884241|1040||0001","dataset":"usps","country":"United States","country_iso":"USA","country_iso_2":"US","language":"en","primary_number":"1040","secondary_number":"","plus_4_code":"0001","line_1":"
11040 Waverly Ave","line_2":"","last_line":"Holtsville NY 00501-0001","zip_code":"00501","zip_plus_4_code":"00501-0001","update_key_number":"V124884241","record_type_code":"S","carrier_route_id":"C000","street_pre_directional_abbreviation":"","street_name":"Waverly","street_suffix_abbreviation":"Ave","street_post_directional_abbreviation":"","building_or_firm_name":"","address_secondary_abbreviation":"","base_alternate_code":"B","lacs_status_indicator":"","government_building_indicator":"","state_abbreviation":"NY","state":"New York","municipality_city_state_key":"","urbanization_city_state_key":"","preferred_last_line_city_state_key":"V13916","county":"Suffolk","city":"Holtsville","city_abbreviation":"","preferred_city":"Holtsville","city_state_name_facility_code":"P","zip_classification_code":"U","city_state_mailing_name_indicator":"Y","carrier_route_rate_sortation":"C","finance_number":353910,"congressional_district_number":2,"county_number":103}},"EircBase":{"title":"Ireland Eircode Address","description":"Address elements shared by every Eircode (GeoDirectory) dataset. Not returned on its own - see `EcafAddress` and `EcadAddress`.\\n\\nUnavailable elements are returned as an empty string, never `null`.","type":"object","required":["id","dataset","country","country_iso","country_iso_2","language","longitude","latitude","department","organisation","sub_building_name","building_name","building_number","building_group","primary_thoroughfare","secondary_thoroughfare","primary_locality","secondary_locality","tertiary_locality","post_county","eircode","line_1","line_2","line_3","line_4","line_5","line_6","line_7","line_8","line_9","address_reference"],"properties":{"id":{"$ref":"#/components/schemas/ID"},"dataset":{"type":"string","description":"Source of address"},"country_iso":{"type":"string","description":" 3 letter country code (ISO 3166-1)\\n","enum":["IRL"]},"country_iso_2":{"type":"string","description":" 2 letter country code (ISO 3166-1)\\n","enum":["IE"]},"country":{"type":"string","description":" Full country names (ISO 3166)\\n","enum":["Ireland"]},"language":{"type":"string","enum":["en","ga"],"description":"Language represented by 2 letter ISO Code (639-1)\\n"}
1,"line_1":{"description":"Address Line 1","type":"string","maxLength":200,"minLength":0},"line_2":{"description":"Address Line 2","type":"string","maxLength":200,"minLength":0},"line_3":{"description":"Address Line 3","type":"string","maxLength":200,"minLength":0},"line_4":{"description":"Address Line 4","type":"string","maxLength":200,"minLength":0},"line_5":{"description":"Address Line 5","type":"string","maxLength":200,"minLength":0},"line_6":{"description":"Address Line 6","type":"string","maxLength":200,"minLength":0},"line_7":{"description":"Address Line 7","type":"string","maxLength":200,"minLength":0},"line_8":{"description":"Address Line 8","type":"string","maxLength":200,"minLength":0},"line_9":{"description":"Address Line 9","type":"string","maxLength":200,"minLength":0},"department":{"type":"string","maxLength":60,"minLength":0,"description":"The department or division within an organisation, e.g. `Accounts Department`. If the department element exists, then the organisation must also exist."},"organisation":{"type":"string","description":"Organisation name, e.g. `Oak Tree Limited`.","maxLength":60,"minLength":0},"sub_building_name":{"type":"string","maxLength":60,"minLength":0,"description":"The sub-building refers to an apartment, flat or unit within a building, e.g. `Flat 1`."},"building_name":{"type":"string","maxLength":60,"minLength":0,"description":"The name given to the building, e.g. `Rose Cottage`. Prepended by sub building, if any, when the sub building does not appear on a line to itself. The building name is omitted if it is the same as either the Organisation or Building Group."},"building_number":{"type":"string","maxLength":40,"minLength":0,"description":"A number associated with the whole building. The building number may have a numeric and an alphanumeric component, which are concatenated e.g. 2A, or alternatively will have a simple building number or a complex building number. The building number always relates to the whole building and not a sub-unit within it.\\nA complex building number may be one of the following:\\n - Dual. Two number separated by \'/\' e.g. 63/64 = 63, 64\\n - Sequence. An odd or even sequence of numbers with lower and upper bound separated by an underscore \'_\' e.g. `1_5` = 1,3,5 and `2_6` = 2,4,6\\n - Range. A range of consecutive numbers with lower and upper bound separated by a dash \'-\' e.g. `63-66` = 63, 64, 56, 66\\nThe building number never appears on a line by itself and can prepend Building Group, Primary Thoroughfare or Primary Locality."},"building_group":{"type":"string","maxLength":60,"minLength":0,"description":"A building group is a collection of buildings with a collective name, located on or near the same thoroughfare, e.g. `Marrian Terrace`."},"primary_thoroughfare":{"type":"string","maxLength":40,"minLength":0,"description":"The name of the thoroughfare on which premises are located, e.g. `Griffith Road`. It may appear on a line by itself or be appended to either a sub building or building number.\\n\\nAddresses with thoroughfares can sometimes have the thoroughfare excluded where a Building Group exists, such as a Retail Centre or Business Park, and the thoroughfare is not part of the Postal Address."},"secondary_thoroughfare":{"type":"string","maxLength":40,"minLength":0,"description":"It is never present without a primary thoroughfare. The primary thoroughfare is dependent on the secondary thoroughfare and appears before the secondary thoroughfare in any address.\\n\\nSecondary thoroughfare are generally used to assist locating a primary thoroughfare."},"primary_locality":{"type":"string","maxLength":40,"minLength":0,"description":"First locality elements which can refer to areas, districts, industrial estates, towns, etc.\\n\\nThe primary locality refers to the specific place the address is.\\n\\nIn urban areas, the primary locality can be required to distinguish between two thoroughfares of the same name in the same district or town. Industrial estates with named thoroughfares are also held as localities. In rural areas the primary locality is generally a townland name."},"secondary_locality":{"type":"string","maxLength":40,"minLength":0,"description":"Never present without a primary locality. The secondary locality has a wider geographic scope than the primary locality.\\n\\nIt is the secondary locality therefore which differentiates addresses with the same primary locality name within the same county.\\n\\nSecondary localities are more likely to be required for rural addresses.\\n\\nSecond locality elements which can refer to areas, districts, industrial estates, towns, etc\\n\\nThe secondary locality helps identify where the primary locality is located."},"tertiary_locality":{"type":"string","maxLength":40,"minLength":0,"description":"Also known as the Post Town.\\n\\nThe name of the post town associated with the premises for postal delivery purposes. This includes Dublin Postal Districts \\"Dublin 1\\" to \\"Dublin 24\\".\\n\\nThe post town is a significant element of the Postal Address, however it is not always populated in an address. The official post office guide, Eola\xed an Phoist, describes post towns in the following manner:\\n\\
1n\\"A provincial postal address may include the name of a town or village several miles distant, with which the addressee has little or no connection, and, in some places, especially if this residence happens to be near a county boundary, the name of the neighbouring county instead of the county in which he actually resides. The explanation is that the main mail despatches have to be sent for more detailed sub division to certain centres known as POST TOWNS, chosen because of their accessibility and convenience.\\""},"post_county":{"type":"string","maxLength":30,"minLength":0,"description":"One of the 26 Counties in the Republic of Ireland. These counties are sub-national divisions used for the purposes of administrative, geographical and political demarcation. Post County is the County associated with the Post Town, not the geographic county in which the building is located. The Post County is normally used as part of the Postal Address with some exceptions e.g. Dublin Postal Districts where the Post County is not used and some Post Towns (e.g. Tipperary, Kildare, etc.) that have the same name as the Post County."},"eircode":{"type":"string","maxLength":60,"minLength":0,"description":"The seven character Eircode has an A65 F4E2 format. The Eircode is a mandatory address element. The last line of a Postal Address will contain the Eircode, displayed with a space. e.g. `A65 F4E2`.\\n\\nThe Eircode is always the last line of a Postal Address generated
1within the state, e.g. if an address has four lines then the Eircode will be on its own on Address Line 5. For inbound international mail the country name IRELAND should be appended as the last line of the Postal Address."},"address_reference":{"type":"string","maxLength":16,"minLength":0,"description":"The address reference is the An Post GeoDirectory address reference identifier used by the Universal Service Provider."},"longitude":{"$ref":"#/components/schemas/Longitude"},"latitude":{"$ref":"#/components/schemas/Latitude"}}},"EcadAddress":{"title":"Ireland ECAD Address","description":"ECAD is the Eircode Address Database. It carries every ECAF postal address element plus GeoDirectory identifiers, building and organisation attributes, administrative area references and An Post sorting information. English and Irish language versions of each address are indexed separately and distinguished by `language`.\\n\\nUnavailable elements are returned as an empty string, never `null`.","required":["ecad_id","organisation_id","address_point_id","building_id","building_group_id","primary_thoroughfare_id","secondary_thoroughfare_id","primary_locality_id","secondary_locality_id","post_town","post_town_id","post_county_id","nua","gaeltacht","address_type","building_address_type","building_group_address_type","primary_locality_address_type","secondary_locality_address_type","building_type","holiday_home","under_construction","building_use","vacant","org_vacant","nace_code","nace_category","local_authority","ded_id","small_area_id","townland_id","gaeltacht_id","postaim_presort_61","postaim_presort_152","publicity_post_zone"],"allOf":[{"$ref":"#/components/schemas/EircBase"},{"type":"object","properties":{"dataset":{"type":"string","enum":["ecad"]},"ecad_id":{"type":"string","description":"Unique ECAD identifier for the postal address. Up to 10 digits.","minLength":1,"maxLength":10},"organisation_id":{"type":"string","description":"GeoDirectory identifier for the organisation. Empty string if the address has no organisation.","maxLength":10,"minLength":0},"address_point_id":{"type":"string","description":"GeoDirectory identifier for the address point.","maxLength":10,"minLength":0},"building_id":{"type":"string","description":"GeoDirectory identifier for the building.","maxLength":10,"minLength":0},"building_group_id":{"type":"string","description":"GeoDirectory identifier for the building group. Empty string if the address has no building group.","maxLength":10,"minLength":0},"primary_thoroughfare_id":{"type":"string","description":"GeoDirectory identifier for the primary thoroughfare.","maxLength":10,"minLength":0},"secondary_thoroughfare_id":{"type":"string","description":"GeoDirectory identifier for the secondary thoroughfare. Empty string if the address has no secondary thoroughfare.","maxLength":10,"minLength":0},"primary_locality_id":{"type":"string","description":"GeoDirectory identifier for the primary locality. Empty string if the address has no primary locality.","maxLength":10,"minLength":0},"secondary_locality_id":{"type":"string","description":"GeoDirectory identifier for the secondary locality. Empty string if the address has no secondary locality.","maxLength":10,"minLength":0},"post_town":{"type":"string","minLength":0,"description":"The name of the post town associated with the premises for postal delivery purposes. Returned in the language given by `language`, and mirrors `tertiary_locality` for this dataset.\\n\\nThe post town is a significant element of the Postal Address, however it is not always populated in an address. The official post office guide, Eola\xed an Phoist, describes post towns in the following manner:\\n\\n\\"A provincial postal address may include the name of a town or village several miles distant, with which the addressee has little or no connection, and, in some places, especially if this residence happens to be near a county boundary, the name of the neighbouring county instead of the county in which he actually resides. The explanation is that the main mail despatches have to be sent for more detailed sub division to certain centres known as post towns, chosen because of their accessibility and convenience.\\""},"post_town_id":{"type":"string","description":"GeoDirectory identifier for the post town.","maxLength":10,"minLength":0},"post_county_id":{"type":"string","description":"GeoDirectory identifier for the post county. Empty string if the address has no post county.","maxLength":10,"minLength":0},"nua":{"type":"boolean","description":"NUA means \\"non-unique address\\".\\n\\nThe NUA field contains `true` when the address is a non-unique address, and `false` when it is a unique address.\\n\\nIreland has a very high level of non-unique addresses (NUA), i.e. the address does not contain a unique building number or name. Approximately 35% of all Irish addresses are non-unique which equates to 600,000 addresses.\\n\\nThe typical example of NUA addressing is where every address in a townland is the same. The way that post is delivered is by local knowledge of postal delivery personnel of which addressee lives in which house.\\n\\nN.B. For a NUA address, it is impossible to match to a unique record
1in the ECAD and assign an Eircode."},"gaeltacht":{"type":"boolean","description":"Gaeltacht refers to a district where the Irish government recognises that the Irish language is the predominant language.\\n\\nReturns `true` if address is in a Gaeltacht area and `false` if not."},"address_type":{"type":"string","minLength":0,"description":"Addresses points can assume one of the following values:\\n\\n- Residential Address Point. This type of address point has one residential addresses associated with it.\\n- Non-Residential Address Point. This type of address point has one or more non-residential address (business, club or other organisation) associated with it.\\n- Mixed Address Point. This is a special case where the residential and non residential addresses in the building are essentially the same address. The typical example is a farm house on an active farm. It is important to note that this is a special case. In general a building with both residential and non-residential addresses (e.g. an apartment over a shop) will receive two address points, one commercial and one residential, and hence two Eircodes.\\n\\nBuildings can contain multiple address points of type Residential and/or Non-Residential."},"building_address_type":{"type":"string","minLength":0,"description":"The building type can assume one of the following values:\\n\\n- Single Occupancy Residential Building. This type of building contains one residential address.\\n- Multi Occupancy Residential Building. This type of building contains multiple residential addresses.\\n- Single Occupancy Non-Residential Building. This type of building contains one non-residential address (business, club or other organisation).\\n- Multi Occupancy Non-Residential Building. This type of building contains multiple non-residential addresses (business, club or other organisation).\\n- Multi Occupancy Mixed Use Building. This type of building contains multiple residential and non- residential addresses.\\n\\nBuildings can also have a more specific address types such as a Hospital, School, Shopping Centre, etc."},"building_group_address_type":{"type":"string","minLength":0,"description":"The building group type can be:\\n\\n- Residential Building Group. This type of building group contains buildings with residential addresses only.\\n- Non-Residential Building Group This type of building group contains buildings with non-residential addresses (business, club or other organisation) only.\\n- Mixed Building Group. This type of building group contains buildings with residential and non-residential addresses. Can also have a more specific address type such as a Hospital, School, Shopping Centre, etc.\\n\\nBuilding groups can also have a more specific address type such as a Hospital, School, Shopping Centre, etc."},"primary_locality_address_type":{"type":"string","minLength":0,"description":"The locality type can be:\\n - Rural Locality. This is generally a townland.\\n - Industrial Estate. Industrial Estate, Industrial Park, Business Campus, etc.\\n - Shopping District. Shopping Centre.\\n - Housing Estate. Residential Housing Estate.\\n - Village. Based on Census 2011 population < 1,500.\\n - Town. Based on Census 2011 population > 1,500.\\n - Urban Area. Wholly within a village/town/city e.g. Rathmines.\\n - Suburban Locality. This is an area that is both rural and urban, as it is both a townland, and also an area name applied to houses in a town, as the town has extended partially into the townland.\\n\\nWhere the locality is also the post town, the type can be:\\n - Village. Based on Census 2011 population < 1,500\\n - Town. Based on Census 2011 population > 1,500\\n - Postal District. Dublin 1 to 24\\n - City. Dublin, Cork, Limerick, Galway or Waterford"},"secondary_locality_address_type":{"type":"string","minLength":0,"description":"The locality type can be:\\n - Rural Locality. This is generally a townland.\\n - Industrial Estate. Industrial Estate, Industrial Park, Business Campus, etc.\\n - Shopping District. Shopping Centre.\\n - Housing Estate. Residential Housing Estate.\\n - Village. Based on Census 2011 population < 1,500.\\n - Town. Based on Census 2011 population > 1,500.\\n - Urban Area. Wholly within a village/town/city e.g. Rathmines.\\n - Suburban Locality. This is an area that is both rural and urban, as it is both a townland, and also an area name applied to houses in a town, as the town has extended partially into the townland.\\n\\nWhere the locality is also the post town, the type can be:\\n - Village. Based on Census 2011 population < 1,500\\n - Town. Based on Census 2011 population > 1,500\\n - Postal District. Dublin 1 to 24\\n - City. Dublin, Cork, Limerick, Galway or Waterford"},"building_type":{"type":"string","minLength":0,"description":"Describes the type of building, e.g. detached, semi-detached, bungalow."},"holiday_home":{"type":"string","enum":["Y","N",""],"description":"A Yes/No f
1ield, indicating whether or not the building is a holiday home. Empty string if unknown."},"under_construction":{"type":"string","enum":["Y","N",""],"description":"A Yes/No field, indicating whether or not the building is under construction. Empty string if unknown."},"building_use":{"type":"string","enum":["R","C","B","U",""],"description":"Can be one of:\\n\\n- `R` Residential\\n- `C` Commercial\\n- `B` Both\\n- `U` Unknown\\n\\nEmpty string if the building carries no use information."},"vacant":{"type":"string","enum":["Y","N",""],"description":"A Yes/No field, indicating whether the building is vacant. Empty string if unknown."},"org_vacant":{"type":"string","enum":["Y","N",""],"description":"A Yes/No field, indicating whether the organisation is vacant. Empty string if unknown or the address has no organisation."},"nace_code":{"type":"string","minLength":0,"description":"The NACE Code for the Category."},"nace_category":{"type":"string","minLength":0,"description":"Name of the NACE Category"},"local_authority":{"type":"string","minLength":0,"description":"Name of local authority"},"ded_id":{"type":"string","minLength":0,"description":"Unique Identifier for the Electoral Division, from the 2017 data.\\n\\nElectoral Divisions are legally defined administrative areas in Ireland. There are 3,441 Electoral Divisions, each a sub-division of a County.\\n\\nNote that this field is subject to breaking changes if a new generation of government data IDs is released. Currently this uses 2017 IDs. Contact us to be notified ahead of this change."},"small_area_id":{"type":"string","minLength":0,"description":"Unique Identifier for the Small Area, from the 2017 data.\\n\\nSmall Area boundaries are sub-divisions of Electoral Divisions. A normal Small Area comprises approximately 80-120 dwellings, created by the National Institute of Regional and Spatial Analysis (NIRSA) on behalf of Ordnance Survey Ireland (OSi) in consultation with the Central Statistics Office (CSO).\\n\\nNote that this field is subject to breaking changes if a new generation of government data IDs is released. Currently this uses 2017 IDs. Contact us to be notified ahead of this change."},"townland_id":{"type":"string","minLength":0,"description":"Unique Identifier for the townland, from the 2017 data.\\n\\nA townland is a small geographical division of land commonly used in Ireland, and the building block for higher-level Electoral Divisions. Townland names may not be unique within a County.\\n\\nNote that this field is subject to breaking changes if a new generation of government data IDs is released. Currently this uses 2017 IDs. Contact us to be notified ahead of this change."},"gaeltacht_id":{"type":"string","minLength":0,"description":"Unique Identifier for the Gaeltacht area, from the 2017 data. There are 7 Gaeltacht areas. Empty string if the address is not in a Gaeltacht.\\n\\nNote that this field is subject to breaking changes if a new generation of government data IDs is released. Currently this uses 2017 IDs. Contact us to be notified ahead of this change."},"postaim_presort_61":{"type":"string","minLength":0,"description":"An Post sorting information."},"postaim_presort_152":{"type":"string","minLength":0,"description":"An Post sorting information."},"publicity_post_zone":{"type":"string","minLength":0,"description":"An Post publicity post zone information."}}}],"example":{"id":"ecad_1700000000|en","dataset":"ecad","ecad_id":"1700000000","country_iso":"IRL","country_iso_2":"IE","country":"Ireland","language":"en","line_1":"Apartment 4","line_2":"The Mall","line_3":"Riverside Way","line_4":"Midleton","line_5":"Co. Cork","line_6":"P25 PR28","line_7":"","line_8":"","line_9":"","department":"","organisation":"","sub_building_name":"Apartment 4","building_name":"","building_number":"","building_group":"The Mall","primary_thoroughfare":"Riverside Way","secondary_thoroughfare":"","primary_locality":"","secondary_locality":"","tertiary_locality":"Midleton","post_county":"Cork","eircode":"P25 PR28","address_reference":"4065432740654331","organisation_id":"","address_point_id":"1700000000","building_id":"1401909875","building_group_id":"1300011097","primary_thoroughfare_id":"1200004534","secondary_thoroughfare_id":"","primary_locality_id":"","secondary_locality_id":"","post_town":"Midleton","post_town_id":"1100000075","post_county_id":"1001000000","nua":false,"gaeltacht":false,"address_type":"Residential Address Point","building_address_type":"Multi Occupancy Mixed Building","building_group_address_type":"Apartment Complex","primary_locality_address_type":"","secondary_locality_address_type":"","building_type":"Semi-Detached","holiday_home":"N","under_construction":"N","building_use":"B","vacant":"N","org_vacant":"","nace_code":"","nace_category":"","local_authority":"","ded_id":"","small_area_id":"","townland_id":"","gaeltacht_id":"","postaim_presort_61":"Portlaoise Hub","postaim_presort_152":"Midleton","publicity_post_zone":"19","longitude":"","latitude":""}},"EcafAddress":{"title":"Ireland ECAF Address","description":"ECAF
1is the Eircode Address File, which holds one record per Irish postal address. English and Irish language versions of each address are indexed separately and distinguished by `language`.\\n\\nUnavailable elements are returned as an empty string, never `null`. ECAF carries no coordinates, so `longitude` and `latitude` are always empty strings - use `EcadAddress` for geolocated Irish addresses.","required":["ecaf_id"],"allOf":[{"$ref":"#/components/schemas/EircBase"},{"type":"object","properties":{"dataset":{"type":"string","enum":["ecaf"]},"ecaf_id":{"type":"string","maxLength":10,"minLength":0,"description":"The unique identifier in the ECAF is the `ecaf_id`. This unique identifier allows each address in the ECAF to be uniquely identified. It can also be used as index once the data has been imported into a relational database. This is a numeric field that can store values from 0 to 2,147,483,647. It is represented as a number up to 10 digits long. All other fields in ECAF are alphanumeric."}}}],"example":{"id":"ecaf_1700000000|en","dataset":"ecaf","country_iso":"IRL","country_iso_2":"IE","country":"Ireland","language":"en","line_1":"Apartment 4","line_2":"The Mall","line_3":"Riverside Way","line_4":"Midleton","line_5":"Co. Cork","line_6":"P25 PR28","line_7":"","line_8":"","line_9":"","ecaf_id":"1700000000","department":"","organisation":"","sub_building_name":"Apartment 4","building_name":"","building_number":"","building_group":"The Mall","primary_thoroughfare":"Riverside Way","secondary_thoroughfare":"","primary_locality":"Midleton","secondary_locality":"","tertiary_locality":"","post_county":"Cork","eircode":"P25 PR28","address_reference":"4065432740654331","longitude":"","latitude":""}},"HereAddress":{"title":"HERE Address","description":"An address from HERE Technologies\' map data, covering 230 countries and territories across twelve regional datasets named in `dataset`. Each address carries its address lines, house number (`address`), street name, HERE\'s administrative hierarchy (`order1_name`, `order2_name`, `order8_name`, `builtup_name`), a postal code where the country has one, display and delivery coordinates and, where HERE holds them, the building, unit, level and unit name. Depth varies by country, from building level down to region level only. HERE refreshes the data quarterly.\\n\\nConventions:\\n\\n- A record is one of four kinds, named after the dataset in `id`: `ap` an address point, `ar` an address range, `poi` a point of interest, `loc` a locality. Postal Addressing records are `pap` and `par`.\\n- `id` is the dataset, the kind, HERE\'s key and the language code. A range id carries a further segment holding the interpolated house number (`herewe_ar|74024700!27769096|8|de`).\\n- Text fields are empty strings, never null. Coordinates are empty strings when absent.\\n- Only `line_1` and `line_2` are ever populated. `line_1` is the building name line where the record has one, otherwise the street line. Ranges, points of interest and localities produce at most one line.\\n- Casing is as HERE ships it. Only the Postal Addressing fields are title cased.\\n- `language` is the ISO 639-1 code for the record. A street named in more than one language yields one record per language, identical but for the language segment of `id`.\\n","example":{"id":"herewe_ap|365553439|it","dataset":"herewe","country_iso":"ITA","line_1":"16 Via Giuseppe Garibaldi","line_2":"","line_3":"","line_4":"","line_5":"","language":"it","address":"16","building_name":"","delivery_latitude":45.28441,"delivery_longitude":12.00825,"latitude":45.28441,"longitude":12.00825,"street_name":"Via Giuseppe Garibaldi","postal_code":"35020","order1_name":"Veneto","order2_name":"Padova","order8_name":"Brugine","builtup_name":"","poi_name":"","building_unit_name":"","level_name":"","unit_name":"","suppl_address_info":"","building_grp_name":""},"allOf":[{"type":"object","required":["id","dataset","country_iso","line_1","line_2","line_3","line_4","line_5","language","address","latitude","longitude","building_name","delivery_longitude","delivery_latitude","street_name","postal_code","order1_name","order2_name","order8_name","builtup_name","poi_name","building_unit_name","level_name","unit_name","suppl_address_info","building_grp_name"],"properties":{"id":{"$ref":"#/components/schemas/ID"},"country_iso":{"type":"string","description":"Three character country code based on ISO Standard 3166."}
1,"dataset":{"type":"string","description":"HERE regional dataset the address was sourced from.","enum":["herewe","heret","heresa","hereo","herena","heremeas","heremea","herem","herei","herehk","hereee","hereap"]},"language":{"type":"string","description":"ISO 639-1 language code of the record, mapped down from HERE\'s three-letter code. Taken from the address point, the road for a range, the point of interest or the administrative place for a locality.","minLength":2,"maxLength":2},"line_1":{"type":"string","description":"First address line.\\n\\nCan be empty string `\\"\\"` if not present.\\n","minLength":0,"maxLength":150},"line_2":{"type":"string","description":"Second address line.\\n\\nCan be empty string `\\"\\"` if not present.\\n","minLength":0,"maxLength":150},"line_3":{"type":"string","description":"Third address line. Always the empty string `\\"\\"` for HERE records, which produce at most two lines.\\n","minLength":0,"maxLength":150},"line_4":{"type":"string","description":"Fourth address line. Always the empty string `\\"\\"` for HERE records, which produce at most two lines.\\n","minLength":0,"maxLength":150},"line_5":{"type":"string","description":"Fifth address line. Always the empty string `\\"\\"` for HERE records, which produce at most two lines.\\n","minLength":0,"maxLength":150},"address":{"type":"string","description":"Address / House Number uniquely identifying the address along the specified road link.\\n\\nCan be empty string `\\"\\"` if not present.\\n","minLength":0,"maxLength":150},"delivery_latitude":{"oneOf":[{"type":"string","description":"Empty string `\\"\\"` if not available"},{"type":"number","minimum":-90,"maximum":90,"description":"Latitude defining the arrival position of the Point Address."}]},"delivery_longitude":{"oneOf":[{"type":"string","description":"Empty string `\\"\\"` if not available"},{"type":"number","minimum":-180,"maximum":180,"description":"Longitude defining the arrival position of the Point Address."}]},"building_name":{"type":"string","description":"Name of the Building to which the Point Address is associated.\\n\\nCan be empty string `\\"\\"` if not present.\\n","minLength":0,"maxLength":150},"latitude":{"oneOf":[{"type":"string","description":"Empty string `\\"\\"` if not available"},{"type":"number","minimum":-90,"maximum":90,"description":"Latitude of the display position for the Point Address."}]},"longitude":{"oneOf":[{"type":"string","description":"Empty string `\\"\\"` if not available"},{"type":"number","minimum":-180,"maximum":180,"description":"Longitude of the display position for the Point Address."}]},"street_name":{"type":"string","description":"The full spelling of the street name, including Prefix, Base Name, Suffix, Street Type, and Direction on Sign.\\n\\nCan be empty string `\\"\\"` if not present.","minLength":0,"maxLength":100},"postal_code":{"type":"string","description":"Full postal code; could be numeric or alphanumeric postal code.\\n\\nCan be empty string `\\"\\"` if not present.","minLength":0,"maxLength":15},"order1_name":{"type":"string","description":"Identifies the highest administrative level in which a country can be subdivided.\\n\\nCan be empty string `\\"\\"` if not present."},"order2_name":{"type":"string","description":"Identifies an intermediate administrative level of a country and is a sub-division of an Order-1 area. Only countries with a five (or more) level administrative hierarchy have Order-2 administrative levels defined. This feature can be used for destination selection and map display.\\n\\nCan be empty string `\\"\\"` if not present."},"order8_name":{"type":"string","description":"Identifies the lowest level of the country\'s administrative hierarchy that is present country-wide. (No gaps exist in the coverage.)\\n\\nCan be empty string `\\"\\"` if not present."},"builtup_name":{"type":"string","description":"Identifies the lowest administrative level for a country. This level does not cover the entire country, (as opposed to the Order-8 Area level which does cover the entire country). This feature should be used in conjunction with Zone and Order-8 Area for destination selection. The Built-up Area polygon, as published in RDF_CARTO, can also be used for map display.\\n\\nCan be empty string `\\"\\"` if not present."},"poi_name":{"type":"string","description":"Name of the point of interest. Populated for point of interest records only.\\n\\nCan be empty string `\\"\\"` if not present."},"building_unit_name":{"type":"string","description":"Name of the Building associated with a Micro Point Address.\\n\\nCan be empty string `\\"\\"` if not present."},"level_name":{"type":"string","description":"Name of floor or level within a building associated with a Micro Point Address.\\n\\nCan be empty string `\\"\\"` if not present."},"unit_name":{"type":"string","description":"Name of the unit (suite, etc) associated with a Micro Point Address.\\n\\nCan be empty string `\\"\\"` if not present."},"suppl_address_info":{"type":"string","description":"Additional address or building information.\\n\\nCan be empty string `\\"\\"` if not present."},"building_grp_name":{"type":"string","description":"Name of the group of buildings with which the address is associated.\\n\\nCan be empty string `\\"\\"` if not present."}}}]},"GnafAddress":{"title":"Australia G-NAF Address","description":"An Australian address from the Geocoded National Address File (G-NAF), published by Geoscape. Covers Australia and the external territories of Cocos (Keeling) Islands, Christmas Island and Norfolk Island.\\n\\nEvery attribute is always present. The API returns fields with
1no value as an empty string `\\"\\"`.\\n\\nThe API returns attributes sourced from a one-to-many table (address aliases, site geocodes, locality aliases, street locality aliases) as a single comma separated string, with one element per related record. Related lists share an ordering, so the nth element of each describes the same record.","type":"object","required":["id","dataset","country","country_iso","country_iso_2","line_1","line_2","language","address","latitude","longitude","address_detail_pid","date_created","date_last_modified","date_retired","building_name","lot_number_prefix","lot_number","lot_number_suffix","flat_type_code","flat_number_prefix","flat_number","flat_number_suffix","level_type_code","level_number_prefix","level_number","level_number_suffix","number_first_prefix","number_first","number_first_suffix","number_last_prefix","number_last","number_last_suffix","street_locality_pid","alias_principal","postcode","private_street","legal_parcel_id","confidence","level_geocoded_code","primary_secondary","alias_type_code","geocode_type_code","default_latitude","default_longitude","address_change_type_code","mb_2016_match_code","mb_2021_match_code","address_type","address_site_name","geocode_site_name","site_geocode_type_code","reliability_code","site_boundary_extent","site_planimetric_accuracy","elevation","site_longitude","site_latitude","geocode_type_priority_order","site_geocode_priority_order","locality_name","primary_postcode","locality_class_code","locality_gnaf_reliability_code","locality_alias_name","locality_alias_postcode","locality_alias_type_code","locality_planimetric_accuracy","locality_latitude","locality_longitude","mb_2016_code","mb_2021_code","ps_join_type_code","state_name","state_abbreviation","street_class_code","street_name","street_type_code","street_suffix_code","gnaf_street_confidence","street_locality_gnaf_reliability_code","street_locality_alias_street_name","street_locality_alias_street_type_code","street_locality_alias_street_suffix_code","street_locality_alias_type_code","street_locality_boundary_extent","street_locality_planimetric_accuracy","street_locality_latitude","street_locality_longitude","street_type_name","street_locality_alias_street_type_name"],"example":{"id":"gnaf_GAQLD157509281|99","dataset":"gnaf","country":"Australia","country_iso":"AUS","country_iso_2":"AU","line_1":"Flat 3 99 Barney St","line_2":"","language":"en","address":"99","latitude":-23.85175973,"longitude":151.27280546,"address_detail_pid":"GAQLD157509281","date_created":"2015-07-22T00:00:00.000Z","date_last_modified":"2021-07-07T00:00:00.000Z","date_retired":"","building_name":"","lot_number_prefix":"","lot_number":"1","lot_number_suffix":"","flat_type_code":"Flat","flat_number_prefix":"","flat_number":3,"flat_number_suffix":"","level_type_code":"","level_number_prefix":"","level_number":"","level_number_suffix":"","number_first_prefix":"","number_first":99,"number_first_suffix":"","number_last_prefix":"","number_last":"","number_last_suffix":"","street_locality_pid":"QLD106251","alias_principal":"P","postcode":"4680","private_street":"","legal_parcel_id":"1/RP611454","confidence":2,"level_geocoded_code":7,"primary_secondary":"S","alias_type_code":"","geocode_type_code":"PC","default_latitude":-23.85175973,"default_longitude":151.27280546,"address_change_type_code":"","mb_2016_match_code":"1","mb_2021_match_code":"1","address_type":"UN","address_site_name":"","geocode_site_name":"","site_geocode_type_code":"PC","reliability_code":"2","site_boundary_extent":"","site_planimetric_accuracy":"","elevation":"","site_longitude":"151.27280546","site_latitude":"-23.85175973","geocode_type_priority_order":14,"site_geocode_priority_order":"14","locality_name":"Barney Point","primary_postcode":"","locality_class_code":"G","locality_gnaf_reliability_code":5,"locality_alias_name":"South Gladstone,Gladstone Harbour,Gladstone City,Gladstone","locality_alias_postcode":",,,","locality_alias_type_code":"SYN,SYN,SYN,SYN","locality_planimetric_accuracy":"","locality_latitude":-23.84320223,"locality_longitude":151.26897733,"mb_2016_code":"30563058200","mb_2021_code":"30563058200","ps_join_type_code":"1","state_name":"Queensland","state_abbreviation":"QLD","street_class_code":"C","street_name":"Barney","street_type_code":"Street","street_suffix_code":"","gnaf_street_confidence":3,"street_locality_gnaf_reliability_code":4,"street_locality_alias_street_name":"","street_locality_alias_street_type_code":"","street_locality_alias_street_suffix_code":"","street_locality_alias_type_code":"","street_locality_boundary_extent":576,"street_locality_planimetric_accuracy":"","street_locality_latitude":-23.85114069,"street_locality_longitude":151.27296937,"street_type_name":"St","street_locality_alias_street_type_name":""},"properties":{"id":{"$ref":"#/components/schemas/ID"},"dataset":{"type":"string","enum":["gnaf"]},"country":{"type":"string","description":" Full country names (ISO 3166)\\n","enum":["Australia","Cocos (Keeling) Islands","Christmas Island","Norfolk Island"]},"country_iso":{"type":"string","description":" 3 letter country code (ISO 3166-1)\\n","enum":["AUS","CCK","CXR","NFK"]},"country_iso_2":{"type":"string","description":" 2 letter country code (ISO 3166-1)\\n","enum":["AU","CC","CX","NF"]},"line_1":{"type":"string","description":"First address line. The building name where one is recorded, otherwise the street line.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"line_2":{"type":"string","description":"Second address line. The street line where `line_1` carries a building name.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"language":{"type":"string","enum":["en"],"description":"Language represented by 2 letter ISO Code (639-1)\\n"},"address":{"type":"string","description":"Address / House Number uniquely identifying the address along the specified street. For a ranged address this is the number matched from the query, not the whole range.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"latitude":{"$ref":"#/components/schemas/Latitude"},"longitude":{"$ref":"#/components/schemas/Longitude"},"address_detail_pid":{"type":"string","description":"The Persistent Identifier is unique to the real world feature this record represents.\\n"},"date_created":{"type":"string","format":"date-time","description":"ISO 8601 date-time this record was created.\\n"},"date_last_modified":{"type":"string","description":"ISO 8601 date-time this record was last modified (not retired/recreated in line with ICSM standard).\\n\\nEmpty string `\\"\\"` if the record has never been modified.\\n"},"date_retired":{"type":"string","description":"ISO 8601 date-time this record was retired.\\n\\nEmpty string `\\"\\"` if the record
1is current.\\n"},"building_name":{"type":"string","description":"Combines both building/property name fields. Field length: up to 200 alphanumeric characters (AS4590:2006 5.7).\\n"},"lot_number_prefix":{"type":"string","description":"Lot number prefix. Field length: up to two alphanumeric characters (AS4590:2006 5.8.1).\\n"},"lot_number":{"type":"string","description":"Lot number. Field length: up to five alphanumeric characters (AS4590:2006 5.8.1).\\n"},"lot_number_suffix":{"type":"string","description":"Lot number suffix. Field length: up to two alphanumeric characters (AS4590:2006 5.8.1).\\n"},"flat_type_code":{"type":"string","description":"Specification of the type of a separately identifiable portion within a building/complex. Field Length: up to seven upper case alpha characters (AS4590:2006 5.5.1.1).\\n"},"flat_number_prefix":{"type":"string","description":"Flat/unit number prefix. Field length: up to two alphanumeric characters (AS4590:2006 5.5.1.2).\\n"},"flat_number":{"oneOf":[{"type":"string","description":"Empty string `\\"\\"` if not available"},{"type":"integer","description":"Flat/unit number. Field length: up to five numeric characters (AS4590:2006 5.5.1.2).\\n"}]},"flat_number_suffix":{"type":"string","description":"Flat/unit number suffix. Field length: up to two alphanumeric characters (AS4590:2006 5.5.1.2).\\n"},"level_type_code":{"type":"string","description":"Level type. Field length: up to four alphanumeric characters (AS4590:2006 5.5.2.1).\\n"},"level_number_prefix":{"type":"string","description":"Level number prefix. Field length: up to two alphanumeric characters (AS4590:2006 5.5.2.2).\\n"},"level_number":{"oneOf":[{"type":"string","description":"Empty string `\\"\\"` if not available"},{"type":"integer","description":"Level number. Field length: up to three numeric characters (AS4590:2006 5.5.2.2).\\n"}]},"level_number_suffix":{"type":"string","description":"Level number suffix. Field length: up to two alphanumeric characters (AS4590:2006 5.5.2.2).\\n"},"number_first_prefix":{"type":"string","description":"Prefix for the first (or only) number in range. Field length: up to three uppercase alphanumeric characters (AS4590:2006 5.5.3.1).\\n"},"number_first":{"oneOf":[{"type":"string","description":"Empty string `\\"\\"` if not available"},{"type":"integer","description":"Identifies first (or only) street number in range. Field length: up to six numeric characters (AS4590:2006 5.5.3.1).\\n"}]},"number_first_suffix":{"type":"string","description":"Suffix for the first (or only) number in range. Field length: up to two uppercase alphanumeric characters (AS4590:2006 5.5.3.1).\\n"},"number_last_prefix":{"type":"string","description":"Prefix for the last number in range. Field length: up to three uppercase alphanumeric characters (AS4590:2006 5.5.3.2).\\n"},"number_last":{"oneOf":[{"type":"string","description":"Empty string `\\"\\"` if not available"},{"type":"integer","description":"Identifies last number in range. Field length: up to six numeric characters (AS4590:2006 5.5.3.2).\\n"}]},"number_last_suffix":{"type":"string","description":"Suffix for the last number in range. Field length: up to two uppercase alphanumeric characters (AS4590:2006 5.5.3.2).\\n"},"street_locality_pid":{"type":"string","description":"Identifier of the street locality this address sits on. Not mandatory - some G-NAF records do not require a street (e.g. a remote rural property).\\n"},"alias_principal":{"type":"string","description":"A = Alias record, P = Principal record.\\n"},"postcode":{"type":"string","description":"Postcodes are optional as prescribed by AS4819 and AS4590:2006 5.13.\\n"},"private_street":{"type":"string","description":"Private street information. This is not broken up into name/type/suffix. Field length: up to 75 alphanumeric characters. This is not currently populated.\\n"},"legal_parcel_id":{"type":"string","description":"Generic parcel id field derived from the Geoscape Australia\'s Cadastre parcel where available.\\n"},"confidence":{"oneOf":[{"type":"string","description":"Empty string `\\"\\"` if not available"},{"type":"integer","description":"Reflects how many contributor databases this address appears in (0 = 1 database, 1 = 2 databases etc.). `-1` indicates the address appears in no contributor database.\\n"}]},"level_geocoded_code":{"type":"integer","description":"Binary indicator of the level of geocoding this address has. e.g. 0 = 000 = (No geocode), 1 = 001 = (No Locality geocode, No Street geocode, Address geocode), etc.\\n"},"primary_secondary":{"type":"string","description":"Indicator that identifies if the address is P (Primary) or S (secondary).\\n"},"alias_type_code":{"type":"string","description":"Comma separated alias types for this address (e.g. \\"Synonym\\"), one per alias record.\\n"},"geocode_type_code":{"type":"string","description":"Unique abbreviation for the geocode type of the default geocode.\\n"},"default_latitude":{"oneOf":[{"type":"string","description":"Empty string `\\"\\"` if not available"},{"type":"number","description":"Latitude of the default geocode (GDA2020). Same value as `latitude`.\\n","minimum":-90,"maximum":90}]},"default_longitude":{"oneOf":[{"type":"string","description":"Empty string `\\"\\"` if not available"},{"type":"number","description":"Longitude of the default geocode (GDA2020). Same value as `longitude`.\\n","minimum":-180,"maximum":180}]},"address_change_type_code":{"type":"string","description":"The code indicating the type of change, for example, LOC-STN for locality name and street name change.\\n"},"mb_2016_match_code":{"type":"string","description":"Code for the 2016 mesh block match e.g. 1.\\n"},"mb_2021_match_code":{"type":"string","description":"Code for the 2021 mesh block match e.g. 1.\\n"},"address_type":{"type":"string","description":"Address type (e.g. \\"Postal\\", \\"Physical\\").\\n"},"address_site_name":{"type":"string","description":"Address site name. Field length: 200 alphanumeric characters.\\n"},"geocode_site_name":{"type":"string","description":"Comma separated identifiers relating to each geocoded site (e.g. \\"Transformer 75658\\"), one per site geocode record.\\n"},"site_geocode_type_code":{"type":"string","description":"Comma separated abbreviations for each site geocode feature (e.g. \\"PRCL\\") (SAWG 7.4.1), one per site geocode record.\\n"},"reliability_code":{"type":"string","description":"Comma separated spatial precision of each site geocode, expressed as a number in the range 1 (unique identification of feature) to 6 (feature associated to region i.e. postcode).\\n"},"site_boundary_extent":{"type":"string","description":"Comma separated measurements (metres) of each site geocode from other geocodes associated with the same address persistent identifier.\\n"},"site_planimetric_accuracy":{"type":"string","description":"Comma separated planimetric accuracy of each site geocode.\\n"},"elevation":{"type":"string","description":"Comma separated elevation of each site geocode. This field is not currently populated.\\n"},"site_longitude":{"type":"string","description":"Comma separated longitude of each site geocode (GDA2020).\\n"},"site_latitude":{"type":"string","description":"Comma separated latitude of each site geocode (GDA2020).\\n"},"geocode_type_priority_order":{"oneOf":[{"type":"string","description":"Empty string `\\"\\"` if not available"},{"type":"integer","description":"Priority order of the default geocode type, 1 (most precise) to 29 (least precise). The priority order enables a default geocode to be assigned to each address which represents the geocode of the highest precision currently assigned to an address.\\n"}]},"site_geocode_priority_order":{"type":"string","description":"Comma separated priority order of each site geocode type, 1 (most precise) to 29 (least precise), one per site geocode record.\\n"},"locality_name":{"type":"string","description":"The name of the locality or suburb.\\n"},"primary_postcode":{"type":"string","description":"Required to differentiate localities of the same name within a state.\\n"},"locality_class_code":{"type":"string","description":"Describes the class of locality (e.g. Gazetted, topographic feature etc.). Lookup to locality class.\\n"},"locality_gnaf_reliability_code":{"oneOf":[{"type":"string","description":"Empty string `\\"\\"` if not available"},{"type":"integer","description":"= 5 if suburb locality, else = 6. Spatial precision of the geocode expressed as a number in the range 1 (unique identification of feature) to 6 (feature associated to region i.e. postcode).\\n"}]},"locality_alias_name":{"type":"string","description":"Comma separated alias names for the locality or suburb.\\n"},"locality_alias_postcode":{"type":"string","description":"Comma separated postcodes, one per locality alias.\\n"},"locality_alias_type_code":{"type":"string","description":"Comma separated alias type co
1des, one per locality alias.\\n"},"locality_planimetric_accuracy":{"oneOf":[{"type":"string","description":"Empty string `\\"\\"` if not available"},{"type":"integer","description":"Planimetric accuracy of the locality geocode (if known).\\n"}]},"locality_latitude":{"oneOf":[{"type":"string","description":"Empty string `\\"\\"` if not available"},{"type":"number","description":"Locality latitude (GDA2020).\\n","minimum":-90,"maximum":90}]},"locality_longitude":{"oneOf":[{"type":"string","description":"Empty string `\\"\\"` if not available"},{"type":"number","description":"Locality longitude (GDA2020).\\n","minimum":-180,"maximum":180}]},"mb_2016_code":{"type":"string","description":"The 2016 mesh block code.\\n"},"mb_2021_code":{"type":"string","description":"The 2021 mesh block code.\\n"},"ps_join_type_code":{"type":"string","description":"Comma separated join type codes, one per primary/secondary link on this address. Each is 1 OR 2 when the root address:-\\n\\nCode 1: Automatically generated when the primary and secondary addresses share the same street number, street name (and type) and locality name components.\\n\\nCode 2: Manually generated where the primary and secondary addresses MAY or MAY NOT share the same street number, street name (and type) and locality name components\\n"},"state_name":{"type":"string","description":"The state or territory name, title cased. E.g. Tasmania.\\n"},"state_abbreviation":{"type":"string","description":"The state or territory abbreviation.\\n"},"street_class_code":{"type":"string","description":"Defines whether this street represents a confirmed or unconfirmed street.\\n"},"street_name":{"type":"string","description":"Street name. e.g. \\"Barney\\".\\n"},"street_type_code":{"type":"string","description":"The street type code. e.g. \\"Street\\".\\n"},"street_suffix_code":{"type":"string","description":"The street suffix code. e.g. \\"West\\".\\n"},"gnaf_street_confidence":{"oneOf":[{"type":"string","description":"Empty string `\\"\\"` if not available"},{"type":"integer","description":"The street confidence level.\\n"}]},"street_locality_gnaf_reliability_code":{"oneOf":[{"type":"string","description":"Empty string `\\"\\"` if not available"},{"type":"integer","description":"Always = 4. Spatial precision of the geocode expressed as a number in the range 1 (unique identification of feature) to 6 (feature associated to region i.e. postcode).\\n"}]},"street_locality_alias_street_name":{"type":"string","description":"Comma separated street alias names. e.g. \\"Poplar\\".\\n"},"street_locality_alias_street_type_code":{"type":"string","description":"Comma separated street type codes, one per street alias. e.g. \\"Place\\".\\n"},"street_locality_alias_street_suffix_code":{"type":"string","description":"Comma separated street suffix codes, one per street alias. e.g. \\"West\\".\\n"},"street_locality_alias_type_code":{"type":"string","description":"Comma separated alias type codes, one per street alias.\\n"},"street_locality_boundary_extent":{"oneOf":[{"type":"string","description":"Empty string `\\"\\"` if not available"},{"type":"integer","description":"Measurement (metres) of the street locality geocode from other geocodes associated with the same address persistent identifier.\\n"}]},"street_locality_planimetric_accuracy":{"oneOf":[{"type":"string","description":"Empty string `\\"\\"` if not available"},{"type":"integer","description":"Planimetric accuracy of the street locality geocode (if known).\\n"}]},"street_locality_latitude":{"oneOf":[{"type":"string","description":"Empty string `\\"\\"` if not available"},{"type":"number","description":"Street locality latitude (GDA2020).\\n","minimum":-90,"maximum":90}]},"street_locality_longitude":{"oneOf":[{"type":"string","description":"Empty string `\\"\\"` if not available"},{"type":"number","description":"Street locality longitude (GDA2020).\\n","minimum":-180,"maximum":180}]},"street_type_name":{"type":"string","description":"Abbreviation of the street type. e.g. \\"St\\".\\n"},"street_locality_alias_street_type_name":{"type":"string","description":"Comma separated abbreviations of the street type, one per street alias. e.g. \\"St\\".\\n"}}},"KadasterAddress":{"title":"Netherlands Kadaster Address","type":"object","description":"A Netherlands address as recorded in the Kadaster BAG (Basisregistratie Adressen en Gebouwen), the Dutch national register of addresses and buildings.\\n\\nFields are grouped by the BAG object they originate from: the verblijfsobject (unprefixed) and the related `nummeraanduidingen_`, `pand_`, `openbare_ruimte_` and `woonplaats_` objects.\\n","required":["id","dataset","country","country_iso","country_iso_2","line_1","language","address","identificatie","latitude","longitude","gebruiksdoel","oppervlakte","status","geconstateerd","documentdatum","documentnummer","voorkomenidentificatie","begin_geldigheid","eind_geldigheid","tijdstip_registratie","eind_registratie","tijdstip_registratie_lv","tijdstip_eind_registratie_lv","nummeraanduidingen_identificatie","nummeraanduidingen_huisnummer","nummeraanduidingen_huisnummertoevoeging","nummeraanduidingen_huisletter","nummeraanduidingen_postcode","nummeraanduidingen_type_adresseerbaar_object","nummeraanduidingen_status","nummeraanduidingen_geconstateerd","
1nummeraanduidingen_documentdatum","nummeraanduidingen_documentnummer","nummeraanduidingen_voorkomenidentificatie","nummeraanduidingen_begin_geldigheid","nummeraanduidingen_eind_geldigheid","nummeraanduidingen_tijdstip_registratie","nummeraanduidingen_eind_registratie","nummeraanduidingen_tijdstip_registratie_lv","nummeraanduidingen_tijdstip_eind_registratie_lv","pand_identificatie","pand_oorspronkelijk_bouwjaar","pand_status","pand_geconstateerd","pand_documentdatum","pand_documentnummer","pand_voorkomenidentificatie","pand_begin_geldigheid","pand_eind_geldigheid","pand_tijdstip_registratie","pand_eind_registratie","pand_tijdstip_registratie_lv","pand_tijdstip_eind_registratie_lv","openbare_ruimte_identificatie","openbare_ruimte_naam","openbare_ruimte_type","openbare_ruimte_status","openbare_ruimte_geconstateerd","openbare_ruimte_documentdatum","openbare_ruimte_documentnummer","openbare_ruimte_voorkomenidentificatie","openbare_ruimte_begin_geldigheid","openbare_ruimte_eind_geldigheid","openbare_ruimte_tijdstip_registratie","openbare_ruimte_eind_registratie","openbare_ruimte_tijdstip_registratie_lv","openbare_ruimte_tijdstip_eind_registratie_lv","openbare_ruimte_verkorte_naam","woonplaats_identificatie","woonplaats_naam","woonplaats_status","woonplaats_geconstateerd","woonplaats_documentdatum","woonplaats_documentnummer","woonplaats_voorkomenidentificatie","woonplaats_begin_geldigheid","woonplaats_eind_geldigheid","woonplaats_tijdstip_registratie","woonplaats_eind_registratie","woonplaats_tijdstip_registratie_lv","woonplaats_tijdstip_eind_registratie_lv","provincie"],"properties":{"id":{"$ref":"#/components/schemas/ID"},"dataset":{"type":"string","enum":["kadaster"],"description":"Dataset the address originates from.\\n"},"country":{"type":"string","description":" Full country names (ISO 3166)\\n","enum":["Netherlands"]},"country_iso":{"type":"string","description":" 3 letter country code (ISO 3166-1)\\n","enum":["NLD"]},"country_iso_2":{"type":"string","description":" 2 letter country code (ISO 3166-1)\\n","enum":["NL"]},"line_1":{"type":"string","description":"First address line: street name followed by house number.\\n\\nEmpty string `\\"\\"` if not available.\\n"},"language":{"type":"string","description":"Language represented by 2 letter ISO Code (639-1)\\n","enum":["nl"]},"address":{"type":"string","description":"House number, uniquely identifying the address along the specified street. Combines huisnummer, huisletter and huisnummertoevoeging.\\n\\nEmpty string `\\"\\"` if not available.\\n"},"identificatie":{"type":"string","description":"The unique identifier of a BAG verblijfsobject.\\n"},"latitude":{"$ref":"#/components/schemas/Latitude"},"longitude":{"$ref":"#/components/schemas/Longitude"},"gebruiksdoel":{"type":"string","description":"The purpose of use of the verblijfsobject. E.g. `woonfunctie` (residential), `kantoorfunctie` (office), `winkelfunctie` (retail).\\n"},"oppervlakte":{"type":"integer","description":"The floor area of the verblijfsobject in square metres.\\n"},"status":{"type":"string","description":"Verblijfsobject status. E.g. `Verblijfsobject in gebruik` (in use).\\n"},"geconstateerd":{"type":"boolean","description":"Indicates that a verblijfsobject has been included in the registry as a result of an observation, without there being a regular source document for this inclusion at the time of registration.\\n"},"documentdatum":{"type":"string","format":"date-time","description":"Date on which the verblijfsobject source document was created.\\n"},"documentnummer":{"type":"string","description":"The unique identifier of the verblijfsobject source document.\\n"},"voorkomenidentificatie":{"oneOf":[{"type":"string","enum":[""],"description":"Empty string `\\"\\"` if not available"},{"type":"integer","description":"The identifier of this instance of the verblijfsobject history.\\n"}]},"begin_geldigheid":{"type":"string","description":"The time at which a version of a verblijfsobject is valid in reality in accordance with the effective date in the source document. ISO 8601 timestamp.\\n\\nEmpty string `\\"\\"` if not available.\\n"},"eind_geldigheid":{"type":"string","description":"The time at which a version of a verblijfsobject is no longer valid in reality. ISO 8601 timestamp.\\n\\nEmpty string `\\"\\"` if not available.\\n"},"tijdstip_registratie":{"type":"string","description":"The time at which a version of a verblijfsobject is registered by the bronhouder. ISO 8601 timestamp.\\n\\nEmpty string `\\"\\"` if not available.\\n"},"eind_registratie":{"type":"string","description":"The time at which a version of a verblijfsobject is no longer valid according to the bronhouder. ISO 8601 timestamp.\\n\\nEmpty string `\\"\\"` if not available.\\n"},"tijdstip_registratie_lv":{"type":"string","description":"The time at which a version of a verblijfsobject is registered in the Landelijke Voorziening BAG. ISO 8601 timestamp.\\n\\nEmpty string `\\"\\"` if not available.\\n"},"tijdstip_eind_registratie_lv":{"type":"string","description":"The time at which a version of a verblijfsobject is no longer valid in the Landelijke Voorziening BAG. ISO 8601 timestamp.\\n\\nEmpty string `\\"\\"` if not available.\\n"},"nummeraanduidingen_identificatie":{"type":"string","description":"The unique identifier of a BAG nummeraanduidingen object.\\n\\nEmpty string `\\"\\"` if not available.\\n"},"nummeraanduidingen_huisnummer":{"type":"string","description":"The house number assigned to a nummeraanduiding object by or on behalf of the municipal council.\\n\\nEmpty string `\\"\\"` if not available.\\n"},"nummeraanduidingen_huisnummertoevoeging":{"type":"string","description":"A further addition to a house number, or to a combination of house number and house letter, granted by or on behalf of the municipal council with regard to a nummeraanduiding object.\\n\\nEmpty string `\\"\\"` if not available.\\n"},"nummeraanduidingen_huisletter":{"type":"string","description":"An addition to a house number in the form of an alphanumeric character assigned by or on behalf of the municipal council with regard to a nummeraanduiding object.\\n\\nEmpty string `\\"\\"` if not available.\\n"},"nummeraanduidingen_postcode":{"type":"string","description":"A code determined by PostNL associated with a specific combination of a street name and a house number. Normalised to `1234 AB`.\\n\\nEmpty string `\\"\\"` if not available.\\n"},"nummeraanduidingen_type_adresseerbaar_object":{"type":"string","description":"The nature of the nummeraanduiding object. Currently always `Verblijfsobject`.\\n\\nEmpty string `\\"\\"` if not available.\\n"},"nummeraanduidingen_status":{"type":"string","description":"The status of the nummeraanduiding object. E.g. `Naamgeving uitgegeven` (name issued), `Naamgeving ingetrokken` (name withdrawn).\\n\\nEmpty string `\\"\\"` if not available.\\n"},"nummeraanduidingen_geconstateerd":{"type":"boolean","description":"Indicates that a nummeraanduidingen object has been included in the registry as a result of an observation, without there being a regular source document for this inclusion at the time of registration.\\n"},"nummeraanduidingen_documentdatum":{"type":"string","description":"Date on which the nummeraanduidingen object source document was created. ISO 8601 timestamp.\\n\\nEmpty string `\\"\\"` if not available.\\n"},"nummeraanduidingen_documentnummer":{"type":"string","description":"The unique identifier of the nummeraanduidingen object source document.\\n\\nEmpty string `\\"\\"` if not available.\\n"},"nummeraanduidingen_voorkomenidentificatie":{"oneOf":[{"type":"string","enum":[""],"description":"Empty string `\\"\\"` if not available"},{"type":"integer","description":"The identifier of this instance of the nummeraanduidingen object history.\\n"}]},"nummeraanduidingen_begin_geldigheid":{"type":"string","description":"The time at which a version of a nummeraanduidingen object is valid in reality in accordance with the effective date in the source document. ISO 8601 timestamp.\\n\\nEmpty string `\\"\\"` if not available.\\n"},"nummeraanduidingen_eind_geldigheid":{"type":"string","description":"The time at which a version of a nummeraanduidingen object is no longer valid in reality. ISO 8601 timestamp.\\n\\nEmpty string `\\"\\"` if not available.\\n"},"nummeraanduidingen_tijdstip_registratie":{"type":"string","description":"The time at which a version of a nummeraanduidingen object is registered by the bronhouder. ISO 8601 timestamp.\\n\\nEmpty string `\\"\\"` if not available.\\n"},"nummeraanduidingen_eind_registratie":{"type":"string","description":"The time at which a version of a nummeraanduidingen object is no longer valid according to the bronhouder. ISO 8601 timestamp.\\n\\nEmpty string `\\"\\"` if not available.\\n"},"nummeraanduidingen_tijdstip_registratie_lv":{"type":"string","description":"The time at which a version of a nummeraanduidingen object is registered in the Landelijke Voorziening BAG. ISO 8601 timestamp.\\n\\nEmpty string `\\"\\"` if not available.\\n"},"nummeraanduidingen_tijdstip_eind_registratie_lv":{"type":"string","description":"The time at which a version of a nummeraanduidingen object is no longer valid in the Landelijke Voorziening BAG. ISO 8601 timestamp.\\n\\nEmpty string `\\"\\"` if not available.\\n"},"pand_identificatie":{"type":"string","description":"The unique identifier of a BAG pand object.\\n\\nEmpty string `\\"\\"` if not available.\\n"},"pand_oorspronkelijk_bouwjaar":{"oneOf":[{"type":"string","enum":[""],"description":"Empty string `\\"\\"` if not available"},{"type":"integer","description":"The year in which a building was, or will be, originally completed.\\n"}]},"pand_status":{"type":"string","description":"The status of the pand object. E.g. `Pand in gebruik` (building in use).\\n\\nEmpty string `\\"\\"` if not available.\\n"},"pand_geconstateerd":{"type":"boolean","description":"Indicates that a pand object has been included in the registry as a result of an observation, without there being a regular source document for this inclusion at the time of registration.\\n"},"pand_documentdatum":{"type":"string","description":"Date on which the pand object source document was created. ISO 8601 timestamp.\\n\\nEmpty string `\\"\\"` if not available.\\n"},"pand_documentnummer":{"type":"string","description":"The unique identifier of the pand object source document.\\n\\nEmpty string `\\"\\"` if not available.\\n"},"pand_voorkomenidentificatie":{"oneOf":[{"type":"string","enum":[""],"description":"Empty string `\\"\\"` if not available"},{"type":"integer","description":"The identifier of this instance of the pand object history.\\n"}]},"pand_begin_geldigheid":{"type":"string","description":"The time at which a version of a pand object is valid in reality in accordance with the effective date in the source document. ISO 8601 timestamp.\\n\\nEmpty string `\\"\\"` if not available.\\n"},"pand_eind_geldigheid":{"type":"string","description":"The time at which a version of a pand object is no longer valid in reality. ISO 8601 timestamp.\\n\\nEmpty string `\\"\\"` if not available.\\n"},"pand_tijdstip_registratie":{"type":"string","description":"The time at which a version of a pand object is registered by the bronhouder. ISO 8601 timestamp.\\n\\nEmpty string `\\"\\"` if not available.\\n"},"pand_eind_registratie":{"type":"string","description":"The time at which a version of a pand object is no longer valid according to the bronhouder. ISO 8601 timestamp.\\n\\nEmpty string `\\"\\"` if not available.\\n"},"pand_tijdstip_registratie_lv":{"type":"string","description":"The time at which a version of a pand object is registered in the Landelijke Voorziening BAG. ISO 8601 timestamp.\\n\\nEmpty string `\\"\\"` if not available.\\n"},"pand_tijdstip_eind_registratie_lv":{"type":"string","description":"The time at which a version of a pand object is no longer valid in the Landelijke Voorziening BAG. ISO 8601 timestamp.\\n\\nEmpty string `\\"\\"` if not available.\\n"},"openbare_ruimte_identificatie":{"type":"string","description":"The unique identifier of a BAG openbare ruimte object.\\n\\nEmpty string `\\"\\"` if not available.\\n"},"openbare_ruimte_naam":{"type":"string","description":"The name assigned to an openbare ruimte object by or on behalf of the municipal council. Usually the street name.\\n\\nEmpty string `\\"\\"` if not available.\\n"},"openbare_ruimte_type":{"type":"string","description":"The nature of the openbare ruimte object. E.g. `Weg` (road), `Water`, `Spoorbaan` (railway).\\n\\nEmpty string `\\"\\"` if not available.\\n"},"openbare_ruimte_status":{"type":"string","description":"The status of the openbare ruimte object. E.g. `Naamgeving uitgegeven` (name issued).\\n\\nEmpty string `\\"\\"` if not available.\\n"},"openbare_ruimte_geconstateerd":{"type":"boolean","description":"Indicates that an openbare ruimte object has been included in the registry as a result of an observation, without there being a regular source document for this inclusion at the time of registration.\\n"},"openbare_ruimte_documentdatum":{"type":"string","description":"Date on which the openbare ruimte object source document was created. ISO 8601 timestamp.\\n\\nEmpty string `\\"\\"` if not available.\\n"},"openbare_ruimte_documentnummer":{"type":"string","description":"The unique identifier of the openbare ruimte object source document.\\n\\nEmpty string `\\"\\"` if not available.\\n"},"openbare_ruimte_voorkomenidentificatie":{"oneOf":[{"type":"string","enum":[""],"description":"Empty string `\\"\\"` if not available"},{"type":"integer","description":"The identifier of this instance of the openbare ruimte object history.\\n"}]},"openbare_ruimte_begin_geldigheid":{"type":"string","description":"The time at which a version of an openbare ruimte object is valid in reality in accordance with the effective date in the source document. ISO 8601 timestamp.\\n\\nEmpty string `\\"\\"` if not available.\\n"},"openbare_ruimte_eind_geldigheid":{"type":"string","description":"The time at which a version of an openbare ruimte object is no longer valid in reality. ISO 8601 timestamp.\\n\\nEmpty string `\\"\\"` if not available.\\n"},"openbare_ruimte_tijdstip_registratie":{"type":"string","description":"The time at which a version of an openbare ruimte object is registered by the bronhouder. ISO 8601 timestamp.\\n\\nEmpty string `\\"\\"` if not available.\\n"},"openbare_ruimte_eind_registratie":{"type":"string","description":"The time at which a version of an openbare ruimte object is no longer valid according to the bronhouder. ISO 8601 timestamp.\\n\\nEmpty string `\\"\\"` if not available.\\n"},"openbare_ruimte_tijdstip_registratie_lv":{"type":"string","description":"The time at which a version of an openbare ruimte object is registered in the Landelijke Voorziening BAG. ISO 8601 timestamp.\\n\\nEmpty string `\\"\\"` if not available.\\n"},"openbare_ruimte_tijdstip_eind_registratie_lv":{"type":"string","description":"The time at which a version of an openbare ruimte object is no longer valid in the Landelijke Voorziening BAG. ISO 8601 timestamp.\\n\\nEmpty string `\\"\\"` if not available.\\n"},"openbare_ruimte_verkorte_naam":{"type":"string","description":"An abbreviated name assigned to an openbare ruimte object if its name is longer than 24 characters.\\n\\nEmpty string `\\"\\"` if not available.\\n"},"woonplaats_identificatie":{"type":"string","description":"The unique identifier of a BAG woonplaats object.\\n\\nEmpty string `\\"\\"` if not available.\\n"},"woonplaats_naam":{"type":"string","description":"The name assigned to a woonplaats object by or on behalf of the municipal council. The town or city name.\\n\\nEmpty string `\\"\\"` if not available.\\n"},"woonplaats_status":{"type":"string","description":"The status of the woonplaats object. E.g. `Woonplaats aangewezen` (place of residence designated).\\n\\nEmpty string `\\"\\"` if not available.\\n"},"woonplaats_geconstateerd":{"type":"boolean","description":"Indicates that a
1woonplaats object has been included in the registry as a result of an observation, without there being a regular source document for this inclusion at the time of registration.\\n"},"woonplaats_documentdatum":{"type":"string","description":"Date on which the woonplaats object source document was created. ISO 8601 timestamp.\\n\\nEmpty string `\\"\\"` if not available.\\n"},"woonplaats_documentnummer":{"type":"string","description":"The unique identifier of the woonplaats object source document.\\n\\nEmpty string `\\"\\"` if not available.\\n"},"woonplaats_voorkomenidentificatie":{"oneOf":[{"type":"string","enum":[""],"description":"Empty string `\\"\\"` if not available"},{"type":"integer","description":"The identifier of this instance of the woonplaats object history.\\n"}]},"woonplaats_begin_geldigheid":{"type":"string","description":"The time at which a version of a woonplaats object is valid in reality in accordance with the effective date in the source document. ISO 8601 timestamp.\\n\\nEmpty string `\\"\\"` if not available.\\n"},"woonplaats_eind_geldigheid":{"type":"string","description":"The time at which a version of a woonplaats object is no longer valid in reality. ISO 8601 timestamp.\\n\\nEmpty string `\\"\\"` if not available.\\n"},"woonplaats_tijdstip_registratie":{"type":"string","description":"The time at which a version of a woonplaats object is registered by the bronhouder. ISO 8601 timestamp.\\n\\nEmpty string `\\"\\"` if not available.\\n"},"woonplaats_eind_registratie":{"type":"string","description":"The time at which a version of a woonplaats object is no longer valid according to the bronhouder. ISO 8601 timestamp.\\n\\nEmpty string `\\"\\"` if not available.\\n"},"woonplaats_tijdstip_registratie_lv":{"type":"string","description":"The time at which a version of a woonplaats object is registered in the Landelijke Voorziening BAG. ISO 8601 timestamp.\\n\\nEmpty string `\\"\\"` if not available.\\n"},"woonplaats_tijdstip_eind_registratie_lv":{"type":"string","description":"The time at which a version of a woonplaats object is no longer valid in the Landelijke Voorziening BAG. ISO 8601 timestamp.\\n\\nEmpty string `\\"\\"` if not available.\\n"},"provincie":{"type":"string","description":"Province the address falls in, derived from the postcode.\\n\\nEmpty string `\\"\\"` if not available.\\n","enum":["Drenthe","Flevoland","Friesland","Gelderland","Groningen","Limburg","Noord-Brabant","Noord-Holland","Overijssel","Utrecht","Zeeland","Zuid-Holland",""]}},"example":{"id":"kadaster_1742010000016637|1742200000045935","dataset":"kadaster","country":"Netherlands","country_iso":"NLD","country_iso_2":"NL","line_1":"Oude Veemarkt 25","language":"nl","address":"25","identificatie":"1742010000016637","latitude":52.309501578434144,"longitude":6.524052774641579,"gebruiksdoel":"bijeenkomstfunctie","oppervlakte":532,"status":"Verblijfsobject in gebruik","geconstateerd":false,"documentdatum":"2023-11-09T00:00:00.000Z","documentnummer":"D2023167157","voorkomenidentificatie":2,"begin_geldigheid":"2023-11-09T00:00:00.000Z","eind_geldigheid":"","tijdstip_registratie":"2023-11-09T14:42:11.635Z","eind_registratie":"","tijdstip_registratie_lv":"2023-11-09T14:55:36.476Z","tijdstip_eind_registratie_lv":"","nummeraanduidingen_identificatie":"1742200000045935","nummeraanduidingen_huisnummer":"25","nummeraanduidingen_huisnummertoevoeging":"","nummeraanduidingen_huisletter":"","nummeraanduidingen_postcode":"7461 GJ","nummeraanduidingen_type_adresseerbaar_object":"Verblijfsobject","nummeraanduidingen_status":"Naamgeving uitgegeven","nummeraanduidingen_geconstateerd":false,"nummeraanduidingen_documentdatum":"2009-05-13T00:00:00.000Z","nummeraanduidingen_documentnummer":"D2009021777","nummeraanduidingen_voorkomenidentificatie":1,"nummeraanduidingen_begin_geldigheid":"2009-05-13T00:00:00.000Z","nummeraanduidingen_eind_geldigheid":"","nummeraanduidingen_tijdstip_registratie":"2010-10-22T16:46:11.000Z","nummeraanduidingen_eind_registratie":"","nummeraanduidingen_tijdstip_registratie_lv":"2010-10-25T10:37:53.434Z","nummeraanduidingen_tijdstip_eind_registratie_lv":"","pand_identificatie":"1742100000015838","pand_oorspronkelijk_bouwjaar":1920,"pand_status":"Pand in gebruik","pand_geconstateerd":false,"pand_documentdatum":"1920-05-18T00:00:00.000Z","pand_documentnummer":"2475-000V","pand_voorkomenidentificatie":1,"pand_begin_geldigheid":"1920-05-18T00:00:00.000Z","pand_eind_geldigheid":"","pand_tijdstip_registratie":"2010-10-22T16:04:09.000Z","pand_eind_registratie":"","pand_tijdstip_registratie_lv":"2010-10-25T10:34:22.804Z","pand_tijdstip_eind_registratie_lv":"","openbare_ruimte_identificatie":"1742300000000446","openbare_ruimte_naam":"Oude Veemarkt","openbare_ruimte_type":"Weg","openbare_ruimte_status":"Naamgeving uitgegeven","openbare_ruimte_geconstateerd":false,"openbare_ruimte_documentdatum":"1994-11-22T00:00:00.000Z","openbare_ruimte_documentnummer":"RSN_STR_1937-2000","openbare_ruimte_voorkomenidentificatie":1,"openbare_ruimte_begin_geldigheid":"1994-11-22T00:00:00.000Z","openbare_ruimte_eind_geldigheid":"","openbare_ruimte_tijdstip_registratie":"2010-10-22T15:40:31.000Z","openbare_ruimte_eind_registratie":"","openbare_ruimte_tijdstip_registratie_lv":"2010-10-25T10:32:44.940Z","openbare_ruimte_tijdstip_eind_registratie_lv":"","openbare_ruimte_verkorte_naam":"","woonplaats_identificatie":"1566","woonplaats_naam":"Rijssen","woonplaats_status":"Woonplaats aangewezen","woonplaats_geconstateerd":false,"woonplaats_documentdatum":"2008-12-15T00:00:00.000Z","woonplaats_documentnummer":"Raad 15-12-2008/17","woonplaats_voorkomenidentificatie":1,"woonplaats_begin_geldigheid":"2008-12-15T00:00:00.000Z","woonplaats_eind_geldigheid":"","woonplaats_tijdstip_registratie":"2010-10-22T15:40:19.000Z","woonplaats_eind_registratie":"","woonplaats_tijdstip_registratie_lv":"2010-10-25T10:32:43.439Z","woonplaats_tijdstip_eind_registratie_lv":"","provincie":"Overijssel"}},"KartverketAddress":{"title":"Norway Kartverket Address","description":"An address from Matrikkelen, Norway\'s official cadastre and address register, published by Kartverket (the Norwegian Mapping Authority).\\n\\nCovers Norway (`NOR`) and Svalbard and Jan Mayen (`SJM`). Records come from the cadastre address, apartment level and road address files, so the fields available depend on which file the address came from. Any field which is not present is returned as an empty string `\\"\\"`.","type":"object","required":["id","dataset","country","country_iso","country_iso_2","line_1","line_2","language","address","latitude","longitude","lokal_id","kommunenummer","kommunenavn","adressetype","adressetilleggsnavn","adressetilleggsnavn_kilde","adressekode","adressenavn","nummer","bokstav","gardsnummer","bruksnummer","festenummer","seksjonsnummer","undernummer","adresse_tekst","adresse_tekst_uten_adressetilleggsnavn","bruksenhet_id","bruksenhetsnummer_tekst","offisiell_adresse_tekst","offisiell_adresse_tekst_uten_adressetilleggsnavn","epsg_kode","nord","oest","postnummer","poststed","grunnkretsnummer","grunnkretsnavn","soknenummer","soknenavn","organisasjonsnummer","tettstednummer","tettstednavn","valgkretsnummer","valgkretsnavn","oppdateringsdato","datauttaksdato","adresse_id","uuid_adresse","uuid_bruksenhet","atkomst_id","uuid_atkomst","atkomst_nord","atkomst_oest","sommeratkomst_id","uuid_sommeratkomst","sommeratkomst_nord","sommeratkomst_oest","vinteratkomst_id","uuid_vinteratkomst","vinteratkomst_nord","vinteratkomst_oest","fylke","landsdel"],"properties":{"id":{"$ref":"#/components/schemas/ID"},"dataset":{"type":"string","enum":["kartverket"]},"country":{"type":"string","description":" Full country names (ISO 3166)\\n","enum":["Norway","Svalbard and Jan Mayen"]},"country_iso":{"type":"string","description":" 3 letter country code (ISO 3166-1)\\n","enum":["NOR","SJM"]},"country_iso_2":{"type":"string","description":" 2 letter country code (ISO 3166-1)\\n","enum":["NO","SJ"]},"line_1":{"type":"string","description":"First address line. `adressetilleggsnavn` where present, otherwise the official address text without it.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"line_2":{"type":"string","description":"Second address line. The official address text without `adressetilleggsnavn`, where line 1 carries that name.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"language":{"type":"string","enum":["no"],"description":"Language represented by 2 letter ISO Code (639-1)\\n"},"address":{"type":"string","description":"Number uniquely identifying the address within its street or farm. `nummer` and `bokstav` for a vegadresse, otherwise the cadastral `gardsnummer`/`bruksnummer`. Any `bruksenhetsnummer_tekst` is appended after a hyphen.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"latitude":{"$ref":"#/components/schemas/Latitude"},"longitude":{"$ref":"#/components/schemas/Longitude"},"lokal_id":{"type":"string","description":"Local identifier assigned by the data supplier.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"kommunenummer":{"type":"string","description":"Kommune (municipality) number.\\n"},"kommunenavn":{"type":"string","description":"Kommune (municipality) n
1ame.\\n"},"adressetype":{"type":"string","description":"`vegadresse` = street address, `matrikkeladresse` = land registry address\\n"},"adressetilleggsnavn":{"type":"string","description":"A local place name used in a road address.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"adressetilleggsnavn_kilde":{"type":"string","description":"Code for adressetilleggsnavn origin.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"adressekode":{"oneOf":[{"type":"string","description":"Empty string `\\"\\"` if not available"},{"type":"integer","description":"A number that uniquely identifies addressable streets, roads, paths, places and areas that are entered in the land register.\\n"}]},"adressenavn":{"type":"string","description":"Name of street, road, path, place or area entered in the land register.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"nummer":{"oneOf":[{"type":"string","description":"Empty string `\\"\\"` if not available"},{"type":"integer","description":"A number that uniquely identifies properties, facilities, buildings or entrances to buildings within an addressable street, road, path, place or area.\\n"}]},"bokstav":{"type":"string","description":"A subsequent letter that may be used in addition to a number.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"gardsnummer":{"type":"integer","description":"The number of a farm unit in the land register, unique within each municipality.\\n"},"bruksnummer":{"type":"integer","description":"A unique identification number automatically assigned to each individual unit within a farm.\\n"},"festenummer":{"oneOf":[{"type":"string","description":"Empty string `\\"\\"` if not available"},{"type":"integer","description":"The number of a fixture within a gardsnummer/bruksnummer.\\n"}]},"seksjonsnummer":{"oneOf":[{"type":"string","description":"Empty string `\\"\\"` if not available"},{"type":"integer","description":"The number of a section within a gardsnummer/bruksnummer and possibly a festenummer.\\n"}]},"undernummer":{"oneOf":[{"type":"string","description":"Empty string `\\"\\"` if not available"},{"type":"integer","description":"A sub-number within a gardsnummer, bruksnummer and festenummer.\\n"}]},"adresse_tekst":{"type":"string","description":"Official address text without bruksenhetsnummer, unique within a kommune.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"adresse_tekst_uten_adressetilleggsnavn":{"type":"string","description":"Official address text without bruksenhetsnummer and adressetilleggsnavn, unique within a kommune.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"bruksenhet_id":{"type":"string","description":"Local identifier for a unit within a building.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"bruksenhetsnummer_tekst":{"type":"string","description":"Unit number, e.g. an apartment in a multi-dwelling building.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"offisiell_adresse_tekst":{"type":"string","description":"Official address text with bruksenhetsnummer, unique within a kommune.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"offisiell_adresse_tekst_uten_adressetilleggsnavn":{"type":"string","description":"Official address text with bruksenhetsnummer and without adressetilleggsnavn, unique within a kommune.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"epsg_kode":{"type":"integer","description":"EPSG code of the coordinate reference system used by `nord` and `oest`. `25833` = EUREF89 UTM zone 33.\\n"},"nord":{"type":"string","description":"Northward (northing) coordinate of address, in the coordinate reference system given by `epsg_kode`.\\n"},"oest":{"type":"string","description":"Eastward (easting) coordinate of address, in the coordinate reference system given by `epsg_kode`.\\n"},"postnummer":{"type":"string","description":"Postal code.\\n"},"poststed":{"type":"string","description":"Name of postal town according to Posten.\\n"},"grunnkretsnummer":{"type":"string","description":"Identifier consisting of 8 digits, where the first four are the kommunenummer, the next two are the delomr\xe5denummer and the last two indicate the grunnkrets.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"grunnkretsnavn":{"type":"string","description":"Official grunnkrets name from Statistics Norway (SSB).\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"soknenummer":{"type":"string","description":"Unique 8 digit identifier of a parish.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"soknenavn":{"type":"string","description":"Parish name.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"organisasjonsnummer":{"type":"string","description":"Unique identifier of organisation in the Br\xf8nn\xf8ysund Register.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"tettstednummer":{"type":"string","description":"4 digit code for tettsted (urban settlement).\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"tettstednavn":{"type":"string","description":"Name of tettsted (urban settlement).\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"valgkretsnummer":{"oneOf":[{"type":"string","description":"Empty string `\\"\\"` if not available"},{"type":"integer","description":"Constituency code within a kommune.\\n"}]},"valgkretsnavn":{"type":"string","description":"Name of constituency.\\n\\nCan be empty string `\\"\\"` if not present.\\n"}
1,"oppdateringsdato":{"type":"string","format":"date-time","description":"Date of last change to the object data.\\n"},"datauttaksdato":{"type":"string","format":"date-time","description":"Date of extraction from database.\\n"},"adresse_id":{"type":"string","description":"Address local identifier assigned by the data supplier.\\n"},"uuid_adresse":{"type":"string","format":"uuid","description":"Address identifier realised as UUID managed by the cadastral system.\\n"},"uuid_bruksenhet":{"type":"string","description":"Unit of usage identifier realised as UUID managed by the cadastral system.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"atkomst_id":{"type":"string","description":"Local identifier for means of access to a property.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"uuid_atkomst":{"type":"string","description":"Identifier of the means of access to a property realised as UUID in the cadastral system.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"atkomst_nord":{"type":"string","description":"Northward coordinate of the means of access to a property.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"atkomst_oest":{"type":"string","description":"Eastward coordinate of the means of access to a property.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"sommeratkomst_id":{"type":"string","description":"Local identifier for means of access to a property in summer.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"uuid_sommeratkomst":{"type":"string","description":"Identifier of the means of access to a property in summer realised as UUID in the cadastral system.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"sommeratkomst_nord":{"type":"string","description":"Northward coordinate of the means of access to a property in summer.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"sommeratkomst_oest":{"type":"string","description":"Eastward coordinate of the means of access to a property in summer.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"vinteratkomst_id":{"type":"string","description":"Local identifier for means of access to a property in winter.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"uuid_vinteratkomst":{"type":"string","description":"Identifier of the means of access to a property in winter realised as UUID in the cadastral system.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"vinteratkomst_nord":{"type":"string","description":"Northward coordinate of the means of access to a property in winter.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"vinteratkomst_oest":{"type":"string","description":"Eastward coordinate of the means of access to a property in winter.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"fylke":{"type":"string","description":"Name of county. Derived from `kommunenummer`.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"landsdel":{"type":"string","description":"Name of region. Derived from `fylke`.\\n\\nCan be empty string `\\"\\"` if not present.\\n"}},"example":{"id":"kartverket_12204178!","dataset":"kartverket","country":"Norway","country_iso":"NOR","country_iso_2":"NO","line_1":"Skollerud","line_2":"278/177","language":"no","address":"278/177","latitude":60.31858180575511,"longitude":10.03680377688277,"lokal_id":"12204178","kommunenummer":"3305","kommunenavn":"Ringerike","adressetype":"matrikkeladresse","adressetilleggsnavn":"Skollerud","adressetilleggsnavn_kilde":"matrikkeladressenavn","adressekode":"","adressenavn":"","nummer":"","bokstav":"","gardsnummer":278,"bruksnummer":177,"festenummer":"","seksjonsnummer":"","undernummer":"","adresse_tekst":"Skollerud, 278/177","adresse_tekst_uten_adressetilleggsnavn":"278/177","bruksenhet_id":"","bruksenhetsnummer_tekst":"","offisiell_adresse_tekst":"","offisiell_adresse_tekst_uten_adressetilleggsnavn":"","epsg_kode":25833,"nord":"6697211.61","oest":"226005.30","postnummer":"3516","poststed":"H\xf8nefoss","grunnkretsnummer":"33050801","grunnkretsnavn":"Skollerud","soknenummer":"04070402","soknenavn":"Hval","organisasjonsnummer":"976989880","tettstednummer":"","tettstednavn":"","valgkretsnummer":11,"valgkretsnavn":"Hallingby","oppdateringsdato":"2024-01-01T00:00:00.000Z","datauttaksdato":"2024-04-15T07:59:32.000Z","adresse_id":"12204178","uuid_adresse":"3db4e8f2-fc63-5abe-9e0d-f53045166412","uuid_bruksenhet":"","atkomst_id":"","uuid_atkomst":"","atkomst_nord":"","atkomst_oest":"","sommeratkomst_id":"","uuid_sommeratkomst":"","sommeratkomst_nord":"","sommeratkomst_oest":"","vinteratkomst_id":"","uuid_vinteratkomst":"","vinteratkomst_nord":"","vinteratkomst_oest":"","fylke":"Bu
1skerud","landsdel":"\xd8stlandet"}},"SdfiAddress":{"title":"Denmark SDFI Address","description":"An address from Danmarks Adresseregister (DAR), the official Danish address register maintained by the municipalities and distributed by Styrelsen for Dataforsyning og Infrastruktur (SDFI).\\n\\nCovers both access addresses (`adgangsadresser`, a building entrance) and unit addresses (`adresser`, a flat or office within a building). Access addresses carry no floor, door, `kvh` or `adgangsadresse_*` values, which the API returns as empty strings.\\n\\nField names follow the Danish source. Fields the source spells with ASCII substitutions (`aendret`, `dor`) are returned with their Danish characters (`\xe6ndret`, `d\xf8r`).","type":"object","required":["id","dataset","country","country_iso","country_iso_2","address","line_1","line_2","language","latitude","longitude","adresse_id","kvhx","kvh","adgangsadresse","status","darstatus","oprettet","\xe6ndret","ikrafttr\xe6delse","nedlagt","vejkode","vejnavn","adresseringsvejnavn","husnr","etage","d\xf8r","supplerendebynavn_dagi_id","supplerendebynavn","postnr","postnrnavn","stormodtagerpostnr","stormodtagerpostnrnavn","betegnelse","adressepunkt\xe6ndringsdato","etrs89koordinat_\xf8st","etrs89koordinat_nord","wgs84koordinat_bredde","wgs84koordinat_l\xe6ngde","h\xf8jde","n\xf8jagtighed","kilde","tekniskstandard","tekstretning","ddkn_m100","ddkn_km1","ddkn_km10","kommunekode","kommunenavn","landsdelsnuts3","landsdelsnavn","regionskode","regionsnavn","afstemningsomr\xe5denummer","afstemningsomr\xe5denavn","menighedsr\xe5dsafstemningsomr\xe5denummer","menighedsr\xe5dsafstemningsomr\xe5denavn","opstillingskredskode","opstillingskredsnavn","storkredsnummer","storkredsnavn","valglandsdelsbogstav","valglandsdelsnavn","sognekode","sognenavn","politikredskode","politikredsnavn","retskredskode","retskredsnavn","jordstykke_ejerlavkode","jordstykke_ejerlavnavn","jordstykke_matrikelnr","jordstykke_esrejendomsnr","ejerlavkode","ejerlavnavn","matrikelnr","esrejendomsnr","zone","brofast","adgangsadresseid","adgangspunktid","navngivenvej_id","adgangsadresse_status","adgangsadresse_darstatus","adgangsadresse_oprettet","adgangsadresse_\xe6ndret","adgangsadresse_ikrafttr\xe6delse","adgangsadresse_nedlagt","vejpunkt_id","vejpunkt_\xe6ndret","vejpunkt_kilde","vejpunkt_n\xf8jagtighed","vejpunkt_tekniskstandard","vejpunkt_x","vejpunkt_y"],"properties":{"id":{"$ref":"#/components/schemas/ID"},"dataset":{"type":"string","enum":["sdfi"]},"country":{"type":"string","description":" Full country names (ISO 3166)\\n","enum":["Denmark"]},"country_iso":{"type":"string","description":" 3 letter country code (ISO 3166-1)\\n","enum":["DNK"]},"country_iso_2":{"type":"string","description":" 2 letter country code (ISO 3166-1)\\n","enum":["DK"]},"address":{"type":"string","description":"House number uniquely identifying the address along the street. Same value as `husnr`.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"line_1":{"type":"string","description":"First address line: street name and house number, followed by floor and door for a unit address.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"line_2":{"type":"string","description":"Second address line: the supplementary city name (`supplerendebynavn`) where present.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"language":{"enum":["da"],"description":"Language represented by 2 letter ISO Code (639-1)\\n"},"latitude":{"$ref":"#/components/schemas/Latitude"},"longitude":{"$ref":"#/components/schemas/Longitude"},"adresse_id":{"type":"string","description":"Unique address identifier assigned by the data supplier.\\n"},"kvhx":{"type":"string","description":"Unique composite key for the address, containing codes for the municipality, road section, house number, floor and door.\\n"},"kvh":{"type":"string","description":"Composite key for the address, containing codes for the municipality, road section and house number.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"adgangsadresse":{"type":"boolean","description":"Indicates whether the address is an access address.\\n"},"status":{"type":"string","description":"`1` = final address, `3` = provisional address.\\n"},"darstatus":{"type":"string","description":"Status of the address indicated by the status code in Danmarks Adresseregister (DAR): `2` = provisional, `3` = valid, `4` = retired, `5` = suspended.\\n"},"oprettet":{"type":"string","description":"Date and time of address creation in Danmarks Adresseregister (DAR).\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"\xe6ndret":{"type":"string","description":"Date and time of the last change to the address in Danmarks Adresseregister (DAR).\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"ikrafttr\xe6delse":{"type":"string","description":"Date and time at which the address became valid.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"nedlagt":{"type":"string","description":"Date and time from which the address is retired or suspended (may be in the future).\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"vejkode":{"type":"string","description":"Four digit street identifier.\\n"},"vejnavn":{"type":"string","description":"Street name.\\n"},"adresseringsvejnavn":{"type":"string","description":"A possibly shortened version of the street name of no more than 20 characters, used where there is no space for the full street name.\\n"},"husnr":{"type":"string","description":"House number.\\n"},"etage":{"type":"string","description":"Floor designation.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"d\xf8r":{"type":"string","description":"Door designation.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"supplerendebynavn_dagi_id":{"type":"string","description":"Unique identifier in Danmarks Administrative Geografiske Inddeling (DAGI) of the supplementary town or city name.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"supplerendebynavn":{"type":"string","description":"Supplementary city name.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"postnr":{"type":"string","description":"Postal code.\\n"},"postnrnavn":{"type":"string","description":"The city or district name associated with the postal code.\\n"},"stormodtagerpostnr":{"type":"string","description":"Bulk recipient postal code (company postal code) which is associated with the address.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"stormodtagerpostnrnavn":{"type":"string","description":"The city or district name associated with the bulk recipient postal code.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"betegnelse":{"type":"string","description":"Full text of postal address.\\n"},"adressepunkt\xe6ndringsdato":{"type":"string","description":"Date and time of the last change to the address point.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"etrs89koordinat_\xf8st":{"type":"string","description":"Easting coordinate for the address in the ETRS89 system.\\n"},"etrs89koordinat_nord":{"type":"string","description":"Northing coordinate for the address in the ETRS89 system.\\n"},"wgs84koordinat_bredde":{"description":"Latitude of the address in the WGS84 system.\\n\\nCan be empty string `\\"\\"` if not present.\\n","oneOf":[{"type":"string"},{"type":"number","minimum":-90,"maximum":90}]},"wgs84koordinat_l\xe6ngde":{"description":"Longitude of the address in the WGS84 system.\\n\\nCan be empty string `\\"\\"` if not present.\\n","oneOf":[{"type":"string"},{"type":"number","minimum":-180,"maximum":180}]},"h\xf8jde":{"type":"string","description":"Height in metres from the mean water level in the seas on Denmark\'s coasts to ground level at the address, calculated according to the Danish Vertical Reference 1990 (DVR90).\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"n\xf8jagtighed":{"type":"string","description":"Code indicating the accuracy of the address point. `A` = accurate to within 2 metres, `B` = accurate to within 100 metres, `U` = no address point.\\n"},"kilde":{"type":"string","description":"Code indicating the source of the address point.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"tekniskstandard":{"type":"string","description":"Technical classification code for the location of an address point.\\n"},"tekstretning":{"type":"string","description":"Orientation for an address in gons, where a full circle is divided into 400 gons.\\n"},"ddkn_m100":{"type":"string","description":"Identifier of the 100m cell in which the address is located in Det Danske Kvadratnet (DDKN).\\n"},"ddkn_km1":{"type":"string","description":"Identifier of the 1km cell in which the address is located in Det Danske Kvadratnet (DDKN).\\n"},"ddkn_km10":{"type":"string","description":"Identifier of the 10km cell in which the address is located in Det Danske Kvadratnet (DDKN).\\n"},"kommunekode":{"type":"string","description":"Four digit identifier of the municipality in which the address is located.\\n"},"kommunenavn":{"type":"string","description":"Name of the municipality in which the address is located.\\n"},"landsdelsnuts3":{"type":"string","description":"NUTS 3 code of the province in which the address is located.\\n"},"landsdelsnavn":{"type":"string","description":"Name of the province in which the address is located.\\n"},"regionskode":{"type":"string","description":"Four digit identifier of the region in which the address is located.\\n"},"regionsnavn":{"type":"string","description":"Name of the region in which the address is located.\\n"},"afstemningsomr\xe5denummer":{"type":"string","description":"Identifier of the polling district in which the address is located.\\n"},"afstemningsomr\xe5denavn":{"type":"string","description":"Unique name of the polling district in which the address is located.\\n"},"menighedsr\xe5dsafstemningsomr\xe5denummer":{"type":"string","description":"Identifier of the parish council polling district in which the address is located.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"menighedsr\xe5dsafstemningsomr\xe5denavn":{"type":"string","description":"Name of the parish council polling district in which the address is located.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"opstillingskredskode":{"type":"string","description":"Identifier of the local electoral district in which the address is located.\\n"},"opstillingskredsnavn":{"type":"string","description":"Name of the local electoral district in which the address is located.\\n"},"storkredsnummer":{"type":"string","description":"Identifier of the regional electoral district in which the address is located.\\n"},"storkredsnavn":{"type":"string","description":"Name of the regional electoral district in which the address is located.\\n"},"valglandsdelsbogstav":{"type":"string","description":"Letter identifier of the national electoral district in which the address is located: `A`, `B` or `C`.\\n"},"valglandsdelsnavn":{"type":"string","description":"Name of the national electoral district in which the address is located.\\n"},"sognekode":{"type":"string","description":"Identifier of the parish in which the address is located.\\n"},"sognenavn":{"type":"string","description":"Name of the parish in which the address is located.\\n"},"politikredskode":{"type":"string","description":"Identifier of the police district in which the address is located.\\n"},"politikredsnavn":{"type":"string","description":"Name of the police district in which the address is located.\\n"},"retskredskode":{"type":"string","description":"Four digit identifier of the judicial district in which the address is located.\\n"},"retskredsnavn":{"type":"string","description":"Name of the judicial district in which the address is located.\\n"},"jordstykke_ejerlavkode":{"type":"string","description":"Identifier of a cadastral unit with a single owner.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"jordstykke_ejerlavnavn":{"type":"string","description":"Name of a cadastral unit with a single owner.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"jordstykke_matrikelnr":{"type":"string","description":"Cadastre identifier for the plot of land on which the address is located, consisting of up to 7 characters.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"jordstykke_esrejendomsnr":{"type":"string","description":"Identifier for the property from the Ejendomsstamregisteret (ESR) property register, corresponding to the plot of land associated with the address, consisting of up to 7 characters.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"ejerlavkode":{"type":"string","description":"Identifier of a cadastral unit with a single owner (deprecated).\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"ejerlavnavn":{"type":"string","description":"Name of a cadastral unit with a single owner (deprecated).\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"matrikelnr":{"type":"string","description":"Cadastre identifier for the plot of land on which the address is located, consisting of up to 7 characters.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"esrejendomsnr":{"type":"string","description":"Identifier for the property from the Ejendomsstamregisteret (ESR) property register, corresponding to the plot of land associated with the address, consisting of up to 7 characters.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"zone":{"type":"string","description":"Status of the address zone: `Byzone`, `Sommerhusomr\xe5de` or `Landzone`.\\n"},"brofast":{"type":"boolean","description":"Indicates whether the address is connected by a bridge.\\n"},"adgangsadresseid":{"type":"string","description":"Identifier of the access address associated with the address.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"adgangspunktid":{"type":"string","description":"Identifier of the access point for the address.\\n"},"navngivenvej_id":{"type":"string","description":"Identifier of the named road on which the access address is located.\\n"},"adgangsadresse_status":{"type":"string","description":"Status of the access address associated with the address: `1` = final address, `3` = provisional address.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"adgangsadresse_darstatus":{"type":"string","description":"Status of the access address indicated by the status code in Danmarks Adresseregister (DAR): `2` = provisional, `3` = valid, `4` = retired, `5` = suspended.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"adgangsadresse_oprettet":{"type":"string","description":"Date and time of the creation of the access address associated with the address.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"adgangsadresse_\xe6ndret":{"type":"string","description":"Date and time of the last change to the access address associated with the address.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"adgangsadresse_ikrafttr\xe6delse":{"type":"string","description":"Date and time at which the access address became valid.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"adgangsadresse_nedlagt":{"type":"string","description":"Date and time from which the access address is retired or suspended (may be in the future).\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"vejpunkt_id":{"type":"string","description":"Unique identifier of the geographic point on the road network that represents the starting point of the access route leading to the access point for the address.\\n"},"vejpunkt_\xe6ndret":{"type":"string","description":"Date and time of the last change in Danmarks Adresseregister (DAR) to the geographic point on the road network that represents the starting point of the access route leading to the access point for the address.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"vejpunkt_kilde":{"type":"string","description":"Source of the geographic point on the road network that represents the starting point of the access route leading to the access point for the address.\\n"},"vejpunkt_n\xf8jagtighed":{"type":"string","description":"Accuracy of the geographic point on the road network that represents the starting point of the access route leading to the access point for the address: `A` = exact, `B` = approximate.\\n"},"vejpunkt_tekniskstandard":{"type":"string","description":"Technical classification code for the geographic point on the road net
1work that represents the starting point of the access route leading to the access point for the address.\\n"},"vejpunkt_x":{"type":"string","description":"Longitude in the WGS84 system of the geographic point on the road network that represents the starting point of the access route leading to the access point for the address.\\n"},"vejpunkt_y":{"type":"string","description":"Latitude in the WGS84 system of the geographic point on the road network that represents the starting point of the access route leading to the access point for the address.\\n"}},"example":{"id":"sdfi_0a3f50a5-1d3e-32b8-e044-0003ba298018","dataset":"sdfi","country":"Denmark","country_iso":"DNK","country_iso_2":"DK","address":"3","line_1":"Bakkevej 3, 2. tv","line_2":"Pindstrup","language":"da","latitude":56.3086,"longitude":10.4917,"adresse_id":"0a3f50a5-1d3e-32b8-e044-0003ba298018","kvhx":"07060092___3__2__tv","kvh":"07060092___3","adgangsadresse":false,"status":"1","darstatus":"3","oprettet":"2000-02-05T20:34:00.000Z","\xe6ndret":"2018-11-02T12:15:00.000Z","ikrafttr\xe6delse":"2000-02-05T00:00:00.000Z","nedlagt":"","vejkode":"0092","vejnavn":"Bakkevej","adresseringsvejnavn":"Bakkevej","husnr":"3","etage":"2","d\xf8r":"tv","supplerendebynavn_dagi_id":"580362","supplerendebynavn":"Pindstrup","postnr":"8550","postnrnavn":"Ryomg\xe5rd","stormodtagerpostnr":"","stormodtagerpostnrnavn":"","betegnelse":"Bakkevej 3, 2. tv, Pindstrup, 8550 Ryomg\xe5rd","adressepunkt\xe6ndringsdato":"2010-05-12T00:00:00.000Z","etrs89koordinat_\xf8st":"592180.45","etrs89koordinat_nord":"6256980.12","wgs84koordinat_bredde":56.3086,"wgs84koordinat_l\xe6ngde":10.4917,"h\xf8jde":"40.5","n\xf8jagtighed":"A","kilde":"5","tekniskstandard":"TN","tekstretning":"200.00","ddkn_m100":"100m_62569_5921","ddkn_km1":"1km_6256_592","ddkn_km10":"10km_625_59","kommunekode":"0706","kommunenavn":"Syddjurs","landsdelsnuts3":"DK042","landsdelsnavn":"\xd8stjylland","regionskode":"1082","regionsnavn":"Region Midtjylland","afstemningsomr\xe5denummer":"05","afstemningsomr\xe5denavn":"Pindstrup","menighedsr\xe5dsafstemningsomr\xe5denummer":"","menighedsr\xe5dsafstemningsomr\xe5denavn":"","opstillingskredskode":"0058","opstillingskredsnavn":"Djurs","storkredsnummer":"10","storkredsnavn":"\xd8stjyllands","valglandsdelsbogstav":"C","valglandsdelsnavn":"Midtjylland-Nordjylland","sognekode":"8271","sognenavn":"Marie Magdalene","politikredskode":"1461","politikredsnavn":"\xd8stjyllands Politi","retskredskode":"1174","retskredsnavn":"Retten i Randers","jordstykke_ejerlavkode":"1230651","jordstykke_ejerlavnavn":"Pindstrup By, Marie Magdalene","jordstykke_matrikelnr":"7ab","jordstykke_esrejendomsnr":"","ejerlavkode":"1230651","ejerlavnavn":"Pindstrup By, Marie Magdalene","matrikelnr":"7ab","esrejendomsnr":"","zone":"Byzone","brofast":true,"adgangsadresseid":"0a3f508e-1c2b-32b8-e044-0003ba298018","adgangspunktid":"0a3f7001-3b2c-32b8-e044-0003ba298018","navngivenvej_id":"0a3f7002-4c3d-32b8-e044-0003ba298018","adgangsadresse_status":"1","adgangsadresse_darstatus":"3","adgangsadresse_oprettet":"2000-02-05T20:34:00.000Z","adgangsadresse_\xe6ndret":"2018-11-02T12:15:00.000Z","adgangsadresse_ikrafttr\xe6delse":"2000-02-05T00:00:00.000Z","adgangsadresse_nedlagt":"","vejpunkt_id":"0a3f7003-5d4e-32b8-e044-0003ba298018","vejpunkt_\xe6ndret":"2019-03-14T09:20:00.000Z","vejpunkt_kilde":"Ekstern","vejpunkt_n\xf8jagtighed":"A","vejpunkt_tekniskstandard":"V0","vejpunkt_x":"10.49141","vejpunkt_y":"56.30833"}},"CannarAddress":{"title":"Canada NAR Address","description":"A Canadian civic address from the National Address Register (NAR), published by Statistics Canada under the Statistics Canada Open Licence. Each address carries its civic number, street, municipality, province and postal code, a point coordinate, and its census subdivision, federal electoral district and economic region, in English and French. Statistics Canada publishes around 17.2 million addresses and refreshes them annually. 99.5% carry a full postal code and 95.7% carry a latitude and longitude.\\n\\nConventions:\\n\\n- One record per address. `id` is `cannar_` followed by `addr_guid`, a pipe and the language code (`cannar_<addr_guid>|en`). The suffix selects the English or French form of the record, so preserve it verbatim when resolving an address.\\n- `language` is `en` or `fr`. The API derives it rather than reading it from the file: a French street type gives `fr`, and the types both languages share (`AV`, `PROM`, `ROUTE`, `RTE`) give `fr` in Quebec and New Brunswick and `en` elsewhere. An address appears under one language only. There is no paired English and French copy of the same record. The `csd_*`, `fed_*` and `er_*` name pairs are returned in both languages whatever the record\'s `language`.\\n- `line_1` is the number and street. A hyphen joins the apartment or suite number to the civic number (`306-1 Finch Bay`). A letter civic number suffix joins without a space (`5A`), a numeric one with a space (`1 1/2`). The street comes from the `mail_street_*` fields where `mail_street_name` is present and from the `official_street_*` fields otherwise. In English the street type follows the name (`Iron Horse Dr`), except `Route`, which precedes it. In French the type is lower cased and precedes the name (`rue d\'Andermatt`).\\n- `line_2` carries the PO Box or Rural Route line from `bu_n_civic_add` (`PO Box 377`, `RR 4`). There is no third line. `address` is the number component of `line_1` on its own, apartment included (`5A`, `306-1`).\\n- The API title cases `mail_street_name`, `mail_street_type`, `mail_mun_name` and `official_street_type`. Every other text field is as Statistics Canada ships it, so `mail_prov_abvn`, `mail_postal_code`, `mail_street_dir` and `official_street_dir` stay upper case and the `csd_*`, `fed_*` and `er_*` names keep their supplied case.\\n- No field is null. A value absent upstream is an empty string `\\"\\"`, including `latitude` and `longitude` where the location has no coordinate.\\n- `latitude` and `longitude` repeat `reppoint_latitude` and `reppoint_longitude`: the WGS84 representative point of the location record, shared by every address at the same `loc_guid`. `bg_x` and `bg_y` are the building\'s coordinates in EPSG:3347, returned as strings.\\n","type":"object","required":["id","dataset","country","country_iso","country_iso_2","language","address","line_1","line_2","latitude","longitude","loc_guid","addr_guid","apt_no_label","civic_no","civic_no_suffix","official_street_name","official_street_type","official_street_dir","prov_code","csd_eng_name","csd_fre_name","csd_type_eng_code","csd_type_fre_code","mail_street_name","mail_street_type","mail_street_dir","mail_mun_name","mail_prov_abvn","mail_postal_code","bg_dls_lsd","bg_dls_qtr","bg_dls_sctn","bg_dls_twnshp","bg_dls_rng","bg_dls_mrd","bg_x","bg_y","bu_n_civic_add","bu_use","csd_code","fed_code","fed_eng_name","fed_fre_name","er_code","er_eng_name","er_fre_name","reppoint_latitude","reppoint_longitude"],"properties":{"id":{"$ref":"#/components/schemas/ID"},"dataset":{"type":"string","enum":["cannar"]},"country":{"type":"string","description":" Full country names (ISO 3166)\\n","enum":["Canada"]},"country_iso":{"type":"string","description":" 3 letter country code (ISO 3166-1)\\n","enum":["CAN"]},"country_iso_2":{"type":"string","description":" 2 letter country code (ISO 3166-1)\\n","enum":["CA"]},"language":{"type":"string","enum":["en","fr"],"description":"Language represented by 2 letter ISO Code (639-1)\\n"},"address":{"type":"string","description":"House number, prefixed with the apartment or suite number and a hyphen where one is present. E.g. `1425` or `10-123 1/2`.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"line_1":{"type":"string","description":"First address line. House number and street.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"line_2":{"type":"string","description":"Second address line. Carries the PO Box or Rural Route delivery information where present.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"latitude":{"$ref":"#/components/schemas/Latitude"},"longitude":{"$ref":"#/components/schemas/Longitude"},"loc_guid":{"type":"string","description":"Globally unique identifier for location.\\n"},"addr_guid":{"type":"string","description":"Globally unique identifier for address.\\n"},"apt_no_label":{"type":"string","description":"Apartment or suite number.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"civic_no":{"type":"string","description":"The building number assigned to the address.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"civic_no_suffix":{"type":"string","description":"A suffix attached to the civic number. E.g. `A` or `1/2`.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"official_street_name":{"type":"string","description":"Official street name.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"official_street_type":{"type":"string","description":"Official street designator. E.g. `St`, `Ave`.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"official_street_dir":{"type":"string","description":"Official street direction. E.g. `N`, `SE`.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"prov_code":{"type":"string","description":"Province code. E.g. `59` for British Columbia.\\n"},"csd_eng_name":{"type":"string","description":"Census subdivision English name.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"csd_fre_name":{"type":"string","description":"Census subdivision French name.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"csd_type_eng_code":{"type":"string","description":"English code indicating the type of Census Subdivision.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"csd_type_fre_code":{"type":"string","description":"French code indicating the type of Census Subdivision.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"mail_street_name":{"type":"string","description":"Name of the street used in the mailing address.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"mail_street_type":{"type":"string","description":"Designator of the street used in the mailing address.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"mail_street_dir":{"type":"string","description":"Direction of the street used in the mailing address.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"mail_mun_name":{"type":"string","description":"Municipality name used in the mailing address.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"mail_prov_abvn":{"type":"string","description":"Province abbreviation used in the mailing address.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"mail_postal_code":{"type":"string","description":"Postal code used in the mailing address. Returned as supplied by the provider, without a space between the forward sortation area and local delivery unit.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"bg_dls_lsd":{"type":"string","description":"Legal Subdivision number within the Dominion Land Survey system for the address location.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"bg_dls_qtr":{"type":"string","description":"Quarter section within a section of the Dominion Land Survey system for the address location.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"bg_dls_sctn":{"type":"string","description":"Section number within a township of the Dominion Land Survey system for the address location.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"bg_dls_twnshp":{"type":"string","description":"Township number within the Dominion Land Survey system for the address location.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"bg_dls_rng":{"type":"string","description":"Range number within a meri
1dian of the Dominion Land Survey system for the address location.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"bg_dls_mrd":{"type":"string","description":"Meridian number within the Dominion Land Survey system for the address location.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"bg_x":{"type":"string","description":"X coordinate of the building in the EPSG:3347 projected grid, in metres, returned as a string.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"bg_y":{"type":"string","description":"Y coordinate of the building in the EPSG:3347 projected grid, in metres, returned as a string.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"bu_n_civic_add":{"type":"string","description":"Additional delivery information for the mailing address, such as a PO Box or Rural Route. Upper cased, with the first `BOX` token recased to `Box` (`PO Box 377`).\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"bu_use":{"type":"string","description":"Building usage code.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"csd_code":{"type":"string","description":"Unique identifier code for a Census Subdivision (CSD).\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"fed_code":{"type":"string","description":"Unique identifier code for a federal electoral district.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"fed_eng_name":{"type":"string","description":"Name of the federal electoral district in English.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"fed_fre_name":{"type":"string","description":"Name of the federal electoral district in French.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"er_code":{"type":"string","description":"Unique identifier code for an economic region.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"er_eng_name":{"type":"string","description":"Name of the economic region in English.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"er_fre_name":{"type":"string","description":"Name of the economic region in French.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"reppoint_latitude":{"$ref":"#/components/schemas/Latitude"},"reppoint_longitude":{"$ref":"#/components/schemas/Longitude"}},"example":{"id":"cannar_9b7d2a10-5c31-4a6e-8f21-7d0c5e4b3a12|en","dataset":"cannar","country":"Canada","country_iso":"CAN","country_iso_2":"CA","language":"en","address":"1425","line_1":"1425 James St","line_2":"PO Box 4001 STN A","latitude":48.4283,"longitude":-123.355,"loc_guid":"1c3f0f4e-0d4a-4f2c-9c9d-3f9a1b2c4d5e","addr_guid":"9b7d2a10-5c31-4a6e-8f21-7d0c5e4b3a12","apt_no_label":"","civic_no":"1425","civic_no_suffix":"","official_street_name":"James","official_street_type":"St","official_street_dir":"","prov_code":"59","csd_eng_name":"Victoria","csd_fre_name":"Victoria","csd_type_eng_code":"CY","csd_type_fre_code":"V","mail_street_name":"James","mail_street_type":"St","mail_street_dir":"","mail_mun_name":"Victoria","mail_prov_abvn":"BC","mail_postal_code":"V8X3X4","bg_dls_lsd":"","bg_dls_qtr":"","bg_dls_sctn":"","bg_dls_twnshp":"","bg_dls_rng":"","bg_dls_mrd":"","bg_x":"3958372.7","bg_y":"1908456.3","bu_n_civic_add":"PO Box 4001 STN A","bu_use":"1","csd_code":"5917034","fed_code":"59034","fed_eng_name":"Victoria","fed_fre_name":"Victoria","er_code":"5910","er_eng_name":"Vancouver Island and Coast","er_fre_name":"\xcele de Vancouver et la c\xf4te","reppoint_latitude":48.4283,"reppoint_longitude":-123.355}},"FodbosaAddress":{"title":"Belgium FOD BOSA Address","description":"A Belgian address from BeSt Address, the open address register published by FOD BOSA (Federal Public Service Policy and
1Support), covering Flanders, Wallonia and the Brussels Capital Region. Each address carries its street, house number and, where one exists, box number, the municipality (`municipality_id` is the NIS code), `postcode`, `region_code` and coordinates in both WGS84 (`epsg_4326_*`, mirrored as numeric `latitude` and `longitude`) and Belgian Lambert 72 (`epsg_31370_*`, in metres). Street, municipality and post town names come in Dutch, French and German. FOD BOSA publishes around 6.6 million current addresses and refreshes them weekly.\\n\\nConventions:\\n\\n- One record per address point per language. The API emits an address once for each language in which it has a street name, or, for the few rows with no street name in any language, each language in which it has a municipality name. A bilingual Brussels address therefore exists as both a Dutch and a French record, sharing `address_id` but differing in `id`, `language` and `line_1`. `id` is `fodbosa_` followed by `address_id`, `street_id`, `municipality_id` and the language code, pipe separated (`fodbosa_1000000|3048|21007|fr`). The resolve endpoints read the trailing language code to find the record.\\n- Every property is always present. A value the register does not hold is an empty string `\\"\\"`, never null. `latitude` and `longitude` are empty strings when the WGS84 pair does not parse.\\n- `line_1` is the street name and `house_number` joined by a space, with the box number appended after ` - ` and prefixed `bus` in Dutch and German or `bo\xeete` in French: `rue Rodenbach 5 - bo\xeete bt08`. Absent parts are dropped with their separator. There are no further address lines.\\n- `streetname_*` and `municipality_name_*` keep FOD BOSA\'s casing. `postname_*` is title cased because the register supplies it in upper case (`GENT` becomes `Gent`). The street name inside `line_1` is normalised further: double quotes and a trailing parenthetical are removed, and in French the leading street type is lower cased, so a `streetname_fr` of `Rue Rodenbach` appears in `line_1` as `rue Rodenbach`.\\n- Only `current` addresses are indexed. The register\'s `proposed`, `retired` and `rejected` records, around 7% of the file, are not served.\\n- FOD BOSA re-surveys address points between vintages, so a coordinate can move by a metre or so between weekly refreshes.\\n","type":"object","required":["id","dataset","country","country_iso","country_iso_2","language","address","line_1","latitude","longitude","epsg_31370_x","epsg_31370_y","epsg_4326_lat","epsg_4326_lon","address_id","box_number","house_number","municipality_id","municipality_name_de","municipality_name_fr","municipality_name_nl","postcode","postname_fr","postname_nl","street_id","streetname_de","streetname_fr","streetname_nl","region_code","status"],"properties":{"id":{"$ref":"#/components/schemas/ID"},"dataset":{"type":"string","description":"Dataset the address originates from.\\n","enum":["fodbosa"]},"country":{"type":"string","description":" Full country names (ISO 3166)\\n","enum":["Belgium"]},"country_iso":{"type":"string","description":" 3 letter country code (ISO 3166-1)\\n","enum":["BEL"]},"country_iso_2":{"type":"string","description":" 2 letter country code (ISO 3166-1)\\n","enum":["BE"]},"language":{"type":"string","enum":["de","fr","nl"],"description":"Language represented by 2 letter ISO Code (639-1)\\n"},"address":{"type":"string","description":"House number, duplicated from `house_number` for consistency with other datasets. It does not identify the address on its own: boxes on the same number differ only by `box_number`.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"line_1":{"type":"string","description":"First address line. Street name, house number and, where present, box number, rendered in the address language.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"latitude":{"$ref":"#/components/schemas/Latitude"},"longitude":{"$ref":"#/components/schemas/Longitude"},"epsg_31370_x":{"type":"string","description":"X coordinate of the address in the BD72 / Belgian Lambert 72 (EPSG:31370) coordinate system.\\n"},"epsg_31370_y":{"type":"string","description":"Y coordinate of the address in the BD72 / Belgian Lambert 72 (EPSG:31370) coordinate system.\\n"},"epsg_4326_lat":{"type":"string","description":"Latitude of the address in the WGS84 (EPSG:4326) co
1ordinate system. String form of `latitude`.\\n"},"epsg_4326_lon":{"type":"string","description":"Longitude of the address in the WGS84 (EPSG:4326) coordinate system. String form of `longitude`.\\n"},"address_id":{"type":"string","description":"Address local identifier assigned by the data supplier.\\n\\nNot unique on its own - the three regional files each number from scratch, so the same identifier can appear once per region. Use `id`, or `(address_id, street_id, municipality_id)`, to identify an address.\\n"},"box_number":{"type":"string","description":"Box or apartment number.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"house_number":{"type":"string","description":"House number.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"municipality_id":{"type":"string","description":"Municipality local identifier (NIS code) assigned by the data supplier.\\n"},"municipality_name_de":{"type":"string","description":"Municipality name in German.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"municipality_name_fr":{"type":"string","description":"Municipality name in French.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"municipality_name_nl":{"type":"string","description":"Municipality name in Dutch.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"postcode":{"type":"string","description":"Postal code. 4 digits, first digit non-zero.\\n"},"postname_fr":{"type":"string","description":"Post town name in French.\\n\\nCan be empty string `\\"\\"` if not present. Brussels Capital Region addresses carry no post names - use `municipality_name_fr` instead.\\n"},"postname_nl":{"type":"string","description":"Post town name in Dutch.\\n\\nCan be empty string `\\"\\"` if not present. Brussels Capital Region addresses carry no post names - use `municipality_name_nl` instead.\\n"},"street_id":{"type":"string","description":"Street local identifier assigned by the data supplier.\\n"},"streetname_de":{"type":"string","description":"Street name in German.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"streetname_fr":{"type":"string","description":"Street name in French.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"streetname_nl":{"type":"string","description":"Street name in Dutch.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"region_code":{"type":"string","description":"ISO 3166-2 code of the region in which the address is located. One of `BE-BRU` (Brussels Capital Region), `BE-VLG` (Flanders) or `BE-WAL` (Wallonia).\\n"},"status":{"type":"string","description":"Address lifecycle status assigned by the data supplier. Only `current` addresses are indexed and served, so this is always `current`. The supplier\'s remaining codes (`proposed`, `reserved`, `retired`, `rejected`) are filtered out.\\n"}},"example":{"id":"fodbosa_1000000|3048|21007|fr","dataset":"fodbosa","country":"Belgium","country_iso":"BEL","country_iso_2":"BE","language":"fr","address":"5","line_1":"rue Rodenbach 5 - bo\xeete bt08","latitude":50.82029,"longitude":4.34422,"epsg_31370_x":"148270.73200","epsg_31370_y":"167761.35000","epsg_4326_lat":"50.82029","epsg_4326_lon":"4.34422","address_id":"1000000","box_number":"bt08","house_number":"5","municipality_id":"21007","municipality_name_de":"","municipality_name_fr":"Forest","municipality_name_nl":"Vorst","postcode":"1190","postname_fr":"","postname_nl":"","street_id":"3048","streetname_de":"","streetname_fr":"Rue Rodenbach","streetname_nl":"Rodenbachstraat","region_code":"BE-BRU","status":"current"}},"MoisAddress":{"title":"South Korea MOIS Address","type":"object","description":"A South Korean road name address (\ub3c4\ub85c\uba85\uc8fc\uc18c) as published by the Ministry of the Interior and Safety (MOIS).\\n\\nEvery address is indexed twice, once in Hangul and once in Revised Romanization. `line_1` and `line_2` follow the language of the matched document; the API returns the underlying MOIS fields under their original Hangul names.\\n\\nKorean-named fields are empty strings when the source record does not carry a value.\\n","required":["id","dataset","country","country_iso","country_iso_2","language","address","line_1","line_2","city","province","\ubc95\uc815\uc74d\uba74\ub3d9\uba85","\ubc95\uc815\ub3d9\ucf54\ub4dc","\ubc95\uc815\ub9ac\uba85","\ube44\uace01","\ube44\uace02","\ubcc0\ub3d9\uc804\ub3c4\ub85c\uba85\uc8fc\uc18c","\ubcc0\uacbd\uc774\ub825\uc815\ubcf4","\ubcc0\uacbd\uc774\ub825\uc0ac\uc720","\ubcc0\uacbd\uc804_\ub3c4\ub85c\uba85\uc8fc\uc18c","\ubcc0\uacbd\uc0ac\uc720","\ubcc0\uacbd\uc0ac\uc720\ucf54\ub4dc","\uce35\uc77c\ub828\ubc88\ud638","\uce35\uba85\uce6d","\ub300\ud45c\uc9c0\ubc88\uc5ec\ubd80","\ub300\ud45c\uc5ec\ubd80","\ub2e4\ub7c9\ubc30\ub2ec\ucc98\uba85","\ub3d9\uc77c\ub828\ubc88\ud638","\ub3d9\uba85\uce6d","\ub3c4\ub85c\uba85","\ub3c4\ub85c\uba85_\ub85c\ub9c8\uc790","\ub3c4\ub85c\uba85\ubc88\ud638","\ub3c4\ub85c\uba85\ucf54\ub4dc","\ub3c4\ub85c\uba85\ucf54\ub4dc_\uace0\uc2dc\uc77c\uc790","\ub3c4\ub85c\uba85\ucf54\ub4dc_\ub9d0\uc18c\uc77c\uc790","\uc74d\uba74\ub3d9\uad6c\ubd84","\uc74d\uba74\ub3d9\uc77c\ub828\ubc88\ud638","\uc74d\uba74\ub3d9\ucf54\ub4dc","\uc74d\uba74\ub3d9\uba85","\uc74d\uba74\ub3d9\uba85_\ub85c\ub9c8\uc790","\uac74\ucd95\ubb3c\ub300\uc7a5_\uac74\ubb3c\uba85","\uac74\ubb3c\ubcf8\ubc88","\uac74\ubb3c\ubd80\ubc88","\uac74\ubb3c\uad00\ub9ac\ubc88\ud638","\uae30\ucd08\uad6c\uc5ed\ubc88\ud638","\uacf5\ub3d9\uc8fc\ud0dd\uc5ec\ubd80","\uace0\uc2dc\uc77c\uc790","\uad00\ub9ac\ubc88\ud638","\ud589\uc815\ub3d9\ucf54\ub4dc","\ud589\uc815\ub3d9\uba85","\ud638\uc77c\ub828\ubc88\ud638","\ud638\uba85\uce6d","\ud638\uc811\ubbf8\uc0ac\uc77c\ub828\ubc88\ud638","\ud638\uc811\ubbf8\uc0ac\uba85\uce6d","\uc774\ub3d9\uc0ac\uc720\ucf54\ub4dc","\uc77c\ub828\ubc88\ud638","\uc9c0\ubc88\uc77c\ub828\ubc88\ud638","\uc9c0\ubc88\ubcf8\ubc88_\ubc88\uc9c0","\uc9c0\ubc88\ubd80\ubc88_\ud638","\uc9c0\ud558\uad6c\ubd84","\uc9c0\ud558\uc5ec\ubd80","\uc0b0\uc5ec\ubd80","\uc0c1\uc704\ub3c4\ub85c\uba85","\uc0c1\uc704\ub3c4\ub85c\uba85\ubc88\ud638","\uc0c1\uc138\uac74\ubb3c\uba85","\uc0c1\uc138\uc8fc\uc18c_\ubd80\uc5ec\uc5ec\ubd80","\uc0c1\uc138\uc8fc\uc18c\uc5ec\ubd80","\uc0ac\uc6a9\uc5ec\ubd80","\uc2dc\ub3c4\uba85","\uc2dc\ub3c4\uba85_\ub85c\ub9c8\uc790","\uc2dc\uad70\uad6c_\uac74\ubb3c\uba85","\uc2dc\uad70\uad6c\ucf54\ub4dc","\uc2dc\uad70\uad6c\uba85","\uc2dc\uad70\uad6c\uba85_\ub85c\ub9c8\uc790","\uc2dc\uad70\uad6c\uc6a9_\uac74\ubb3c\uba85","\uc6b0\ud3b8\uc77c\ub828\ubc88\ud638","\uc6b0\ud3b8\ubc88\ud638","\uc6b0\ud3b8\ubc88\ud638_\uc77c\ub828\ubc88\ud638","\uc601\ubb38_\ubc95\uc815\ub9ac\uba85","\uc601\ubb38\uc74d\uba74\ub3d9\uba85","\uc601\ubb38_\ubc95\uc815\uc74d\uba74\ub3d9\uba85","\uc601\ubb38\ub3c4\ub85c\uba85","\uc601\ubb38\uc2dc\ub3c4\uba85","\uc601\ubb38\uc2dc\uad70\uad6c\uba85"],"properties":{"id":{"$ref":"#/components/schemas/ID"},"dataset":{"type":"string","description":"Dataset the address originates from.\\n","enum":["mois"]},"country":{"type":"string","description":" Full country names (ISO 3166)\\n","enum":["South Korea"]},"country_iso":{"type":"string","description":" 3 letter country code (ISO 3166-1)\\n","enum":["KOR"]},"country_iso_2":{"type":"string","description":" 2 letter country code (ISO 3166-1)\\n","enum":["KR"]},"language":{"type":"string","description":"Language represented by 2 letter ISO Code (639-1)\\n","enum":["ko"]},"address":{"type":"string","description":"Jibeon (land lot) number: `\uc9c0\ubc88\ubcf8\ubc88_\ubc88\uc9c0` and `\uc9c0\ubc88\ubd80\ubc88_\ud638` joined by a hyphen.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"line_1":{"type":"string","description":"First address line.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"line_2":{"type":"string","description":"Second address line.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"city":{"type":"string","description":"Preferred city name.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"province":{"type":"string","description":"Preferred province name.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"\ubc95\uc815\uc74d\uba74\ub3d9\uba85":{"type":"string","description":"Legal town name.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"\ubc95\uc815\ub3d9\ucf54\ub4dc":{"type":"string","description":"Legal district code.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"\ubc95\uc815\ub9ac\uba85":{"type":"string","description":"Legal name.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"\ube44\uace01":{"type":"string","description":"Note 1.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"\ube44\uace02":{"type":"string","description":"Note 2.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"\ubcc0\ub3d9\uc804\ub3c4\ub85c\uba85\uc8fc\uc18c":{"type":"string","description":"Changed street name address.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"\ubcc0\uacbd\uc774\ub825\uc815\ubcf4":{"type":"string","description":"Change history information.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"\ubcc0\uacbd\uc774\ub825\uc0ac\uc720":{"type":"string","description":"Change history reason.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"\ubcc0\uacbd\uc804_\ub3c4\ub85c\uba85\uc8fc\uc18c":{"type":"string","description":"Previous road name address.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"\ubcc0\uacbd\uc0ac\uc720":{"type":"string","description":"Change reason.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"\ubcc0\uacbd\uc0ac\uc720\ucf54\ub4dc":{"type":"string","description":"Change reason code.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"\uce35\uc77c\ub828\ubc88\ud638":{"type":"string","description":"Floor serial number.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"\uce35\uba85\uce6d":{"type":"string","description":"Floor name.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"\ub300\ud45c\uc9c0\ubc88\uc5ec\ubd80":{"type":"string","description":"Is representative address.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"\ub300\ud45c\uc5ec\ubd80":{"type":"string","description":"Is representative.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"\ub2e4\ub7c9\ubc30\ub2ec\ucc98\uba85":{"type":"string","description":"Bulk delivery location name.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"\ub3d9\uc77c\ub828\ubc88\ud638":{"type":"string","description":"Building serial number.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"\ub3d9\uba85\uce6d":{"type":"string","description":"Building name.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"\ub3c4\ub85c\uba85":{"type":"string","description":"Road name.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"\ub3c4\ub85c\uba85_\ub85c\ub9c8\uc790":{"type":"string","description":"Romanised road name.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"\ub3c4\ub85c\uba85\ubc88\ud638":{"type":"string","description":"Road name number.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"\ub3c4\ub85c\uba85\ucf54\ub4dc":{"type":"string","description":"Road name code.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"\ub3c4\ub85c\uba85\ucf54\ub4dc_\uace0\uc2dc\uc77c\uc790":{"type":"string","description":"Road name code creation date.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"\ub3c4\ub85c\uba85\ucf54\ub4dc_\ub9d0\uc18c\uc77c\uc790":{"type":"string","description":"Road name code deletion date.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"\uc74d\uba74\ub3d9\uad6c\ubd84":{"type":"string","description":"Town classification.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"\uc74d\uba74\ub3d9\uc77c\ub828\ubc88\ud638":{"type":"string","description":"Town serial number.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"\uc74d\uba74\ub3d9\ucf54\ub4dc":{"type":"string","description":"Town code.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"\uc74d\uba74\ub3d9\uba85":{"type":"string","description":"Town name.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"\uc74d\uba74\ub3d9\uba85_\ub85c\ub9c8\uc790":{"type":"string","description":"Romanised town name.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"\uac74\ucd95\ubb3c\ub300\uc7a5_\uac74\ubb3c\uba85":{"type":"string","description":"Building name in building register.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"\uac74\ubb3c\ubcf8\ubc88":{"type":"string","description":"Building number.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"\uac74\ubb3c\ubd80\ubc88":{"type":"string","description":"Building sub-number.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"\uac74\ubb3c\uad00\ub9ac\ubc88\ud638":{"type":"string","description":"Building management number.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"\uae30\ucd08\uad6c\uc5ed\ubc88\ud638":{"type":"string","description":"Basic area number.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"\uacf5\ub3d9\uc8fc\ud0dd\uc5ec\ubd80":{"type":"string","description":"Is apartment.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"\uace0\uc2dc\uc77c\uc790":{"type":"string","description":"Creation date.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"\uad00\ub9ac\ubc88\ud638":{"type":"string","description":"Management number.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"\ud589\uc815\ub3d9\ucf54\ub4dc":{"type":"string","description":"Administrative district code.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"\ud589\uc815\ub3d9\uba85":{"type":"string","description":"Administrative district name.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"\ud638\uc77c\ub828\ubc88\ud638":{"type":"string","description":"Unit serial number.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"\ud638\uba85\uce6d":{"type":"string","description":"Unit name.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"\ud638\uc811\ubbf8\uc0ac\uc77c\ub828\ubc88\ud638":{"type":"string","description":"Unit suffix serial number.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"\ud638\uc811\ubbf8\uc0ac\uba85\uce6d":{"type":"string","description":"Unit suffix name.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"\uc774\ub3d9\uc0ac\uc720\ucf54\ub4dc":{"type":"string","description":"Movement reason code.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"\uc77c\ub828\ubc88\ud638":{"type":"string","description":"Serial number.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"\uc9c0\ubc88\uc77c\ub828\ubc88\ud638":{"type":"string","description":"Address serial number.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"\uc9c0\ubc88\ubcf8\ubc88_\ubc88\uc9c0":{"type":"string","description":"Jibeon (land lot) main number.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"\uc9c0\ubc88\ubd80\ubc88_\ud638":{"type":"string","description":"Jibeon (land lot) sub-number.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"\uc9c0\ud558\uad6c\ubd84":{"type":"string","description":"Is basement.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"\uc9c0\ud558\uc5ec\ubd80":{"type":"string","description":"Level (ground level, underground, aerial).\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"\uc0b0\uc5ec\ubd80":{"type":"string","description":"Is mountain.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"\uc0c1\uc704\ub3c4\ub85c\uba85":{"type":"string","description":"Upper road name.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"\uc0c1\uc704\ub3c4\ub85c\uba85\ubc88\ud638":{"type":"string","description":"Upper road name number.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"\uc0c1\uc138\uac74\ubb3c\uba85":{"type":"string","description":"Detailed building name.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"\uc0c1\uc138\uc8fc\uc18c_\ubd80\uc5ec\uc5ec\ubd80":{"type":"string","description":"Whether detailed address assigned.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"\uc0c1\uc138\uc8fc\uc18c\uc5ec\ubd80":{"type":"string","description":"Whether detailed address exists.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"\uc0ac\uc6a9\uc5ec\ubd80":{"type":"string","description":"In use.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"\uc2dc\ub3c4\uba85":{"type":"string","description":"City name.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"\uc2dc\ub3c4\uba85_\ub85c\ub9c8\uc790":{"type":"string","description":"Romanised
1city name.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"\uc2dc\uad70\uad6c_\uac74\ubb3c\uba85":{"type":"string","description":"District (sigungu) building name, as recorded in the address DB (\uc8fc\uc18cDB).\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"\uc2dc\uad70\uad6c\ucf54\ub4dc":{"type":"string","description":"District code.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"\uc2dc\uad70\uad6c\uba85":{"type":"string","description":"District name.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"\uc2dc\uad70\uad6c\uba85_\ub85c\ub9c8\uc790":{"type":"string","description":"Romanised district name.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"\uc2dc\uad70\uad6c\uc6a9_\uac74\ubb3c\uba85":{"type":"string","description":"District (sigungu) building name, as recorded in the building and PO box DBs (\uac74\ubb3cDB, \uc0ac\uc11c\ud568\uc8fc\uc18cDB).\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"\uc6b0\ud3b8\uc77c\ub828\ubc88\ud638":{"type":"string","description":"Postal sequence number.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"\uc6b0\ud3b8\ubc88\ud638":{"type":"string","description":"Postal code.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"\uc6b0\ud3b8\ubc88\ud638_\uc77c\ub828\ubc88\ud638":{"type":"string","description":"Postal code serial number.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"\uc601\ubb38_\ubc95\uc815\ub9ac\uba85":{"type":"string","description":"English legal name.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"\uc601\ubb38\uc74d\uba74\ub3d9\uba85":{"type":"string","description":"English town name.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"\uc601\ubb38_\ubc95\uc815\uc74d\uba74\ub3d9\uba85":{"type":"string","description":"English legal town name.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"\uc601\ubb38\ub3c4\ub85c\uba85":{"type":"string","description":"English road name.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"\uc601\ubb38\uc2dc\ub3c4\uba85":{"type":"string","description":"English city name.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"\uc601\ubb38\uc2dc\uad70\uad6c\uba85":{"type":"string","description":"English district name.\\n\\nCan be empty string `\\"\\"` if not present.\\n"}},"example":{"id":"mois_hM9Ur94A6Wxd8rFfQWHjKQ","dataset":"mois","country":"South Korea","country_iso":"KOR","country_iso_2":"KR","language":"ko","address":"108-21","line_1":"\uc885\ub85c\uad6c \uccad\uc6b4\ub3d9 \uc790\ud558\ubb38\ub85c 108-21","line_2":"\uccad\uc6b4\ube4c\ub529 100\ub3d9 1\ud638","city":"\uc11c\uc6b8\ud2b9\ubcc4\uc2dc","province":"\uc11c\uc6b8\ud2b9\ubcc4\uc2dc","\ubc95\uc815\uc74d\uba74\ub3d9\uba85":"\uccad\uc6b4\ub3d9","\ubc95\uc815\ub3d9\ucf54\ub4dc":"1111010100","\ubc95\uc815\ub9ac\uba85":"","\ube44\uace01":"","\ube44\uace02":"","\ubcc0\ub3d9\uc804\ub3c4\ub85c\uba85\uc8fc\uc18c":"","\ubcc0\uacbd\uc774\ub825\uc815\ubcf4":"","\ubcc0\uacbd\uc774\ub825\uc0ac\uc720":"","\ubcc0\uacbd\uc804_\ub3c4\ub85c\uba85\uc8fc\uc18c":"","\ubcc0\uacbd\uc0ac\uc720":"","\ubcc0\uacbd\uc0ac\uc720\ucf54\ub4dc":"","\uce35\uc77c\ub828\ubc88\ud638":"","\uce35\uba85\uce6d":"","\ub300\ud45c\uc9c0\ubc88\uc5ec\ubd80":"","\ub300\ud45c\uc5ec\ubd80":"","\ub2e4\ub7c9\ubc30\ub2ec\ucc98\uba85":"","\ub3d9\uc77c\ub828\ubc88\ud638":"","\ub3d9\uba85\uce6d":"","\ub3c4\ub85c\uba85":"\uc790\ud558\ubb38\ub85c","\ub3c4\ub85c\uba85_\ub85c\ub9c8\uc790":"","\ub3c4\ub85c\uba85\ubc88\ud638":"3100012","\ub3c4\ub85c\uba85\ucf54\ub4dc":"111103100012","\ub3c4\ub85c\uba85\ucf54\ub4dc_\uace0\uc2dc\uc77c\uc790":"20100702","\ub3c4\ub85c\uba85\ucf54\ub4dc_\ub9d0\uc18c\uc77c\uc790":"","\uc74d\uba74\ub3d9\uad6c\ubd84":"1","\uc74d\uba74\ub3d9\uc77c\ub828\ubc88\ud638":"01","\uc74d\uba74\ub3d9\ucf54\ub4dc":"101","\uc74d\uba74\ub3d9\uba85":"\uccad\uc6b4\ub3d9","\uc74d\uba74\ub3d9\uba85_\ub85c\ub9c8\uc790":"","\uac74\ucd95\ubb3c\ub300\uc7a5_\uac74\ubb3c\uba85":"","\uac74\ubb3c\ubcf8\ubc88":"100","\uac74\ubb3c\ubd80\ubc88":"1","\uac74\ubb3c\uad00\ub9ac\ubc88\ud638":"1111010100101080021031434","\uae30\ucd08\uad6c\uc5ed\ubc88\ud638":"03047","\uacf5\ub3d9\uc8fc\ud0dd\uc5ec\ubd80":"0","\uace0\uc2dc\uc77c\uc790":"","\uad00\ub9ac\ubc88\ud638":"","\ud589\uc815\ub3d9\ucf54\ub4dc":"1111051500","\ud589\uc815\ub3d9\uba85":"\uccad\uc6b4\ud6a8\uc790\ub3d9","\ud638\uc77c\ub828\ubc88\ud638":"","\ud638\uba85\uce6d":"","\ud638\uc811\ubbf8\uc0ac\uc77c\ub828\ubc88\ud638":"","\ud638\uc811\ubbf8\uc0ac\uba85\uce6d":"","\uc774\ub3d9\uc0ac\uc720\ucf54\ub4dc":"","\uc77c\ub828\ubc88\ud638":"","\uc9c0\ubc88\uc77c\ub828\ubc88\ud638":"","\uc9c0\ubc88\ubcf8\ubc88_\ubc88\uc9c0":"108","\uc9c0\ubc88\ubd80\ubc88_\ud638":"21","\uc9c0\ud558\uad6c\ubd84":"","\uc9c0\ud558\uc5ec\ubd80":"0","\uc0b0\uc5ec\ubd80":"0","\uc0c1\uc704\ub3c4\ub85c\uba85":"","\uc0c1\uc704\ub3c4\ub85c\uba85\ubc88\ud638":"","\uc0c1\uc138\uac74\ubb3c\uba85":"","\uc0c1\uc138\uc8fc\uc18c_\ubd80\uc5ec\uc5ec\ubd80":"","\uc0c1\uc138\uc8fc\uc18c\uc5ec\ubd80":"0","\uc0ac\uc6a9\uc5ec\ubd80":"0","\uc2dc\ub3c4\uba85":"\uc11c\uc6b8\ud2b9\ubcc4\uc2dc","\uc2dc\ub3c4\uba85_\ub85c\ub9c8\uc790":"","\uc2dc\uad70\uad6c_\uac74\ubb3c\uba85":"","\uc2dc\uad70\uad6c\ucf54\ub4dc":"11110","\uc2dc\uad70\uad6c\uba85":"\uc885\ub85c\uad6c","\uc2dc\uad70\uad6c\uba85_\ub85c\ub9c8\uc790":"","\uc2dc\uad70\uad6c\uc6a9_\uac74\ubb3c\uba85":"\uccad\uc6b4\ube4c\ub529","\uc6b0\ud3b8\uc77c\ub828\ubc88\ud638":"","\uc6b0\ud3b8\ubc88\ud638":"03047","\uc6b0\ud3b8\ubc88\ud638_\uc77c\ub828\ubc88\ud638":"","\uc601\ubb38_\ubc95\uc815\ub9ac\uba85":"","\uc601\ubb38\uc74d\uba74\ub3d9\uba85":"Cheongun-dong","\uc601\ubb38_\ubc95\uc815\uc74d\uba74\ub3d9\uba85":"","\uc601\ubb38\ub3c4\ub85c\uba85":"Jahamun-ro","\uc601\ubb38\uc2dc\ub3c4\uba85":"Seoul","\uc601\ubb38\uc2dc\uad70\uad6c\uba85":"Jongno-gu"}},"UpujpAddress":{"title":"Japan UPU Address","description":"A Japanese address from the Universal Postal Union\'s address file for Japan. Each address carries its postal code, prefecture, city, district and neighbourhood, a block or house number range and, where present, a building and an organisation name, in kanji, hiragana and Hepburn romanisation.\\n\\n- Records are number ranges, not delivery points. O
1ne record covers `str_from_num` to `str_to_num` under the `str_evenodd` scheme, so a single record can stand for many premises. `address` is the one number selected from that range for the query, and `id` carries it after a `|`.\\n- There is no sub-premise detail. The finest elements are the block or house number and a building name. There is no unit, floor or sub-building field.\\n- The dataset carries no coordinates. `latitude` and `longitude` are always the empty string.\\n- The API indexes every address once per script, so the same address comes back as separate records with separate `id`s. `script` is `Hani` (kanji), `Hira` (hiragana) or `Latn` (Hepburn romanisation), and `language` is `ja` on all three. `en` is reserved for English building name synonyms and is not expected in practice.\\n\\nConventions:\\n\\n- `line_1` is the block or house number alone and repeats `address`. There is no `line_2` or `line_3`. Build the rest of the address from `prefecture`, `city`, `district`, `neighbourhood` and `building_name`.\\n- A kanji or hiragana address is written as `\u3012`, the postcode, a space, then prefecture, city, district, neighbourhood, number and building name run together with no separators: `\u3012070-8006 \u5317\u6d77\u9053\u65ed\u5ddd\u5e02\u795e\u697d\u516d\u6761\u5341\u4e09\u4e01\u76ee12-2`. A romanised address is the same elements comma separated after a bare postcode: `070-8006, Hokkaido, Asahikawa-shi, Kagura 6jo 13-Chome, 12-2`.\\n- On the romanised variant the API title cases the display fields and lower cases the Latin locality suffix before joining it on, giving `Asahikawa-shi` and `Nasu-machi`. The raw source fields are as supplied, so every `*_trans` field stays upper case.\\n- No field is null. A value the source does not carry is the empty string, and every field is present on every record.\\n- `id` is `upujp_` followed by a URL-safe base64 MD5 of the address line, suffixed `|` and the number when the record covers a range and one number has been resolved (`upujp_2ry6tOmv4gOAWU2v5CVxBw|12-2`).\\n- Alongside the resolved fields the record carries the source columns under their original names: `org_*` (organisation), `str_*` (street, number range and building), `sub_*` (district and neighbourhood) and `loc_*` (locality and administrative divisions 1 to 3). Most are empty for a typical residential address.\\n","type":"object","required":["id","dataset","country","country_iso","country_iso_2","language","script","address","line_1","building_name","neighbourhood","district","city","prefecture","postcode","latitude","longitude","org_id","org_type_ind","org_sub_type_ind","org_loc_id","org_dis_id","org_nei_id","org_org_id","org_name","org_name_trans","org_loc_sfx","org_loc_sfx_trans","org_adr","org_adr_trans","org_po_ind","org_po_start","org_po_end","org_dsc","org_dsc_trans","org_pcode","org_pcode_fin","org_script","org_language","str_id","str_key","str_loc_id","str_dis_id","str_nei_id","str_org_id","str_pfx","str_pfx_trans","str_qlf_pre","str_qlf_pre_trans","str_qlf_suc","str_qlf_suc_trans","str_name","str_name_trans","str_loc_sfx","str_loc_sfx_trans","str_type","str_type_trans","str_type_abv","str_type_abv_trans","str_adr_num_key","str_from_num","str_from_unit","str_from_alph","str_to_num","str_to_unit","str_to_alph","str_evenodd","str_dsc","str_dsc_trans","str_blg_id","str_blg_name","str_blg_name_trans","str_blg_type","str_blg_type_trans","str_blg_dsc","str_blg_dsc_trans","str_ref_str_id","str_pcode","str_script","str_language","sub_dis_id","sub_dis_key","sub_loc_id","sub_loc_sfx","sub_loc_sfx_trans","sub_dis_name","sub_dis_name_trans","sub_dis_sfx","sub_dis_sfx_trans","sub_dis_dsc","sub_dis_dsc_trans","sub_dis_pcode","sub_dis_pcode_fin","sub_nei_id","sub_nei_key","sub_nei_name","sub_nei_name_trans","sub_nei_sfx","sub_nei_sfx_trans","sub_nei_zone_from","sub_nei_zone_to","sub_nei_dsc","sub_nei_dsc_trans","sub_nei_pcode","sub_script","sub_language","loc_id","loc_key","loc_adm1_id","loc_adm1_key","loc_adm1_name","loc_adm1_name_trans","loc_adm1_sfx","loc_adm1_sfx_trans","loc_adm1_abv","loc_adm1_abv_trans","loc_adm2_id","loc_adm2_key","loc_adm2_name","loc_adm2_name_trans","loc_adm2_sfx","loc_adm2_sfx_trans","loc_adm2_abv","loc_adm2_abv_trans","loc_adm3_id","loc_adm3_key","loc_adm3_name","loc_adm3_name_trans","loc_adm3_sfx","loc_adm3_sfx_trans","loc_adm3_abv","loc_adm3_abv_trans","loc_name","loc_name_trans","loc_sfx","loc_sfx_trans","loc_pcode","loc_pcode_fin","loc_dsc","loc_dsc_trans","loc_script","loc_language"],"properties":{"id":{"$ref":"#/components/schemas/ID"},"dataset":{"type":"string","description":"Indicates the provenance of an address","enum":["upujp"]},"country":{"type":"string","description":" Full country names (ISO 3166)\\n","enum":["Japan"]},"country_iso":{"type":"string","description":" 3 letter country code (ISO 3166-1)\\n","enum":["JPN"]},"country_iso_2":{"type":"string","description":" 2 letter country code (ISO 3166-1)\\n","enum":["JP"]},"language":{"type":"string","enum":["ja","en"],"description":"Language represented by 2 letter ISO Code (639-1)\\n"},"script":{"type":"string","description":"ISO 15924 script of the address elements.\\n\\n`Hani` = Kanji, `Hira` = Hiragana, `Latn` = Latin.\\n","enum":["Hani","Hira","
1Latn"]},"address":{"type":"string","description":"Address / House Number uniquely identifying the address along the specified street.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"line_1":{"type":"string","description":"The block or house number alone, identical to `address`. There is no `line_2` or `line_3`; build the rest of the address from `prefecture`, `city`, `district`, `neighbourhood` and `building_name`.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"building_name":{"type":"string","description":"Preferred building name.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"neighbourhood":{"type":"string","description":"Preferred neighbourhood name.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"district":{"type":"string","description":"Preferred district name.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"city":{"type":"string","description":"Preferred city name.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"prefecture":{"type":"string","description":"Preferred prefecture name.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"postcode":{"type":"string","description":"Preferred postal code.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"latitude":{"$ref":"#/components/schemas/Latitude"},"longitude":{"$ref":"#/components/schemas/Longitude"},"org_id":{"type":"string","description":"The unique identifier of an organisation.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"org_type_ind":{"oneOf":[{"type":"string"},{"type":"number"}],"description":"Indicates the type of organisation.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"org_sub_type_ind":{"oneOf":[{"type":"string"},{"type":"number"}],"description":"Indicates the sub-type of the organisation.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"org_loc_id":{"type":"string","description":"Locality identifier for the organisation.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"org_dis_id":{"type":"string","description":"District identifier for the organisation.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"org_nei_id":{"type":"string","description":"Neighbourhood identifier for the organisation.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"org_org_id":{"type":"string","description":"Associated organisation identifier for the organisation.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"org_name":{"type":"string","description":"Name of the organisation.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"org_name_trans":{"type":"string","description":"Translated name of the organisation in Latin script.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"org_loc_sfx":{"type":"string","description":"Suffix of the locality for the organisation.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"org_loc_sfx_trans":{"type":"string","description":"Translated suffix of the locality for the organisation in Latin script.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"org_adr":{"type":"string","description":"Address of the organisation.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"org_adr_trans":{"type":"string","description":"Translated address of the organisation in Latin script.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"org_po_ind":{"oneOf":[{"type":"string"},{"type":"number"}],"description":"Indicates whether the organisation has a post office box.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"org_po_start":{"type":"string","description":"Post office box number or start of the post office box range associated with the organisation.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"org_po_end":{"type":"string","description":"End of the post office box range associated with the organisation.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"org_dsc":{"type":"string","description":"Additional information about the organisation.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"org_dsc_trans":{"type":"string","description":"Translated additional information about the organisation in Latin script.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"org_pcode":{"type":"string","description":"Postal code for the organisation.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"org_pcode_fin":{"type":"string","description":"Final postal code for the organisation.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"org_script":{"type":"string","description":"Script used for the organisation name.\\n\\n`Hani` = Kanji, `Hira` = Hiragana, `Latn` = Latin.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"org_language":{"type":"string","description":"Language used for the organisation name.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"str_id":{"type":"string","description":"Identifier of the street (not unique).\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"str_key":{"type":"string","description":"Permanent identifier of the street.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"str_loc_id":{"type":"string","description":"Locality identifier for the street.\\n\\nCan be empty string `\\"\\"` if not present.\\n"}
1,"str_dis_id":{"type":"string","description":"District identifier for the street.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"str_nei_id":{"type":"string","description":"Neighbourhood identifier for the street.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"str_org_id":{"type":"string","description":"Associated organisation identifier for the street.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"str_pfx":{"type":"string","description":"Prefix of the street name.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"str_pfx_trans":{"type":"string","description":"Translated prefix of the street name in Latin script.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"str_qlf_pre":{"type":"string","description":"Preceding qualifier of the street name.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"str_qlf_pre_trans":{"type":"string","description":"Translated preceding qualifier of the street name in Latin script.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"str_qlf_suc":{"type":"string","description":"Succeeding qualifier of the street name.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"str_qlf_suc_trans":{"type":"string","description":"Translated succeeding qualifier of the street name in Latin script.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"str_name":{"type":"string","description":"Name of the street.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"str_name_trans":{"type":"string","description":"Translated name of the street in Latin script.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"str_loc_sfx":{"type":"string","description":"Suffix of the locality for the street.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"str_loc_sfx_trans":{"type":"string","description":"Translated suffix of the locality for the street in Latin script.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"str_type":{"type":"string","description":"Type of the street.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"str_type_trans":{"type":"string","description":"Translated type of the street in Latin script.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"str_type_abv":{"type":"string","description":"Abbreviation of the street type.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"str_type_abv_trans":{"type":"string","description":"Translated abbreviation of the street type in Latin script.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"str_adr_num_key":{"type":"string","description":"Permanent identifier of the address.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"str_from_num":{"oneOf":[{"type":"string"},{"type":"number"}],"description":"Lowest address number on the street.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"str_from_unit":{"type":"string","description":"Lowest unit number on the street.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"str_from_alph":{"type":"string","description":"Extension of the lowest address number on the street.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"str_to_num":{"oneOf":[{"type":"string"},{"type":"number"}],"description":"Highest address number on the street.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"str_to_unit":{"type":"string","description":"Highest unit number on the street.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"str_to_alph":{"type":"string","description":"Extension of the highest address number on the street.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"str_evenodd":{"oneOf":[{"type":"string"},{"type":"number"}],"description":"Indicates whether the address range for this street contains even numbers, odd numbers, or both.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"str_dsc":{"type":"string","description":"Additional information about the street.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"str_dsc_trans":{"type":"string","description":"Translated additional information about the street in Latin script.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"str_blg_id":{"type":"string","description":"Identifier of the building for the street.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"str_blg_name":{"type":"string","description":"Name of the building for the street.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"str_blg_name_trans":{"type":"string","description":"Translated name of the building for the street in Latin script.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"str_blg_type":{"type":"string","description":"Type of the building for the street.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"str_blg_type_trans":{"type":"string","description":"Translated type of the building for the street in Latin script.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"str_blg_dsc":{"type":"string","description":"Additional information about the building for the street.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"str_blg_dsc_trans":{"type":"string","description":"Translated additional information about the building for the street in Latin script.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"str_ref_str_id":{"type":"string","description":"Identifier of the associated street.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"str_pcode":{"type":"string","description":"Postal code for the street.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"str_script":{"type":"string","description":"Script used for the street name.\\n\\n`Hani` = Kanji, `Hira` = Hiragana, `Latn` = Latin.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"str_language":{"type":"string","description":"Language used for the street name.\\n\\nCan be empty string `\\"\\"` if not present.\\n"}
1,"sub_dis_id":{"type":"string","description":"Unique identifier of the district.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"sub_dis_key":{"type":"string","description":"Permanent identifier of the district.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"sub_loc_id":{"type":"string","description":"Locality identifier for the subdivision.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"sub_loc_sfx":{"type":"string","description":"Suffix of the locality for the subdivision.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"sub_loc_sfx_trans":{"type":"string","description":"Translated suffix of the locality for the subdivision in Latin script.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"sub_dis_name":{"type":"string","description":"Name of the district.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"sub_dis_name_trans":{"type":"string","description":"Translated name of the district in Latin script.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"sub_dis_sfx":{"type":"string","description":"Suffix of the district.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"sub_dis_sfx_trans":{"type":"string","description":"Translated suffix of the district in Latin script.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"sub_dis_dsc":{"type":"string","description":"Additional information about the district.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"sub_dis_dsc_trans":{"type":"string","description":"Translated additional information about the district in Latin script.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"sub_dis_pcode":{"type":"string","description":"Postal code for the district.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"sub_dis_pcode_fin":{"type":"string","description":"Final postal code for the district.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"sub_nei_id":{"type":"string","description":"Identifier of the neighbourhood.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"sub_nei_key":{"type":"string","description":"Permanent identifier of the neighbourhood.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"sub_nei_name":{"type":"string","description":"Name of the neighbourhood.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"sub_nei_name_trans":{"type":"string","description":"Translated name of the neighbourhood in Latin script.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"sub_nei_sfx":{"type":"string","description":"Suffix of the neighbourhood.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"sub_nei_sfx_trans":{"type":"string","description":"Translated suffix of the neighbourhood in Latin script.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"sub_nei_zone_from":{"type":"string","description":"Start of the range of zone numbers to which the neighbourhood postal code corresponds.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"sub_nei_zone_to":{"type":"string","description":"End of the range of zone numbers to which the neighbourhood postal code corresponds.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"sub_nei_dsc":{"type":"string","description":"Additional information about the neighbourhood.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"sub_nei_dsc_trans":{"type":"string","description":"Translated additional information about the neighbourhood in Latin script.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"sub_nei_pcode":{"type":"string","description":"Postal code for the neighbourhood.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"sub_script":{"type":"string","description":"Script used for the subdivision names.\\n\\n`Hani` = Kanji, `Hira` = Hiragana, `Latn` = Latin.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"sub_language":{"type":"string","description":"Language used for the subdivision names.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"loc_id":{"type":"string","description":"Unique identifier of the locality.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"loc_key":{"type":"string","description":"Permanent identifier of the locality.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"loc_adm1_id":{"type":"string","description":"Identifier of administrative division 1.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"loc_adm1_key":{"type":"string","description":"Permanent identifier of administrative division 1.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"loc_adm1_name":{"type":"string","description":"Name of administrative division 1.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"loc_adm1_name_trans":{"type":"string","description":"Translated name of administrative division 1 in Latin script.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"loc_adm1_sfx":{"type":"string","description":"Suffix of administrative division 1.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"loc_adm1_sfx_trans":{"type":"string","description":"Translated suffix of administrative division 1 in Latin script.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"loc_adm1_abv":{"type":"string","description":"Abbreviation of administrative division 1.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"loc_adm1_abv_trans":{"type":"string","description":"Translated abbreviation of administrative division 1 in Latin script.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"loc_adm2_id":{"type":"string","description":"Identifier of administrative division 2.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"loc_adm2_key":{"type":"string","description":"Permanent identifier of administrative division 2.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"loc_adm2_name":{"type":"string","description":"Name of administrative division 2.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"loc_adm2_name_trans":{"type":"string","description":"Translated name of administrative division 2 in Latin script.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"loc_adm2_sfx":{"type":"string","description":"Suffix of administrative division 2.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"loc_adm2_sfx_trans":{"type":"string","description":"Translated suffix of administrative division 2 in Latin script.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"loc_adm2_abv":{"type":"string","description":"Abbreviation of administrative division 2.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"loc_adm2_abv_trans":{"type":"string","description":"Translated abbreviation of administrative division 2 in Latin script.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"loc_adm3_id":{"type":"string","description":"Identifier of administrative division 3.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"loc_adm3_key":{"type":"string","description":"Permanent identifier of administrative division 3.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"loc_adm3_name":{"type":"string","description":"Name of administrative division 3.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"loc_adm3_name_trans":{"type":"string","description":"Translated name of administrative division 3 in Latin script.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"loc_adm3_sfx":{"type":"string","description":"Suffix of administrative division 3.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"loc_adm3_sfx_trans":{"type":"string","description":"Translated suffix of administrative division 3 in Latin script.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"loc_adm3_abv":{"type":"string","description":"Abbreviation of administrative division 3.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"loc_adm3_abv_trans":{"type":"string","description":"Translated abbreviation of administrative division 3 in Latin script.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"loc_name":{"type":"string","description":"Name of the locality.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"loc_name_trans":{"type":"string","description":"Translated name of the locality in Latin script.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"loc_sfx":{"type":"string","description":"Suffix of the locality.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"loc_sfx_trans":{"type":"string","description":"Translated suffix of the locality in Latin script.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"loc_pcode":{"type":"string","description":"Postal code of the locality.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"loc_pcode_fin":{"type":"string","description":"Final postal code of the locality.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"loc_dsc":{"type":"string","description":"Additional information about the locality.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"loc_dsc_trans":{"type":"string","description":"Translated additional information about the locality in Latin script.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"loc_script":{"type":"string","description":"Script used for the locality names.\\n\\n`Hani` = Kanji, `Hira` = Hiragana, `Latn` = Latin.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"loc_language":{"type":"string","description":"Language used for the locality names.\\n\\nCan be empty string `\\"\\"` if not present.\\n"}},"example":{"id":"upujp_2ry6tOmv4gOAWU2v5CVxBw|12-2","dataset":"upujp","country":"Japan","country_iso":"JPN","country_iso_2":"JP","language":"ja","script":"Hani","address":"12-2","line_1":"
112-2","building_name":"","neighbourhood":"\u795e\u697d\u516d\u6761\u5341\u4e09\u4e01\u76ee","district":"","city":"\u65ed\u5ddd\u5e02","prefecture":"\u5317\u6d77\u9053","postcode":"070-8006","latitude":"","longitude":"","org_id":"","org_type_ind":"","org_sub_type_ind":"","org_loc_id":"","org_dis_id":"","org_nei_id":"","org_org_id":"","org_name":"","org_name_trans":"","org_loc_sfx":"","org_loc_sfx_trans":"","org_adr":"","org_adr_trans":"","org_po_ind":"","org_po_start":"","org_po_end":"","org_dsc":"","org_dsc_trans":"","org_pcode":"","org_pcode_fin":"","org_script":"","org_language":"","str_id":"0","str_key":"","str_loc_id":"914161","str_dis_id":"","str_nei_id":"194855","str_org_id":"","str_pfx":"","str_pfx_trans":"","str_qlf_pre":"","str_qlf_pre_trans":"","str_qlf_suc":"","str_qlf_suc_trans":"","str_name":"","str_name_trans":"","str_loc_sfx":"","str_loc_sfx_trans":"","str_type":"","str_type_trans":"","str_type_abv":"","str_type_abv_trans":"","str_adr_num_key":"","str_from_num":2,"str_from_unit":"12","str_from_alph":"","str_to_num":2,"str_to_unit":"12","str_to_alph":"","str_evenodd":6,"str_dsc":"","str_dsc_trans":"","str_blg_id":"49928324","str_blg_name":"","str_blg_name_trans":"","str_blg_type":"\u756a","str_blg_type_trans":"BAN","str_blg_dsc":"","str_blg_dsc_trans":"","str_ref_str_id":"","str_pcode":"070-8006","str_script":"","str_language":"","sub_dis_id":"","sub_dis_key":"","sub_loc_id":"914161","sub_loc_sfx":"","sub_loc_sfx_trans":"","sub_dis_name":"","sub_dis_name_trans":"","sub_dis_sfx":"","sub_dis_sfx_trans":"","sub_dis_dsc":"","sub_dis_dsc_trans":"","sub_dis_pcode":"","sub_dis_pcode_fin":"","sub_nei_id":"194855","sub_nei_key":"","sub_nei_name":"\u795e\u697d\u516d\u6761\u5341\u4e09\u4e01\u76ee","sub_nei_name_trans":"KAGURA 6JO 13-CHOME","sub_nei_sfx":"","sub_nei_sfx_trans":"G","sub_nei_zone_from":"","sub_nei_zone_to":"","sub_nei_dsc":"","sub_nei_dsc_trans":"","sub_nei_pcode":"070-8006","sub_script":"Hani","sub_language":"ja","loc_id":"914161","loc_key":"3265925806","loc_adm1_id":"12010","loc_adm1_key":"JP.HK","loc_adm1_name":"\u5317\u6d77\u9053","loc_adm1_name_trans":"HOKKAIDO","loc_adm1_sfx":"","loc_adm1_sfx_trans":"","loc_adm1_abv":"","loc_adm1_abv_trans":"","loc_adm2_id":"","loc_adm2_key":"","loc_adm2_name":"","loc_adm2_name_trans":"","loc_adm2_sfx":"","loc_adm2_sfx_trans":"","loc_adm2_abv":"","loc_adm2_abv_trans":"","loc_adm3_id":"","loc_adm3_key":"","loc_adm3_name":"","loc_adm3_name_trans":"","loc_adm3_sfx":"","loc_adm3_sfx_trans":"","loc_adm3_abv":"","loc_adm3_abv_trans":"","loc_name":"\u65ed\u5ddd\u5e02","loc_name_trans":"ASAHIKAWA","loc_sfx":"","loc_sfx_trans":"-SHI","loc_pcode":"070-0000","loc_pcode_fin":"","loc_dsc":"","loc_dsc_trans":"","loc_script":"Hani","loc_language":"ja"}},"BevAddress":{"title":"Austria BEV Address","description":"An address from the Adressregister, Austria\'s official address register published by the Bundesamt f\xfcr Eich- und Vermessungswesen (BEV) under Open Government Data Austria.\\n\\nOne record per building at an address: the address (`adrcd`) is joined to its building (`subcd`, `objektnummer`), municipality, locality, street and census district lookups.\\n\\nField names follow the German source. House numbers are decomposed into up to four number/letter/connector parts (`hausnrzahl1`-`hausnrzahl4`) and supplied pre-combined (`hnr_adr_zusammen`, `hnr_geb_zusammen`, `address`). Values sourced from list columns (`kgnr`, `objfunktkennziffer`) are returned comma-separated.","type":"object","required":["id","dataset","country","country_iso","country_iso_2","language","address","line_1","line_2","latitude","longitude","adrcd","kgnr","gkz","okz","plz","skz","zaehlsprengel","hausnrtext","hausnrzahl1","hausnrbuchstabe1","hausnrverbindung1","hausnrzahl2","hausnrbuchstabe2","hausnrbereich","hnr_adr_zusammen","gnradresse","hofname","rw","hw","epsg","quelladresse","bestimmungsart","subcd","objektnummer","objfunktkennziffer","hauptadresse","hausnrverbindung2","hausnrzahl3","hausnrbuchstabe3","hausnrverbindung3","hausnrzahl4","hausnrbuchstabe4","hausnrgebaeudebez","hnr_geb_zusammen","eigenschaft","gemeindename","ortsname","strassenname","strassennamenzusatz","szusadrbest","zustellort","zustellort_id","zaehlsprengelname"],"properties":{"id":{"$ref":"#/components/schemas/ID"},"dataset":{"type":"string","enum":["bev"]},"country":{"type":"string","description":" Full country names (ISO 3166)\\n","enum":["Austria"]},"country_iso":{"type":"string","description":" 3 letter country code (ISO 3166-1)\\n","enum":["AUT"]},"country_iso_2":{"type":"string","description":" 2 letter country code (ISO 3166-1)\\n","enum":["AT"]},"language":{"type":"string","description":"Language represented by 2 letter ISO Code (639-1)\\n","enum":["de"]},"address":{"type":"string","description":"Complete house number: `hnr_adr_zusammen` combined with `hnr_geb_zusammen`.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"line_1":{"type":"string","description":"First address line. The building or farmstead name (`hofname`) where one is present, otherwise the street line (street name plus `address`).\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"line_2":{"type":"string","description":"Second address line. The street line (street name plus `address`) where `line_1` holds the building name.\\n\\nEmpty string `\\"\\"` where the address has no building name.\\n"},"latitude":{"$ref":"#/components/schemas/Latitude"},"longitude":{"$ref":"#/components/schemas/Longitude"},"adrcd":{"type":"string","description":"Unique identifier of the address\\n"},"kgnr":{"type":"string","description":"Comma-separated cadastral numbers (Katastralgemeindenummer) of the land parcels associated with the address\\n"},"gkz":{"type":"string","description":"Municipality unique identifier\\n"},"okz":{"type":"string","description":"Locality unique identifier\\n"},"plz":{"type":"string","description":"Postal code\\n"},"skz":{"type":"string","description":"Street unique identifier\\n"},"zaehlsprengel":{"type":"string","description":"Census district unique identifier\\n"},"hausnrtext":{"type":"string","description":"Text before house number\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"hausnrzahl1":{"type":"integer","description":"House number part 1\\
1n"},"hausnrbuchstabe1":{"type":"string","description":"House letter part 1\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"hausnrverbindung1":{"type":"string","description":"House number connector 1. `-` indicates `hausnrzahl1` to `hausnrzahl2` is a range.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"hausnrzahl2":{"oneOf":[{"type":"string","description":"Empty string `\\"\\"` if not available\\n"},{"type":"integer","description":"House number part 2\\n"}]},"hausnrbuchstabe2":{"type":"string","description":"House letter part 2\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"hausnrbereich":{"type":"string","description":"House number range scheme (even, odd, all or not specified), as German source text\\n"},"hnr_adr_zusammen":{"type":"string","description":"Complete house number of the address (combination of house number parts and letters)\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"gnradresse":{"type":"integer","description":"Parcel number used as an address when no house number is present. `0` where unused.\\n"},"hofname":{"type":"string","description":"Name of building or building complex (e.g. farmstead), title cased\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"rw":{"type":"string","description":"Easting / X coordinate in the coordinate reference system given by `epsg`\\n"},"hw":{"type":"string","description":"Northing / Y coordinate in the coordinate reference system given by `epsg`\\n"},"epsg":{"type":"integer","description":"Coordinate reference system identifier for `rw` and `hw`\\n"},"quelladresse":{"type":"string","description":"Coordinate accuracy level (building level, parcel level, etc.)\\n"},"bestimmungsart":{"type":"string","description":"Coordinate determination method (DKM, surveying office, municipality, etc.)\\n"},"subcd":{"type":"string","description":"Subcode to distinguish multiple buildings at the same address\\n"},"objektnummer":{"type":"string","description":"Object number of the building\\n"},"objfunktkennziffer":{"type":"string","description":"Comma-separated building function codes for the building (e.g. `01` pharmacy, `04` fire department, `08` school, `99` no function assigned)\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"hauptadresse":{"type":"integer","description":"`1` where this is the primary address for the associated building, `0` otherwise\\n"},"hausnrverbindung2":{"type":"string","description":"House number connector 2\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"hausnrzahl3":{"oneOf":[{"type":"string","description":"Empty string `\\"\\"` if not available\\n"},{"type":"integer","description":"House number part 3\\n"}]},"hausnrbuchstabe3":{"type":"string","description":"House letter part 3\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"hausnrverbindung3":{"type":"string","description":"House number connector 3\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"hausnrzahl4":{"oneOf":[{"type":"string","description":"Empty string `\\"\\"` if not available\\n"},{"type":"integer","description":"House number part 4\\n"}]},"hausnrbuchstabe4":{"type":"string","description":"House letter part 4\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"hausnrgebaeudebez":{"type":"string","description":"Building description\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"hnr_geb_zusammen":{"type":"string","description":"Complete building designation (combination of house number and building designation)\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"eigenschaft":{"type":"string","description":"Code indicating the primary use or function of the building (e.g. `01` one apartment, `02` two or more apartments, `05` office building)\\n"},"gemeindename":{"type":"string","description":"Name of the municipality\\n"},"ortsname":{"type":"string","description":"Name of the locality\\n"},"strassenname":{"type":"string","description":"Name of the street\\n"},"strassennamenzusatz":{"type":"string","description":"Street type (e.g. \\"Allee\\", \\"Strasse\\")\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"szusadrbest":{"type":"integer","description":"Indicates whether the street type is included in the street name\\n"},"zustellort":{"type":"string","description":"Postal town name\\n"},"zustellort_id":{"type":"string","description":"Postal town identifier\\n"},"zaehlsprengelname":{"type":"string","description":"Name of the census district\\n"}},"example":{"id":"bev_5000090|001","dataset":"bev","country":"Austria","country_iso":"AUT","country_iso_2":"AT","language":"de","address":"41","line_1":"Poltenweg 41","line_2":"","latitude":47.240128940538256,"longitude":11.401418155046553,"adrcd":"5000090","kgnr":"81134","gkz":"70101","okz":"16406","plz":"6080","skz":"001319","zaehlsprengel":"70101700","hausnrtext":"","hausnrzahl1":41,"hausnrbuchstabe1":"","hausnrverbindung1":"","hausnrzahl2":"","hausnrbuchstabe2":"","hausnrbereich":"keine Angabe","hnr_adr_zusammen":"41","gnradresse":0,"hofname":"","rw":"80893.30","hw":"234024.51","epsg":31254,"quelladresse":"G","bestimmungsart":"Z","subcd":"001","objektnummer":"1330150","objfunktkennziffer":"99","hauptadresse":1,"hausnrverbindung2":"","hausnrzahl3":"","hausnrbuchstabe3":"","hausnrverbindung3":"","hausnrzahl4":"","hausnrbuchstabe4":"","hausnrgebaeudebez":"","hnr_geb_zusammen":"","eigenschaft":"02","gemeindename":"Innsbruck","ortsname":"Vill","strassenname":"Poltenweg","strassennamenzusatz":"","szusadrbest":0,"zustellort":"Innsbruck","zustellort_id":"15215","zaehlsprengelname":"70101 700"}},"BanAddress":{"title":"France BAN Address","type":"object","description":"Address from France\'s Base Adresse Nationale (BAN), the official open national\\naddress database published via Etalab.\\n\\nBAN reaches house-number level only (`numero` + street + commune) - it carries\\nno sub-premise (unit, floor, building) data.\\n","required":["id","dataset","country","country_iso","country_iso_2","language","address","line_1","line_2","latitude","longitude","id_fantoir","numero","rep","nom_voie","code_postal","code_insee","nom_commune","code_insee_ancienne_commune","nom_ancienne_commune","x","y","lon","lat","type_position","alias","nom_ld","libelle_acheminement","nom_afnor","source_position","source_nom_voie","certification_commune","cad_parcelles"],"properties":{"id":{"$ref":"#/components/schemas/ID"},"dataset":{"type":"string","enum":["ban"]},"country":{"type":"string","description":" Full country names (ISO 3166)\\n","enum":["France"]},"country_iso":{"type":"string","description":" 3 letter country code (ISO 3166-1)\\n","enum":["FRA"]},"country_iso_2":{"type":"string","description":" 2 letter country code (ISO 3166-1)\\n","enum":["FR"]},"language":{"type":"string","enum":["fr"],"description":"Language represented by 2 letter ISO Code (639-1)\\n"},"address":{"type":"string","description":"The house number of the address (`numero`), without any suffix.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"line_1":{"type":"string","nullable":true,"description":"First address line (house number, suffix, and street name).\\n\\nCan be `null` if not present.\\n"},"line_2":{"type":"string","nullable":true,"description":"Second address line (postcode and municipality name).\\n\\nCan be `null` if not present.\\n"},"latitude":{"$ref":"#/components/schemas/Latitude"},"longitude":{"$ref":"#/components/schemas/Longitude"},"id_fantoir":{"type":"string","nullable":true,"description":"FANTOIR street identifier\\n"},"numero":{"type":"integer","nullable":true,"description":"House number\\n"},"rep":{"type":"string","nullable":true,"description":"House number suffix / r\xe9p\xe9tition (`bis`, `ter`, `quater`, etc.)\\n"},"nom_voie":{"type":"string","description":"Street name\\n"},"code_postal":{"type":"string","nullable":true,"description":"5-digit postal code\\n"},"code_insee":{"type":"string","description":"INSEE commune code (2-digit d\xe9partement + 3-digit commune)\\n"},"nom_commune":{"type":"string","description":"Municipality name\\n"},"code_insee_ancienne_commune":{"type":"string","nullable":true,"description":"INSEE code of the pre-fusion commune (for merged municipalities)\\n"},"nom_ancienne_commune":{"type":"string","nullable":true,"description":"Name of the pre-fusion commune (for merged municipalities)\\n"},"x":{"type":"string","nullable":true,"description":"Lambert 93 easting coordinate\\n"},"y":{"type":"string","nullable":true,"description":"Lambert 93 northing coordinate\\n"},"lon":{"type":"string","nullable":true,"description":"Longitude (WGS84) as returned from source data\\n"},"lat":{"type":"string","nullable":true,"description":"Latitude (WGS84) as returned from source data\\n"},"type_position":{"type":"string","nullable":true,"description":"Positional accuracy type (`entr\xe9e`, `b\xe2timent`, `parcelle`, `d\xe9livrance postale`, etc.)\\n"},"alias":{"type":"string","nullable":true,"description":"Address alias\\n"},"nom_ld":{"type":"string","nullable":true,"description":"Lieu-dit (named place) label\\n"},"libelle_acheminement":{"type":"string","nullable":true,"description":"Postal routing label\\n"},"nom_afnor":{"type":"string","nullable":true,"description":"AFNOR-normalised street name\\n"},"source_position":{"type":"string","nullable":true,"description":"Source of position data (`commune`, `IGN`, etc.)\\n"},"source_nom_voie":{"type":"string","nullable":true,"description":"Source of street name data\\n"},"certification_commune":{"type":"boolean","nullable":true,"description":"Whether the municipality has certified this address\\n"},"cad_parcelles":{"type":"string","nullable":true,"description":"Cadastral parcel reference(s)\\n"}},"example":{"id":"ban_01002_w4ld4h_00006","dataset":"ban","country":"France","country_iso":"FRA","country_iso_2":"FR","language":"fr","address":"6","line_1":"6 place du Pese Lait","line_2":"01640 L\'Abergement-de-Varey","latitude":46.005447,"longitude":5.425179,"id_fantoir":null,"numero":6,"rep":null,"nom_voie":"Place du Pese Lait","code_postal":"01640","code_insee":"01002","nom_commune":"L\'Abergement-de-Varey","code_insee_ancienne_commune":null,"nom_ancienne_commune":null,"x":"887643.67","y":"6547960.53","lon":"5.425179","lat":"46.005447","type_position":"entr\xe9e","alias":null,"nom_ld":null,"libelle_acheminement":"ABERGEMENT-DE-VAREY (L )","
1nom_afnor":"PLACE DU PESE LAIT","source_position":"commune","source_nom_voie":"commune","certification_commune":true,"cad_parcelles":"01002000AE0005"}},"SwtAddress":{"title":"Switzerland and Liechtenstein Address","description":"An address in the Swisstopo dataset, which covers Switzerland and Liechtenstein.\\n\\nFields are grouped by the upstream Swisstopo product they come from: the building address directory (`gebaeudeadressverzeichnis`), the street directory (`strassenverzeichnis`) and the official directory of towns and cities (`amtovz`).\\n\\nRecords marked as multilingual upstream are split into one address per street name, so `language` identifies the language of the street name.","type":"object","required":["id","dataset","country","country_iso","country_iso_2","language","canton","address","line_1","line_2","latitude","longitude","adr_egaid","str_esid","bdg_egid","adr_edid","stn_label","adr_number","bdg_category","bdg_name","zip_label","com_fosnr","com_name","com_canton","adr_status","adr_official","adr_modified","adr_easting","adr_northing","str_type","str_status","str_official","str_modified","str_easting","str_northing","ortschaftsname","plz4","zusatzziffer","zip_id","gemeindename","bfs_nr","kantonsk\xfcrzel","sprache","validity"],"properties":{"id":{"$ref":"#/components/schemas/ID"},"dataset":{"type":"string","enum":["swt"]},"country":{"type":"string","description":" Full country names (ISO 3166)\\n","enum":["Switzerland","Liechtenstein"]},"country_iso":{"type":"string","description":" 3 letter country code (ISO 3166-1)\\n","enum":["CHE","LIE"]},"country_iso_2":{"type":"string","description":" 2 letter country code (ISO 3166-1)\\n","enum":["CH","LI"]},"language":{"type":"string","description":"Language represented by 2 letter ISO Code (639-1)\\n","enum":["de","fr","it","rm"]},"canton":{"type":"string","description":"Canton name, in the language of the address (e.g. `\\"Basel-Stadt\\"`, `\\"Grigioni\\"`, `\\"Grischun\\"`). For Liechtenstein addresses this is the district.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"address":{"type":"string","description":"House number. Same value as `adr_number`.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"line_1":{"type":"string","description":"First address line. The building name where present, otherwise the street name and house number.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"line_2":{"type":"string","description":"Second address line. The street name and house number where `line_1` holds a building name.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"latitude":{"$ref":"#/components/schemas/Latitude"},"longitude":{"$ref":"#/components/schemas/Longitude"},"adr_egaid":{"type":"integer","description":"Federal building address identifier (Eidgen\xf6ssischer Geb\xe4udeadressidentifikator).\\n"},"str_esid":{"type":"integer","description":"Federal street identifier (Eidgen\xf6ssischer Strassenidentifikator). Joins the address to the street directory.\\n"},"bdg_egid":{"type":"integer","description":"Federal building identifier (Eidgen\xf6ssischer Geb\xe4udeidentifikator).\\n"},"adr_edid":{"type":"integer","description":"Entrance identifier within the building.\\n"},"stn_label":{"type":"string","description":"Street name label. For French and Italian addresses the leading street type is lowercased (e.g. `\\"rue de la Gare\\"`).\\n"},"adr_number":{"type":"string","description":"House/address number (e.g. `\\"12\\"`, `\\"12A\\"`).\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"bdg_category":{"type":"string","description":"Building category from the Federal Building and Dwelling Register (GWR), e.g. `\\"residential\\"`, `\\"non_residential\\"`.\\n"},"bdg_name":{"type":"string","description":"Building name.\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"zip_label":{"type":"string","description":"Postal code and locality label (e.g. `\\"8001 Z\xfcrich\\"`).\\n"},"com_fosnr":{"type":"integer","description":"Federal municipality number assigned by the Federal Statistical Office (FSO/BFS).\\n"},"com_name":{"type":"string","description":"Municipality name.\\n"},"com_canton":{"type":"string","description":"Canton abbreviation (e.g. `\\"ZH\\"`, `\\"BE\\"`).\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"adr_status":{"type":"string","description":"Address status from the GWR, e.g. `\\"real\\"`, `\\"projected\\"`.\\n"},"adr_official":{"type":"boolean","description":"Whether the address is an official address.\\n"},"adr_modified":{"type":"string","description":"Date the address record was last modified, formatted `DD.MM.YYYY`.\\n"},"adr_easting":{"type":"string","description":"Easting coordinate of the address in the Swiss coordinate system CH1903+/LV95 (EPSG:2056), in metres.\\n"},"adr_northing":{"type":"string","description":"Northing coordinate of the address in the Swiss coordinate system CH1903+/LV95 (EPSG:2056), in metres.\\n"},"str_type":{"type":"string","description":"Street type, e.g. `\\"Street\\"`, `\\"Area\\"`.\\n"},"str_status":{"type":"string","description":"Street status, e.g. `\\"real\\"`, `\\"projected\\"`.\\n"},"str_official":{"type":"boolean","description":"Whether the street name is official.\\n"},"str_modified":{"type":"string","description":"Date the street record was last modified, formatted `DD.MM.YYYY`.\\n"},"str_easting":{"type":"string","description":"Easting coordinate of the street centroid in the Swiss coordinate system CH1903+/LV95 (EPSG:2056), in metres.\\n"},"str_northing":{"type":"string","description":"Northing coordinate of the street centroid in the Swiss coordinate system CH1903+/LV95 (EPSG:2056), in metres.\\n"}
1,"ortschaftsname":{"type":"string","description":"Locality name from the Official Directory of Towns and Cities (Amtliches Ortschaftenverzeichnis).\\n\\nCan be empty string `\\"\\"` if the address does not match a locality record.\\n"},"plz4":{"type":"string","description":"4-digit Swiss postal code, zero padded.\\n\\nCan be empty string `\\"\\"` if the address does not match a locality record.\\n"},"zusatzziffer":{"type":"string","nullable":true,"description":"2-digit supplementary code distinguishing localities that share a 4-digit postal code.\\n\\n`null` if the address does not match a locality record.\\n"},"zip_id":{"type":"integer","nullable":true,"description":"Unique identifier for the postal code record.\\n\\n`null` if the address does not match a locality record.\\n"},"gemeindename":{"type":"string","nullable":true,"description":"Municipality name (Gemeindename) from the locality directory.\\n\\n`null` if the address does not match a locality record.\\n"},"bfs_nr":{"type":"integer","nullable":true,"description":"Federal municipality number assigned by the Federal Statistical Office (BFS-Nr).\\n\\n`null` if the address does not match a locality record.\\n"},"kantonsk\xfcrzel":{"type":"string","description":"Canton abbreviation from the locality directory (e.g. `\\"ZH\\"`, `\\"GE\\"`).\\n\\nCan be empty string `\\"\\"` if not present.\\n"},"sprache":{"type":"string","nullable":true,"description":"Language of the address, mirroring `language`.\\n"},"validity":{"type":"string","nullable":true,"description":"Date the postal code record became valid, formatted `YYYY-MM-DD`.\\n"}},"example":{"id":"swt_102410972|de","dataset":"swt","country":"Switzerland","country_iso":"CHE","country_iso_2":"CH","language":"de","canton":"Basel-Stadt","address":"15.1","line_1":"Brohegasse 15.1","line_2":"","latitude":47.571268381201655,"longitude":7.663107983521497,"adr_egaid":102410972,"str_esid":10025136,"bdg_egid":243057973,"adr_edid":0,"stn_label":"Brohegasse","adr_number":"15.1","bdg_category":"non_residential","bdg_name":"","zip_label":"4126 Bettingen","com_fosnr":2702,"com_name":"Bettingen","com_canton":"BS","adr_status":"real","adr_official":false,"adr_modified":"23.07.2024","adr_easting":"2616891.820","adr_northing":"1268975.560","str_type":"Street","str_status":"real","str_official":true,"str_modified":"23.07.2024","str_easting":"2616922.086","str_northing":"1268999.001","ortschaftsname":"Bettingen","plz4":"4126","zusatzziffer":"00","zip_id":2531,"gemeindename":"Bettingen","bfs_nr":2702,"kantonsk\xfcrzel":"BS","sprache":"de","validity":"2008-07-01"}},"AddressListItem":{"title":"Address (list endpoints)","description":"A single address, as returned by the postcode and address list endpoints. Every other endpoint returns `Address`, the same set of fields with `native` on every record.\\n\\nThe standard Ideal Postcodes address. Its fields follow the layout UK address databases typically use, and much of it reflects Royal Mail\'s Postcode Address File, the UK\'s primary address database.\\n\\nThe API converts non-UK addresses into the same UK layout so they insert into a standard address database.\\n\\nPay attention to the address lines (`line_1`, `line_2` and `line_3`), post town, postcode, county and country. Together they are all you need to identify an address uniquely, in the UK or as an international address.\\n\\nFor international addresses, cities map to `post_town` and states map to `county`.\\n\\nAddresses from AddressBase (`ab`, `abp`) and non-UK datasets also carry a `native` object: the raw record from its source dataset, with local detail the standard fields cannot hold. It is never returned for the Royal Mail PAF family (`paf`, `mr`, `nyb`, `pafa`, `pafw`) on these two endpoints. E.g.\\n\\n- ECAD records say whether an address sits in a Gaeltacht (Irish-speaking) district and whether the building is residential or commercial\\n- USPS records carry the carrier route and congressional district\\n- Kadaster records carry the floor area, year of completion and use (residential, office, retail)","example":{"id":"paf_23747771","dataset":"paf","country_iso":"GBR","country_iso_2":"GB","country":"England","language":"en","postcode":"SW1A 2AA","postcode_inward":"2AA","postcode_outward":"SW1A","post_town":"London","dependant_locality":"","double_dependant_locality":"","thoroughfare":"Downing Street","dependant_thoroughfare":"","building_number":"10","building_name":"","sub_building_name":"","po_box":"","department_name":"","organisation_name":"Prime Minister & First Lord Of The Treasury","udprn":23747771,"umprn":"","uprn":"100023336956","postcode_type":"S","su_organisation_indicator":"","delivery_point_suffix":"1A","line_1":"Prime Minister & First Lord Of The Treasury","line_2":"10 Downing Street","line_3":"","premise":"10","longitude":-0.12767,"latitude":51.503541,"eastings":530047,"northings":179951,"county":"London","county_code":"","traditional_county":"Greater London","administrative_county":"","postal_county":"London","district":"Westminster","ward":"St. James\'s"},"type":"object","required":["postcode","postcode_outward","postcode_inward","post_town","dependant_locality","double_dependant_locality","thoroughfare","dependant_thoroughfare","building_number","building_name","sub_building_name","po_box","department_name","organisation_name","udprn","umprn","postcode_type","su_organisation_indicator","delivery_point_suffix","line_1","line_2","line_3","premise","country","administrative_county","postal_county","traditional_county","district","
1ward","longitude","latitude","eastings","northings","uprn","county","county_code","id","dataset","country_iso","country_iso_2","language"],"properties":{"id":{"$ref":"#/components/schemas/ID"},"dataset":{"$ref":"#/components/schemas/Dataset"},"country_iso":{"$ref":"#/components/schemas/CountryISO"},"country_iso_2":{"$ref":"#/components/schemas/CountryISO2"},"country":{"$ref":"#/components/schemas/Country"},"language":{"$ref":"#/components/schemas/Language"},"line_1":{"title":"Line 1","type":"string","description":"First address line. Often contains premise and thoroughfare information. For a commercial premise the first line is the full name of the registered organisation. Never empty."},"line_2":{"title":"Line 2","type":"string","description":"Second address line. Often contains thoroughfare and locality information. May be empty."},"line_3":{"title":"Line 3","type":"string","description":"Third address line. Takes the address elements left after `line_1` and `line_2` are filled; where the address needs more than three lines the remaining elements are joined into `line_3`, comma separated. May be empty."},"post_town":{"title":"Post Town","type":"string","description":"The town or city used to route mail to the address. For UK addresses this is the Royal Mail post town, which is a routing instruction rather than the nearest town geographically. Present on every address."},"postcode":{"title":"Postcode","type":"string","description":"Correctly formatted postcode. Capitalised and spaced. Empty (`\\"\\"`) where the address has no postcode."},"county":{"title":"County","type":"string","description":"Whatever county data is available for the address. Normally the postal county. If that is not present it falls back to the administrative county, then to the traditional county. May be empty where none of the three is present."},"county_code":{"title":"County Code","type":"string","description":"Short code representing the county or province. May be empty (`\\"\\"`)"},"uprn":{"title":"Unique Property Reference Number","type":"string","description":"UPRN stands for Unique Property Reference Number and is maintained by the Ordnance Survey (OS). Local governments in the UK have allocated a unique number for each land or property.\\n\\nUp to 12 digits in length.\\n\\nMultiple Residence premises currently share the same UPRN as the parent premise.\\n\\nMay not be available for a small number of Great Britain addresses due to longer update cycles for Ordnance Survey\'s AddressBase datasets. Returns empty string \\"\\" in these instances, as it does for addresses outside the UK.\\n\\nAlthough UPRN takes an integer format, we encode and transmit this data as strings. As a 12 digit number, the UPRN can exceed the maximum safe integer `Number.MAX_SAFE_INTEGER` in most browsers causing this datapoint to be corrupted.\\n\\nTake special care when storing UPRN. As a 12 digit identifier, you will need 64 bits to encode every possible UPRN value. This means applications like Excel will corrupt cells containing UPRN values."},"udprn":{"title":"Unique Delivery Point Reference Number (UDPRN)","description":"UDPRN stands for \'Unique Delivery Point Reference Number\'. Royal Mail assigns a unique UDPRN code for each premise on PAF. Simple, unique reference number for each Delivery Point. Unlikely to be reused when an address expires.\\n\\nUp to 8-digit numeric code. A new UDPRN is automatically assigned to each new Delivery Point added to PAF.\\n\\nReturns `0` on a UK dataset that carries no UDPRN for the address, and an empty string `\\"\\"` on a non-UK address. Use `id` for an identifier present on every address.","oneOf":[{"type":"integer","format":"int32","description":"UDPRN of the delivery point. `0` where none is available"},{"type":"string","description":"Empty string `\\"\\"` for non-UK addresses","enum":[""]}]},"umprn":{"title":"UMPRN","description":"A small minority of individual premises (as identified by a UDPRN) may have multiple occupants behind the same letterbox. These are known as Multiple Residence occupants and can be queried via the Multiple Residence dataset. Simple, unique reference number for each Multiple Residence occupant.\\n\\nNote: this will be an empty string `\\"\\"` when not used.","oneOf":[{"type":"string","description":"If premise is not multiple occupancy, this will be an empty string"},{"type":"number","description":"If premise is multiple occupancy, this will be an integer","minimum":0,"maximum":99999999}]},"postcode_outward":{"title":"Postcode Outward","type":"string","description":"The first part of a postcode is known as the outward code. e.g. The outward code of ID1 1QD is ID1. Enables mail to be sorted to the correct local area for delivery. This part of the code contains the area and the district to which the mail is to be delivered, e.g. \'PO1\', \'SW1A\' or \'B23\'.\\n\\nEmpty (`\\"\\"`) where the address has no UK postcode."},"postcode_inward":{"title":"Postcode Inward","type":"string","description":"The second part of a postcode is known as the inward code. e.g. The inward code of ID1 1QD is 1QD.\\n\\nThe number identifies the sector in the postal district. The number is followed by 2 letters. The letters then define one or more properties in that sector.\\n\\nEmpty (`\\"\\"`) where the address has no UK postcode."}
1,"dependant_locality":{"title":"Dependant Locality","type":"string","description":"A locality that qualifies the thoroughfare. Used where the same thoroughfare name occurs more than once in a post town and no dependant thoroughfare distinguishes them. May be empty."},"double_dependant_locality":{"title":"Double Dependant Locality","type":"string","description":"Supplements dependant locality. Supplied where the dependant locality itself occurs twice in the same locality. May be empty."},"thoroughfare":{"title":"Thoroughfare","type":"string","description":"Also known as the street or road name. May be empty."},"dependant_thoroughfare":{"title":"Dependant Thoroughfare","type":"string","description":"Supplements thoroughfare. Used where a thoroughfare name occurs twice in the same post town, to identify the address uniquely. May be empty."},"building_number":{"title":"Building Number","type":"string","description":"Number identifying the premise on a thoroughfare or dependant thoroughfare. May be empty."},"building_name":{"title":"Building Name","type":"string","description":"Name of a residential or commercial premise. May be empty.\\n\\nExamples:\\n - The Manor\\n - 1-2\\n - A\\n - 12A\\n - K\\n - Victoria House"},"sub_building_name":{"title":"Sub-Building Name","type":"string","description":"Identifies a unit where a premise is split into flats, apartments or business units. Cannot be present without either building_name or building_number. E.g. Flat 1, A, 10B. May be empty."},"po_box":{"title":"PO Box","type":"string","description":"PO Box number for the address, occasionally a combination of numbers and letters. Allocated to Large User postcodes only. May be empty."},"department_name":{"title":"Department Name","type":"string","description":"Supplements organisation name to identify a department within the organisation. May be empty."},"organisation_name":{"title":"Organisation Name","type":"string","description":"Name of the business or organisation at this address. May be empty."},"postcode_type":{"title":"Postcode Type","description":"Royal Mail postcode user type. UK addresses only.\\n\\n - `S` small user. The postcode identifies a group of delivery points. There are on average 19 delivery points per postcode, and never more than 100\\n - `L` large user. The postcode is assigned to a single address, either because of the volume of mail it receives or because a PO Box or Selectapost service is set up\\n\\nEmpty (`\\"\\"`) where not applicable.","enum":["S","L",""]},"su_organisation_indicator":{"title":"Small User Organisation Indicator","type":"string","description":"`Y` where an organisation is present at a small user postcode. Empty (`\\"\\"`) otherwise. UK addresses only."},"delivery_point_suffix":{"title":"Delivery Point Suffix","type":"string","description":"Two-character code (the first numeric, the second alphabetical) which, added to the postcode, uniquely identifies a delivery point. May be reused once a delivery point is deleted, though not until every remaining code in the range has been allocated. Always `1A` for a large user postcode, since each large user has its own postcode. Empty (`\\"\\"`) where not available."},"premise":{"title":"Premise","type":"string","description":"A pre-computed string which sensibly combines building_number, building_name and sub_building_name. Those three fields hold raw dataset values and can be difficult to parse if you are unaware of how they work together, so we also provide this single, simple premise string. Ideal if you want to pull premise information and thoroughfare information separately instead of using our address lines data."},"administrative_county":{"title":"Administrative County","type":"string","description":"The current administrative county to which the postcode has been assigned.\\n\\nA Unitary Authority name, where one is present. If there is no Unitary Authority, the County name is used. This information is not static, because County boundaries may change due to administrative changes.\\n\\nSource: ONS. May be empty."},"postal_county":{"title":"Postal County","type":"string","description":"Postal counties were used for the distribution of mail before the Postcode system was introduced in the 1970s. The Former Postal County was the Administrative County at the time. This data rarely changes. May be empty."},"traditional_county":{"title":"Traditional County","type":"string","description":"Traditional counties are provided by the Association of British Counties. It is historical data, and can date from the 1800s. May be empty."},"district":{"title":"District","type":"string","description":"The current district/unitary authority to which the postcode has been assigned. May be empty."},"ward":{"title":"Ward","type":"string","description":"The current administrative/electoral area to which the postcode has been assigned. May be empty for a small number of addresses."},"longitude":{"$ref":"#/components/schemas/Longitude"},"latitude":{"$ref":"#/components/schemas/Latitude"},"eastings":{"$ref":"#/components/schemas/Eastings"},"northings":{"$ref":"#/components/schemas/Northings"},"native":{"description":"The raw dataset record backing this address. On these two endpoints it is returned for AddressBase (`ab`, `abp`) and non-UK datasets only, never for the PAF family. Use any other endpoint for a PAF native record.\\n","oneOf":[{"$ref":"#/components/schemas/AbAddress"},{"$ref":"#/components/schemas/AbpAddress"},{"$ref":"#/components/schemas/UspsAddress"},{"$ref":"#/components/schemas/EcadAddress"},{"$ref":"#/components/schemas/EcafAddress"},{"$ref":"#/components/schemas/HereAddress"},{"$ref":"#/components/schemas/GnafAddress"},{"$ref":"#/components/schemas/KadasterAddress"},{"$ref":"#/components/schemas/KartverketAddress"},{"$ref":"#/components/schemas/SdfiAddress"},{"$ref":"#/components/schemas/CannarAddress"},{"$ref":"#/components/schemas/FodbosaAddress"}
1,{"$ref":"#/components/schemas/MoisAddress"},{"$ref":"#/components/schemas/UpujpAddress"},{"$ref":"#/components/schemas/BevAddress"},{"$ref":"#/components/schemas/BanAddress"},{"$ref":"#/components/schemas/SwtAddress"}]}}},"PostcodeResponse":{"title":"Postcode Response","type":"object","required":["message","code","result","limit","page","total"],"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/AddressListItem"},"description":"All addresses listed at the postcode.\\n\\nIf Eircode is enabled, addresses for the Republic of Ireland will be returned in the English format.\\n"},"code":{"type":"integer","enum":[2000]},"message":{"type":"string","enum":["Success"]},"page":{"type":"integer","minimum":0,"maximum":10,"default":0},"limit":{"type":"integer","minimum":1,"maximum":100,"default":100},"total":{"type":"integer"}}},"PostcodeNotFoundResponse":{"title":"Postcode Not Found","type":"object","required":["message","code","suggestions"],"properties":{"code":{"type":"integer","format":"int32","enum":[4040]},"message":{"type":"string","enum":["Postcode not found"]},"suggestions":{"description":"A list of alternate nearest matching postcodes you can try","type":"array","items":{"type":"string","example":"SN13 0SF"}}}},"PafRecordBase":{"title":"PAF Native Record (Base)","description":"Fields shared by every Royal Mail PAF family native record (`paf`, `mr`, `nyb`, `pafa`, `pafw`).\\n\\nThe Royal Mail record as held in Postgres, before any derived fields are added. Formatted lines, `premise`, postcode parts, geocodes, UPRN and county fields belong to the address, not to the native record. `dataset` is the one field not taken from Royal Mail.\\n\\nTwo values differ from the raw PAF file: `post_town` is title cased (Royal Mail supplies it upper cased), and a `building_number` of `0`, PAF\'s sentinel for \\"none\\", is returned as an empty string.","type":"object","required":["dataset","postcode","post_town","dependant_locality","double_dependant_locality","thoroughfare","dependant_thoroughfare","building_number","building_name","sub_building_name","department_name","organisation_name","udprn","postcode_type","su_organisation_indicator","delivery_point_suffix"],"properties":{"dataset":{"type":"string","description":"Dataset the record belongs to. The only field not taken from the Royal Mail record"},"postcode":{"type":"string","maxLength":8,"minLength":6,"description":"Postcode, space separated"},"post_town":{"type":"string","maxLength":30,"description":"Royal Mail post town, title cased"},"dependant_locality":{"type":"string","maxLength":35,"description":"Dependant locality. Empty string when not present"},"double_dependant_locality":{"type":"string","maxLength":35,"description":"Double dependant locality. Empty string when not present"},"thoroughfare":{"type":"string","maxLength":80,"description":"Street name"},"dependant_thoroughfare":{"type":"string","maxLength":80,"description":"Dependant street name. Empty string when not present"},"building_number":{"type":"string","maxLength":4,"description":"Building number. Empty string when not present, or when PAF merges it into the building name"},"building_name":{"type":"string","maxLength":50,"description":"Building name. Empty string when not present"},"sub_building_name":{"type":"string","maxLength":30,"description":"Sub building name. Empty string when not present"},"department_name":{"type":"string","maxLength":60,"description":"Department name within an organisation. Empty string when not present"},"organisation_name":{"type":"string","maxLength":60,"description":"Organisation name. Empty string when not present"},"udprn":{"type":"integer","description":"Unique Delivery Point Reference Number"},"postcode_type":{"type":"string","description":"Postcode type.\\n\\n - `S` Small user\\n - `L` Large user\\n - `\\"\\"` where Royal Mail supplies none\\n","enum":["S","L",""]},"su_organisation_indicator":{"type":"string","maxLength":1,"description":"Small user organisation indicator. `Y` where the small user postcode is held by an organisation"},"delivery_point_suffix":{"type":"string","maxLength":2,"description":"Royal Mail delivery point suffix"}},"example":{"dataset":"paf","postcode":"SW1A 2AA","post_town":"London","dependant_locality":"","double_dependant_locality":"","thoroughfare":"Downing Street","dependant_thoroughfare":"","building_number":"10","building_name":"","sub_building_name":"","department_name":"","organisation_name":"Prime Minister & First Lord Of The Treasury","udprn":23747771,"postcode_type":"S","su_organisation_indicator":"","delivery_point_suffix":"1A"}},"PafAddress":{"title":"Royal Mail Postcode Address File Address","description":"Raw Royal Mail Postcode Address File record backing a `paf` address.","allOf":[{"$ref":"#/components/schemas/PafRecordBase"},{"type":"object","required":["po_box"],"properties":{"po_box":{"type":"string","maxLength":6,"description":"PO Box number. Empty string when not present"},"dataset":{"type":"string","enum":["paf"]}}}],"example":{"dataset":"paf","postcode":"SW1A 2AA","post_town":"London","dependant_locality":"","double_dependant_locality":"","thoroughfare":"Downing Street","dependant_thoroughfare":"","building_number":"10","building_name":"","sub_building_name":"","po_box":"","department_name":"","organisation_name":"Prime Minister & First Lord Of The Treasury","udprn":23747771,"postcode_type":"S","su_organisation_indicator":"","delivery_point_suffix":"1A"}},"MrAddress":{"title":"Multiple Residence Address","description":"Raw Royal Mail Multiple Residence record backing an `mr` address.\\n\\nMultiple Residence holds sub-premises (flats, rooms) that share a parent PAF delivery point. `umprn` keys the residence, `udprn` the parent delivery point. The record has no `po_box`.","allOf":[{"$ref":"#/components/schemas/PafRecordBase"},{"type":"object","required":["umprn"],"properties":{"dataset":{"type":"string","enum":["mr"]},"umprn":{"type":"integer","description":"Unique Multiple Residence Reference Number"}}}],"example":{"dataset":"mr","postcode":"SW1A 2AA","post_town":"London","dependant_locality":"","double_dependant_locality":"","thoroughfare":"Downing Street","dependant_thoroughfare":"","building_number":"10","building_name":"","sub_building_name":"Flat 1","department_name":"","organisation_name":"","udprn":23747771,"postcode_type":"S","su_organisation_indicator":"","delivery_point_suffix":"1A","umprn":50906058}},"NybAddress":{"title":"Not Yet Built Address","description":"Raw Royal Mail Not Yet Built record backing an `nyb` address.\\n\\nDelivery points Royal Mail has allocated for addresses under construction, ahead of them appearing in PAF. Same shape as a PAF record.","allOf":[{"$ref":"#/components/schemas/PafRecordBase"},{"type":"object","required":["po_box"],"properties":{"po_box":{"type":"string","maxLength":6,"description":"PO Box number. Empty string when not present"},"dataset":{"type":"string","enum":["nyb"]}}}],"example":{"dataset":"nyb","postcode":"L1 8JQ","post_town":"Liverpool","dependant_locality":"","double_dependant_locality":"","thoroughfare":"Wall Street","dependant_thoroughfare":"","building_number":"","building_name":"2b","sub_building_name":"","po_box":"","department_name":"","organisation_name":"","udprn":53656380,"postcode_type":"S","su_organisation_indicator":"","delivery_point_suffix":"1R"}},"PafaAddress":{"title":"PAF Alias Address","description":"The Royal Mail PAF record backing a `pafa` address, with the alias applied. Alias data holds alternative address details the public uses when addressing mail, which are not required for delivery.\\n\\nThis is the parent delivery point, not the alias row: the alias text replaces the building name, organisation name or department name, so those three fields carry the alias and the rest is the parent PAF record. The alias row\'s own columns (`alias_text`, `category`, `currency`) are not yet returned. `id` is the parent UDPRN plus a hash of the alias text, since a delivery point can carry several aliases.","allOf":[{"$ref":"#/components/schemas/PafRecordBase"},{"type":"object","required":["po_box"],"properties":{"po_box":{"type":"string","maxLength":6,"description":"PO Box number. Empty string when not present"},"dataset":{"type":"string","enum":["pafa"]}}}],"example":{"dataset":"pafa","postcode":"SW1A 1AA","post_town":"London","dependant_locality":"","double_dependant_locality":"","thoroughfare":"The Mall","dependant_thoroughfare":"","building_number":"1","building_name":"The Old Post Office","sub_building_name":"","po_box":"","department_name":"","organisation_name":"","udprn":90000001,"postcode_type":"S","su_organisation_indicator":"","delivery_point_suffix":"1A"}},"PafwAddress":{"title":"Welsh PAF Address","description":"Raw Royal Mail Welsh language record backing a `pafw` address.\\n\\nWelsh alternatives for addresses in the sectors Royal Mail defines as part of the Welsh principality. Same shape as a PAF record, keyed on the same UDPRN.","allOf":[{"$ref":"#/components/schemas/PafRecordBase"},{"type":"object","required":["po_box"],"properties":{"po_box":{"type":"string","maxLength":6,"description":"PO Box number. Empty string when not present"},"dataset":{"type":"string","enum":["pafw"]}}}],"example":{"dataset":"pafw","postcode":"CF10 1EP","post_town":"Caerdydd","dependant_locality":"","double_dependant_locality":"","thoroughfare":"Heol Eglwys Fair","dependant_thoroughfare":"","building_number":"1","building_name":"","sub_building_name":"","po_box":"","department_name":"","organisation_name":"","udprn":90000003,"postcode_type":"S","su_organisation_indicator":"","delivery_point_suffix":"1A"}},"NativeRecord":{"title":"Native Record","description":"The raw dataset record backing an address, exactly as the dataset supplies it. One schema per dataset; `dataset` on the record says which.","oneOf":[{"$ref":"#/components/schemas/PafAddress"}
1,{"$ref":"#/components/schemas/MrAddress"},{"$ref":"#/components/schemas/NybAddress"},{"$ref":"#/components/schemas/PafaAddress"},{"$ref":"#/components/schemas/PafwAddress"},{"$ref":"#/components/schemas/AbAddress"},{"$ref":"#/components/schemas/AbpAddress"},{"$ref":"#/components/schemas/UspsAddress"},{"$ref":"#/components/schemas/EcadAddress"},{"$ref":"#/components/schemas/EcafAddress"},{"$ref":"#/components/schemas/HereAddress"},{"$ref":"#/components/schemas/GnafAddress"},{"$ref":"#/components/schemas/KadasterAddress"},{"$ref":"#/components/schemas/KartverketAddress"},{"$ref":"#/components/schemas/SdfiAddress"},{"$ref":"#/components/schemas/CannarAddress"},{"$ref":"#/components/schemas/FodbosaAddress"},{"$ref":"#/components/schemas/MoisAddress"},{"$ref":"#/components/schemas/UpujpAddress"},{"$ref":"#/components/schemas/BevAddress"},{"$ref":"#/components/schemas/BanAddress"},{"$ref":"#/components/schemas/SwtAddress"}]},"Address":{"title":"Address","description":"The standard Ideal Postcodes address, which maps both UK and International addresses.\\n\\nIts fields follow the layout UK address databases typically use, and much of it reflects Royal Mail\'s Postcode Address File, the UK\'s primary address database.\\n\\nThe API converts non-UK addresses into the same UK layout so international addresses will also seamlessly insert into a standard address database. Despite this mapping fidelity to the source is never compromised with the `native` address field.\\n\\nPay attention to the address lines (`line_1`, `line_2` and `line_3`), post town, postcode, county and country. Together they are all you need to identify an address uniquely, in the UK or as an international address.\\n\\nFor international addresses, cities map to `post_town` and states map to `county`.\\n\\nEvery address carries a `native` object: the raw record from its source dataset, exactly as the dataset supplies it, with local detail the standard fields cannot hold. E.g.\\n\\n- ECAD records say whether an address sits in a Gaeltacht (Irish-speaking) district and whether the building is residential or commercial\\n- USPS records carry the carrier route and congressional district\\n- Kadaster records carry the floor area, year of completion and use (residential, office, retail)\\n\\nThe postcode and address list endpoints return the older `AddressListItem` shape instead, where `native` is absent for the Royal Mail PAF family.","example":{"id":"paf_23747771","dataset":"paf","country_iso":"GBR","country_iso_2":"GB","country":"England","language":"en","postcode":"SW1A 2AA","postcode_inward":"2AA","postcode_outward":"SW1A","post_town":"London","dependant_locality":"","double_dependant_locality":"","thoroughfare":"Downing Street","dependant_thoroughfare":"","building_number":"10","building_name":"","sub_building_name":"","po_box":"","department_name":"","organisation_name":"Prime Minister & First Lord Of The Treasury","udprn":23747771,"umprn":"","uprn":"100023336956","postcode_type":"S","su_organisation_indicator":"","delivery_point_suffix":"1A","line_1":"Prime Minister & First Lord Of The Treasury","line_2":"10 Downing Street","line_3":"","premise":"10","longitude":-0.12767,"latitude":51.503541,"eastings":530047,"northings":179951,"county":"London","county_code":"","traditional_county":"Greater London","administrative_county":"","postal_county":"London","district":"Westminster","ward":"St. James\'s","native":{"dataset":"paf","postcode":"SW1A 2AA","post_town":"London","dependant_locality":"","double_dependant_locality":"","thoroughfare":"Downing Street","dependant_thoroughfare":"","building_number":"10","building_name":"","sub_building_name":"","po_box":"","department_name":"","organisation_name":"Prime Minister & First Lord Of The Treasury","udprn":23747771,"postcode_type":"S","su_organisation_indicator":"","delivery_point_suffix":"1A"}},"type":"object","required":["postcode","postcode_outward","postcode_inward","post_town","dependant_locality","double_dependant_locality","thoroughfare","dependant_thoroughfare","building_number","building_name","sub_building_name","po_box","department_name","organisation_name","udprn","umprn","postcode_type","su_organisation_indicator","delivery_point_suffix","line_1","line_2","line_3","premise","country","administrative_county","postal_county","traditional_county","district","
1ward","longitude","latitude","eastings","northings","uprn","county","county_code","id","dataset","country_iso","country_iso_2","language","native"],"properties":{"id":{"$ref":"#/components/schemas/ID"},"dataset":{"$ref":"#/components/schemas/Dataset"},"country_iso":{"$ref":"#/components/schemas/CountryISO"},"country_iso_2":{"$ref":"#/components/schemas/CountryISO2"},"country":{"$ref":"#/components/schemas/Country"},"language":{"$ref":"#/components/schemas/Language"},"line_1":{"title":"Line 1","type":"string","description":"First address line. Often contains premise and thoroughfare information. For a commercial premise the first line is the full name of the registered organisation. Never empty."},"line_2":{"title":"Line 2","type":"string","description":"Second address line. Often contains thoroughfare and locality information. May be empty."},"line_3":{"title":"Line 3","type":"string","description":"Third address line. Takes the address elements left after `line_1` and `line_2` are filled; where the address needs more than three lines the remaining elements are joined into `line_3`, comma separated. May be empty."},"post_town":{"title":"Post Town","type":"string","description":"The town or city used to route mail to the address. For UK addresses this is the Royal Mail post town, which is a routing instruction rather than the nearest town geographically. Present on every address."},"postcode":{"title":"Postcode","type":"string","description":"Correctly formatted postcode. Capitalised and spaced. Empty (`\\"\\"`) where the address has no postcode."},"county":{"title":"County","type":"string","description":"Whatever county data is available for the address. Normally the postal county. If that is not present it falls back to the administrative county, then to the traditional county. May be empty where none of the three is present."},"county_code":{"title":"County Code","type":"string","description":"Short code representing the county or province. May be empty (`\\"\\"`)"},"uprn":{"title":"Unique Property Reference Number","type":"string","description":"UPRN stands for Unique Property Reference Number and is maintained by the Ordnance Survey (OS). Local governments in the UK have allocated a unique number for each land or property.\\n\\nUp to 12 digits in length.\\n\\nMultiple Residence premises currently share the same UPRN as the parent premise.\\n\\nMay not be available for a small number of Great Britain addresses due to longer update cycles for Ordnance Survey\'s AddressBase datasets. Returns empty string \\"\\" in these instances, as it does for addresses outside the UK.\\n\\nAlthough UPRN takes an integer format, we encode and transmit this data as strings. As a 12 digit number, the UPRN can exceed the maximum safe integer `Number.MAX_SAFE_INTEGER` in most browsers causing this datapoint to be corrupted.\\n\\nTake special care when storing UPRN. As a 12 digit identifier, you will need 64 bits to encode every possible UPRN value. This means applications like Excel will corrupt cells containing UPRN values."},"udprn":{"title":"Unique Delivery Point Reference Number (UDPRN)","description":"UDPRN stands for \'Unique Delivery Point Reference Number\'. Royal Mail assigns a unique UDPRN code for each premise on PAF. Simple, unique reference number for each Delivery Point. Unlikely to be reused when an address expires.\\n\\nUp to 8-digit numeric code. A new UDPRN is automatically assigned to each new Delivery Point added to PAF.\\n\\nReturns `0` on a UK dataset that carries no UDPRN for the address, and an empty string `\\"\\"` on a non-UK address. Use `id` for an identifier present on every address.","oneOf":[{"type":"integer","format":"int32","description":"UDPRN of the delivery point. `0` where none is available"},{"type":"string","description":"Empty string `\\"\\"` for non-UK addresses","enum":[""]}]},"umprn":{"title":"UMPRN","description":"A small minority of individual premises (as identified by a UDPRN) may have multiple occupants behind the same letterbox. These are known as Multiple Residence occupants and can be queried via the Multiple Residence dataset. Simple, unique reference number for each Multiple Residence occupant.\\n\\nNote: this will be an empty string `\\"\\"` when not used.","oneOf":[{"type":"string","description":"If premise is not multiple occupancy, this will be an empty string"},{"type":"number","description":"If premise is multiple occupancy, this will be an integer","minimum":0,"maximum":99999999}]},"postcode_outward":{"title":"Postcode Outward","type":"string","description":"The first part of a postcode is known as the outward code. e.g. The outward code of ID1 1QD is ID1. Enables mail to be sorted to the correct local area for delivery. This part of the code contains the area and the district to which the mail is to be delivered, e.g. \'PO1\', \'SW1A\' or \'B23\'.\\n\\nEmpty (`\\"\\"`) where the address has no UK postcode."},"postcode_inward":{"title":"Postcode Inward","type":"string","description":"The second part of a postcode is known as the inward code. e.g. The inward code of ID1 1QD is 1QD.\\n\\nThe number identifies the sector in the postal district. The number is followed by 2 letters. The letters then define one or more properties in that sector.\\n\\nEmpty (`\\"\\"`) where the address has no UK postcode."}
1,"dependant_locality":{"title":"Dependant Locality","type":"string","description":"A locality that qualifies the thoroughfare. Used where the same thoroughfare name occurs more than once in a post town and no dependant thoroughfare distinguishes them. May be empty."},"double_dependant_locality":{"title":"Double Dependant Locality","type":"string","description":"Supplements dependant locality. Supplied where the dependant locality itself occurs twice in the same locality. May be empty."},"thoroughfare":{"title":"Thoroughfare","type":"string","description":"Also known as the street or road name. May be empty."},"dependant_thoroughfare":{"title":"Dependant Thoroughfare","type":"string","description":"Supplements thoroughfare. Used where a thoroughfare name occurs twice in the same post town, to identify the address uniquely. May be empty."},"building_number":{"title":"Building Number","type":"string","description":"Number identifying the premise on a thoroughfare or dependant thoroughfare. May be empty."},"building_name":{"title":"Building Name","type":"string","description":"Name of a residential or commercial premise. May be empty.\\n\\nExamples:\\n - The Manor\\n - 1-2\\n - A\\n - 12A\\n - K\\n - Victoria House"},"sub_building_name":{"title":"Sub-Building Name","type":"string","description":"Identifies a unit where a premise is split into flats, apartments or business units. Cannot be present without either building_name or building_number. E.g. Flat 1, A, 10B. May be empty."},"po_box":{"title":"PO Box","type":"string","description":"PO Box number for the address, occasionally a combination of numbers and letters. Allocated to Large User postcodes only. May be empty."},"department_name":{"title":"Department Name","type":"string","description":"Supplements organisation name to identify a department within the organisation. May be empty."},"organisation_name":{"title":"Organisation Name","type":"string","description":"Name of the business or organisation at this address. May be empty."},"postcode_type":{"title":"Postcode Type","description":"Royal Mail postcode user type. UK addresses only.\\n\\n - `S` small user. The postcode identifies a group of delivery points. There are on average 19 delivery points per postcode, and never more than 100\\n - `L` large user. The postcode is assigned to a single address, either because of the volume of mail it receives or because a PO Box or Selectapost service is set up\\n\\nEmpty (`\\"\\"`) where not applicable.","enum":["S","L",""]},"su_organisation_indicator":{"title":"Small User Organisation Indicator","type":"string","description":"`Y` where an organisation is present at a small user postcode. Empty (`\\"\\"`) otherwise. UK addresses only."},"delivery_point_suffix":{"title":"Delivery Point Suffix","type":"string","description":"Two-character code (the first numeric, the second alphabetical) which, added to the postcode, uniquely identifies a delivery point. May be reused once a delivery point is deleted, though not until every remaining code in the range has been allocated. Always `1A` for a large user postcode, since each large user has its own postcode. Empty (`\\"\\"`) where not available."},"premise":{"title":"Premise","type":"string","description":"A pre-computed string which sensibly combines building_number, building_name and sub_building_name. Those three fields hold raw dataset values and can be difficult to parse if you are unaware of how they work together, so we also provide this single, simple premise string. Ideal if you want to pull premise information and thoroughfare information separately instead of using our address lines data."},"administrative_county":{"title":"Administrative County","type":"string","description":"The current administrative county to which the postcode has been assigned.\\n\\nA Unitary Authority name, where one is present. If there is no Unitary Authority, the County name is used. This information is not static, because County boundaries may change due to administrative changes.\\n\\nSource: ONS. May be empty."},"postal_county":{"title":"Postal County","type":"string","description":"Postal counties were used for the distribution of mail before the Postcode system was introduced in the 1970s. The Former Postal County was the Administrative County at the time. This data rarely changes. May be empty."},"traditional_county":{"title":"Traditional County","type":"string","description":"Traditional counties are provided by the Association of British Counties. It is historical data, and can date from the 1800s. May be empty."},"district":{"title":"District","type":"string","description":"The current district/unitary authority to which the postcode has been assigned. May be empty."},"ward":{"title":"Ward","type":"string","description":"The current administrative/electoral area to which the postcode has been assigned. May be empty for a small number of addresses."},"longitude":{"$ref":"#/components/schemas/Longitude"},"latitude":{"$ref":"#/components/schemas/Latitude"},"eastings":{"$ref":"#/components/schemas/Eastings"},"northings":{"$ref":"#/components/schemas/Northings"},"native":{"$ref":"#/components/schemas/NativeRecord"}}},"UDPRNResponse":{"title":"UDPRN Response","type":"object","required":["message","code","result"],"properties":{"result":{"$ref":"#/components/schemas/Address"},"code":{"type":"integer","format":"int32","enum":[2000]},"message":{"type":"string","enum":["Success"]}}},"UMPRNResponse":{"title":"Multiple Residence (UMPRN) Address Response","type":"object","required":["message","code","result"],"properties":{"result":{"$ref":"#/components/schemas/Address"},"code":{"type":"integer","format":"int32","enum":[2000]},"message":{"type":"string","enum":["Success"]}}},"AvailableContexts":{"title":"Available Contexts","type":"array","description":"A list of available contexts for a key","items":{"type":"object","required":["iso_3","
1iso_2","description","emoji","rgeo"],"properties":{"iso_3":{"type":"string","example":"USA","description":"3 letter ISO code"},"iso_2":{"type":"string","example":"US","description":"2 letter ISO code"},"description":{"type":"string","example":"United States","description":"Country descriptor to show in Address Finder\\n"},"emoji":{"type":"string","description":"Emoji text icon","example":"\ud83c\uddfa\ud83c\uddf8"},"rgeo":{"type":"boolean","example":true,"description":"Indicates availability of reverse geolocation search\\n"}}}},"Context":{"title":"Context","type":"string","description":"Limits search results within a geographical boundary or country."},"NoContext":{"title":"No Context Provided","type":"string","enum":[""],"description":"Empty string if no context is provided or key check has failed"},"ApiKey":{"title":"Key","type":"object","required":["available","context","contexts"],"properties":{"contexts":{"$ref":"#/components/schemas/AvailableContexts"},"context":{"description":"Returns current context if it is in the list of available contexts for this key.\\n","oneOf":[{"$ref":"#/components/schemas/Context"},{"$ref":"#/components/schemas/NoContext"}]},"available":{"description":"Determines whether the key can be used by the requesting agent. \\n\\nReturns false if one of the following conditions are met:\\n - Key has no lookups remaining\\n - Daily limit has been reached on the key\\n - Daily individual limit has been reached\\n - Key is not being used via an authorised URL\\n - (Sublicensed key only) Key has a valid licensee attached\\n - (Sublicensed key only) Key is not being used via an authorised URL specified by licensee\\n","type":"boolean","example":true}}},"ApiKeyResponse":{"title":"API Key Response","type":"object","required":["message","code","result"],"properties":{"result":{"$ref":"#/components/schemas/ApiKey"},"message":{"type":"string","enum":["Success"]},"code":{"type":"integer","format":"int32","enum":[2000]}}},"ApiKeyDailyLimit":{"title":"API Key Daily Limit","type":"object","required":["limit","consumed"],"properties":{"limit":{"x-nullable":true,"nullable":true,"minimum":0,"example":1000,"type":"integer","description":"`number` or `null`. The daily lookup limit currently set on your key.\\n`null` means the limit is currently disabled.","format":"int32"},"consumed":{"minimum":0,"example":288,"type":"integer","description":"Number of lookups performed today which count towards your daily limit.","format":"int32"}}},"ApiKeyMonthlyLimit":{"title":"API Key Monthly Limit","type":"object","required":["limit","consumed"],"properties":{"limit":{"x-nullable":true,"nullable":true,"minimum":0,"example":10000,"type":"integer","description":"`number` or `null`. The monthly lookup limit currently set on your key.\\n`null` means the limit is currently disabled.","format":"int32"},"consumed":{"minimum":0,"example":2500,"type":"integer","description":"Number of lookups performed this month which count towards your monthly limit.","format":"int32"}}},"ApiKeyIndividualLimit":{"title":"API Key Individual Limit","type":"object","required":["limit"],"properties":{"limit":{"minimum":0,"example":30,"x-nullable":true,"nullable":true,"type":"integer","description":"`number` or `null` Limit set on the number of lookups that can be\\nperformed from a single IP address. `null` means the limit is currently\\ndisabled.","format":"int32"}}},"ApiKeyNotifications":{"title":"API Key Notifications","type":"object","required":["emails","enabled","balance_threshold","no_balance","limit_reached"],"properties":{"emails":{"type":"array","description":"A list of email addresses designated by you to receive notifications about this key.","items":{"type":"string","example":"[email protected]"}},"enabled":{"description":"Indicates whether email notifications are enabled.","type":"boolean"},"balance_threshold":{"type":"integer","format":"int32","minimum":0,"x-nullable":true,"nullable":true,"description":"Balance threshold that triggers a reminder email. null means disabled.","example":500},"no_balance":{"type":"boolean","description":"Send notice when balance hits zero."},"limit_reached":{"type":"boolean","description":"Send notice when rate limit is reached."}}}
1,"ApiKeyDatasets":{"title":"API Key Dataset Availability","description":"Indicates which datasets are available and added by default to the address responses","type":"object","required":["paf","mr","nyb","pafa","pafw","ab","nip","ecad","ecaf","usps","herewe","hereap","hereee","herehk","herei","herem","heremea","heremeas","herena","hereo","heresa","heret","email","phone","gnaf","kadaster","kartverket","sdfi","cannar","fodbosa","mois","upujp","bev","ban","swt","gbrcleanse","uspscleanse"],"properties":{"paf":{"type":"boolean","description":"UK Main Address File (Postcode Address File)","example":true},"pafa":{"type":"boolean","description":"UK Property Alias dataset","example":false},"pafw":{"type":"boolean","description":"UK Welsh Language Dataset","example":false},"mr":{"type":"boolean","description":"UK Multiple Residence Dataset","example":true},"nyb":{"type":"boolean","description":"UK Not Yet Built Dataset","example":false},"ab":{"type":"boolean","description":"UK AddressBase dataset","example":false},"abp":{"type":"boolean","description":"UK AddressBase Premium dataset","example":false},"nip":{"type":"boolean","description":"Northern Ireland Pointer Dataset","example":false},"usps":{"type":"boolean","description":"US Address Dataset","example":true},"ecad":{"type":"boolean","description":"Republic of Ireland: Eircode Address Database","example":false},"ecaf":{"type":"boolean","description":"Republic of Ireland: Eircode Address File","example":false},"gnaf":{"type":"boolean","description":"Australia: Geocoded National Address File","example":true},"hereap":{"type":"boolean","description":"Asia Pacific Address File","example":true},"herehk":{"type":"boolean","description":"Hong Kong Address File","example":true},"herei":{"type":"boolean","description":"India Address File","example":true},"herem":{"type":"boolean","description":"Macau Address File","example":true},"heremea":{"type":"boolean","description":"Middle East and Africa Address File","example":true},"heremeas":{"type":"boolean","description":"Middle East and Africa Standalone Intermediate Maps Address File","example":true},"herena":{"type":"boolean","description":"North America Address File","example":true},"hereo":{"type":"boolean","description":"Oceania Address File","example":true},"heresa":{"type":"boolean","description":"South America Address File","example":true},"heret":{"type":"boolean","description":"Taiwan Address File","example":true},"hereee":{"type":"boolean","description":"Eastern Europe Address File","example":true},"herewe":{"type":"boolean","description":"Western Europe Address File","example":true},"phone":{"type":"boolean","description":"Phone validation is enabled","example":true},"email":{"type":"boolean","description":"Email validation is enabled","example":true},"kadaster":{"type":"boolean","description":"Netherlands: Kadaster BAG 2.0 Address File"},"kartverket":{"type":"boolean","description":"Norway: Kartverket Address File","example":true},"mois":{"type":"boolean","description":"South Korea: MOIS Address File","example":true},"sdfi":{"type":"boolean","description":"Denmark: Danmarks Adresseregister (DAR)","example":true},"cannar":{"type":"boolean","description":"Canada: Statistics Canada National Address Register","example":true},"fodbosa":{"type":"boolean","description":"Belgium: FOD BOSA Address File","example":true},"upujp":{"type":"boolean","description":"Japan: UPU Address File","example":true},"bev":{"type":"boolean","description":"Austria: BEV Address File","example":true},"ban":{"type":"boolean","description":"France: BAN (Base Adresse Nationale)","example":true},"swt":{"type":"boolean","description":"Switzerland and Liechtenstein: Swisstopo Address File","example":true},"gbrcleanse":{"type":"boolean","description":"UK GBR Cleanse","example":true},"uspscleanse":{"type":"boolean","description":"US CASS Cleanse","example":true}}},"ApiKeyAutomatedTopup":{"title":"API Key Automated Topup","description":"Automated topup status","type":"object","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Indicates whether automated top-ups are enabled","example":true}}},"ApiKeyCurrentPurchase":{"title":"API Key Batch Purchase","type":"object","required":["expires","purchased","consumed"],"properties":{"expires":{"x-nullable":true,"nullable":true,"type":"string","example":"2022-01-06T11:41:27.092Z","description":"`string` or `null` The date when this purchase will expire in simplified\\nextended ISO format (ISO 8601). This is typically 365 days from the time\\nof first use. This field will be `null` if the purchase has not yet been\\nused."},"purchased":{"minimum":0,"type":"integer","description":"Number of procured lookups from this purchase.","example":20000,"format":"int32"},"consumed":{"minimum":0,"type":"integer","description":"Number of consumed lookups off this purchase.","format":"int32","example":121}}},"ApiKeyDetails":{"title":"API Key Details","type":"object","required":["name","contexts","lookups_remaining","daily_limit","monthly_limit","individual_limit","allowed_urls","redact_days","notifications","automated_topups","current_purchases","ip_forwarding","premier_support","datasets"],"properties":{"name":{"type":"string","description":"A name for the key","example":"My API Key"},"contexts":{"$ref":"#/components/schemas/AvailableContexts"},"lookups_remaining":{"minimum":0,"example":19889,"type":"integer","format":"int32"},"daily_limit":{"$ref":"#/components/schemas/ApiKeyDailyLimit"},"monthly_limit":{"$ref":"#/components/schemas/ApiKeyMonthlyLimit"},"individual_limit":{"$ref":"#/components/schemas/ApiKeyIndividualLimit"},"allowed_urls":{"type":"array","items":{"type":"string"},"description":"A list of allowed URLs. An empty list means that allowed URLs are disabled."},"redact_days":{"type":"integer","default":28,"description":"Number of days to preserve personal data stored in your key usage history. Set to 0 to prevent personal data storage"},"notifications":{"$ref":"#/components/schemas/ApiKeyNotifications"},"datasets":{"$ref":"#/components/schemas/ApiKeyDatasets"},"automated_topups":{"$ref":"#/components/schemas/ApiKeyAutomatedTopup"},"current_purchases":{"type":"array","items":{"$ref":"#/components/schemas/ApiKeyCurrentPurchase"},"description":"Current balance purchases attached to key."},"ip_forwarding":{"type":"boolean","default":false,"description":"Accept IP addresses forwarded in the `IDPC-Source-IP` header"},"premier_support":{"type":"boolean","default":false,"description":"Whether the key is enrolled in the premier support programme and monitored closely by our devops team. Read-only; managed by our team."}}},"ApiKeyDetailsResponse":{"title":"API Key Details Response","type":"object","required":["message","code","result"],"properties":{"result":{"$ref":"#/components/schemas/ApiKeyDetails"},"code":{"type":"integer","format":"int32","enum":[2000]},"message":{"type":"string","enum":["Success"]}}},"ApiKeyDetailsEditable":{"title":"API Key Details Update","type":"object","properties":{"name":{"type":"string","maxLength":32,"pattern":"^(\\\\w|\\\\s){0,32}$","description":"A name for the key","example":"My API Key"},"daily_limit":{"title":"Daily Rate Limit","type":"object","properties":{"limit":{"x-nullable":true,"nullable":true,"minimum":0,"example":1000,"type":"integer","description":"`number` or `null`. The daily lookup limit currently set on your key.\\n`null` means the limit is currently disabled.","format":"int32"}}},"monthly_limit":{"title":"Monthly Rate Limit","type":"object","properties":{"limit":{"x-nullable":true,"nullable":true,"minimum":0,"example":10000,"type":"integer","description":"`number` or `null`. The monthly lookup limit currently set on your key.\\n`null` means the limit is currently disabled.","format":"int32"}}},"individual_limit":{"title":"API Key Individual Limit","type":"object","properties":{"limit":{"minimum":0,"example":30,"x-nullable":true,"nullable":true,"type":"integer","description":"`number` or `null` Limit set on the number of lookups that can be\\nperformed from a single IP address. `null` means the limit is currently\\ndisabled.","format":"int32"}}},"allowed_urls":{"type":"array","items":{"type":"string","maxLength":256,"pattern":"^[^\\\\s]+$"},"description":"A list of allowed URLs. An empty list means that allowed URLs are disabled. Up to 10 allowed."},"redact_days":{"type":"integer","default":28,"minimum":0,"maximum":1095,"description":"Number of days to preserve personal data stored in your key usage history. Set to 0 to prevent personal data storage"},"notifications":{"title":"API Key Notifications","type":"object","properties":{"emails":{"type":"array","description":"A list of email addresses designated by you to receive notifications about this key. Up to 5 allowed.","
1items":{"type":"string","pattern":"^\\\\S{1,100}@\\\\S{1,100}$","example":"[email protected]"}},"enabled":{"description":"Indicates whether email notifications are enabled.","type":"boolean"},"balance_threshold":{"type":"integer","format":"int32","minimum":0,"x-nullable":true,"nullable":true,"description":"Balance threshold that triggers a reminder email. null to disable.","example":500},"no_balance":{"type":"boolean","description":"Send notice when balance hits zero."},"limit_reached":{"type":"boolean","description":"Send notice when rate limit is reached."}}},"ip_forwarding":{"type":"boolean","default":false,"description":"Accept IP addresses forwarded in the `IDPC-Source-IP` header"},"datasets":{"title":"API Key Dataset Availability","description":"Indicates which datasets are available and added by default to the address responses","type":"object","properties":{"pafa":{"type":"boolean","description":"UK Property Alias dataset","example":false},"pafw":{"type":"boolean","description":"UK Welsh Language Dataset","example":false},"usps":{"type":"boolean","description":"US Address Dataset","example":true},"hereap":{"type":"boolean","description":"Asia Pacific Address File","example":true},"herehk":{"type":"boolean","description":"Hong Kong Address File","example":true},"herei":{"type":"boolean","description":"India Address File","example":true},"herem":{"type":"boolean","description":"Macau Address File","example":true},"heremea":{"type":"boolean","description":"Middle East and Africa Address File","example":true},"heremeas":{"type":"boolean","description":"Middle East and Africa Extended File","example":true},"herena":{"type":"boolean","description":"North America Address File","example":true},"hereo":{"type":"boolean","description":"Oceania Address File","example":true},"heresa":{"type":"boolean","description":"South America Address File","example":true},"heret":{"type":"boolean","description":"Taiwan Address File","example":true},"hereee":{"type":"boolean","description":"Eastern Europe Address File","example":true},"herewe":{"type":"boolean","description":"Western Europe Address File","example":true},"phone":{"type":"boolean","description":"Phone validation is enabled","example":true},"email":{"type":"boolean","description":"Email validation is enabled","example":true},"gnaf":{"type":"boolean","description":"Australia: Geoscape Geocoded National Address File","example":true},"kadaster":{"type":"boolean","description":"Netherlands: Kadaster BAG 2.0 Address File","example":true},"kartverket":{"type":"boolean","description":"Norway: Kartverket Address File","example":true},"sdfi":{"type":"boolean","description":"Denmark: SDFI Address File","example":true},"cannar":{"type":"boolean","description":"Canada: Statistics Canada National Address Register","example":true},"fodbosa":{"type":"boolean","description":"Belgium: FOD BOSA Address File","example":true},"mois":{"type":"boolean","description":"South Korea: MOIS Address File","example":true},"upujp":{"type":"boolean","description":"Japan: UPU Address File","example":true},"bev":{"type":"boolean","description":"Austria: BEV Address File","example":true},"ban":{"type":"boolean","description":"France: BAN (Base Adresse Nationale)","example":true},"swt":{"type":"boolean","description":"Switzerland and Liechtenstein: Swisstopo Address File","example":true},"ab":{"type":"boolean","description":"UK AddressBase dataset","example":false},"abp":{"type":"boolean","description":"UK AddressBase Premium dataset","example":false},"nip":{"type":"boolean","description":"Northern Ireland Pointer Dataset","example":false},"gbrcleanse":{"type":"boolean","description":"UK GBR Cleanse","example":true},"uspscleanse":{"type":"boolean","description":"US CASS Cleanse","example":true}}}}},"KeyUsageResult":{"title":"Key Usage","type":"object","required":["start","end","total","dailyCount"],"properties":{"start":{"type":"string","description":"Start date in ISO 8601 format.","example":"2015-01-22T15:08:06.609Z"},"end":{"type":"string","description":"End date in ISO 8601 format.","example":"2015-01-23T15:08:06.609Z"},"total":{"type":"integer","description":"Total of paid lookups performed in specified period.","format":"int32","example":132},"dailyCount":{"type":"array","description":"An array of objects representing number of paid lookups made on specific days, ordered by date. Each object c
1ontains a `date` attribute, which represents the day and a `count` attribute, which represents the number of paid lookups made on that day.\\n","items":{"type":"object","required":["date","count"],"properties":{"date":{"type":"string","example":"2015-01-22T00:00:00.000Z"},"count":{"type":"integer","format":"int32","example":132}}}}}},"ApiKeyUsageResponse":{"title":"Key Usage Response","type":"object","required":["message","code","result"],"properties":{"result":{"$ref":"#/components/schemas/KeyUsageResult"},"code":{"type":"integer","format":"int32","enum":[2000]},"message":{"type":"string","enum":["Success"]}}},"GbrCleanseMatch":{"title":"Address Match","type":"object","required":["query","match","count","fit","confidence","organisation_match","premise_match","thoroughfare_match","postcode_match","locality_match","post_town_match"],"properties":{"query":{"type":"string","description":"Originally submitted query"},"match":{"description":"Nearest matching address","allOf":[{"$ref":"#/components/schemas/Address"}]},"count":{"type":"number","description":"The number of addresses we matched to the input. We return the closest match by default.\\n","maximum":10,"minimum":0},"fit":{"type":"number","description":"A score represented as number between 1 and 0. Fit compares the address elements present in your query against the matching address elements. It does not incorporate elements you have not presented in the score. A partial address (e.g. 12 Pye Green Road) will have a fit of 1 even though it is missing post town and postcode. Its confidence score will be less than 1 however because it is missing some crucial elements.\\n","maximum":1,"minimum":0},"confidence":{"type":"number","maximum":1,"minimum":0,"description":"A confidence score represented as number between 1 and 0. 1 indicates a full match. 0 indicates no complete matching elements.\\n"},"organisation_match":{"type":"string","description":"Match indicator for the organisation","enum":["FULL","PARTIAL","INCORRECT","MISSING","NA"]},"premise_match":{"type":"string","description":"Match indicator for the premise","enum":["FULL","PARTIAL","INCORRECT","MISSING","NA"]},"postcode_match":{"type":"string","description":"Match indicator for the postcode","enum":["FULL","PARTIAL","INCORRECT","MISSING","NA"]},"thoroughfare_match":{"type":"string","description":"Match indicator for the street","enum":["FULL","PARTIAL","INCORRECT","MISSING","NA"]},"locality_match":{"type":"string","description":"Match indicator for the locality","enum":["FULL","PARTIAL","INCORRECT","MISSING","NA"]},"post_town_match":{"type":"string","description":"Match indicator for the post_town","enum":["FULL","PARTIAL","INCORRECT","MISSING","NA"]}}},"GbrCleanseNoMatch":{"type":"object","title":"No Address Match","required":["query","match","count","fit","confidence","organisation_match","premise_match","thoroughfare_match","postcode_match","locality_match","post_town_match"],"properties":{"query":{"type":"string","description":"Originally submitted query"},"match":{"description":"Nearest matching address","type":"object","nullable":true,"enum":[null]},"count":{"type":"number","description":"","enum":[0]},"fit":{"type":"number","format":"float","description":"","enum":[0]},"confidence":{"type":"number","format":"float","description":"","enum":[0]},"organisation_match":{"type":"string","description":"","enum":["NO_MATCH"]},"premise_match":{"type":"string","description":"","enum":["NO_MATCH"]},"postcode_match":{"type":"string","description":"","enum":["NO_MATCH"]},"thoroughfare_match":{"type":"string","description":"","enum":["NO_MATCH"]},"locality_match":{"type":"string","description":"","enum":["NO_MATCH"]},"post_town_match":{"type":"string","description":"","enum":["NO_MATCH"]}}},"CleanseResponse":{"title":"Address Cleanse Response","type":"object","required":["message","code","result"],"properties":{"code":{"type":"integer","format":"int32","enum":[2000]},"message":{"type":"string","enum":["Success"]},"result":{"oneOf":[{"$ref":"#/components/schemas/GbrCleanseMatch"},{"$ref":"#/components/schemas/GbrCleanseNoMatch"}]}}},"AddressSuggestion":{"title":"Address Suggestion","description":"Represents an address suggestion for any address in the world","type":"object","required":["id","suggestion","urls"],"example":{"id":"usps_V210079628|10||3797","suggestion":"10 Downing St, Montpelier, VT, 05602","urls":{}},"properties":{"id":{"$ref":"#/components/schemas/ID"},"suggestion":{"type":"string","description":"Address Suggestion to be displayed to the user"},"urls":{"title":"URLs","type":"object","description":"Always an empty object (`{}`). Retrieve the full address with `id`","additionalProperties":false}}},"UkAddressSuggestion":{"title":"UK Address Suggestion","description":"Represents a possible address given an autocomplete query.\\n\\nUK Address Suggestions will return a UDPRN attribute if it references a deliverable endpoint found on Royal Mail\'s Postc
1ode Address File dataset.\\n\\nUK Address Suggestion will return a UMPRN if it references a multiple occupancy premise found on Royal Mail\'s Multiple Residence dataset.\\n","type":"object","example":{"id":"paf_23747771","suggestion":"Prime Minister & First Lord Of The Treasury, 10 Downing Street, London, SW1A","udprn":23747771,"urls":{"udprn":"/v1/udprn/23747771"}},"required":["id","suggestion","udprn","urls"],"properties":{"id":{"$ref":"#/components/schemas/ID"},"suggestion":{"type":"string","description":"Address suggestion for a given query."},"udprn":{"title":"Unique Delivery Point Reference Number (UDPRN)","type":"integer","format":"int32","description":"UDPRN stands for \'Unique Delivery Point Reference Number\'. Royal Mail assigns a unique UDPRN code for each premise on PAF. Simple, unique reference number for each Delivery Point. Unlikely to be reused when an address expires.\\n\\nUp to 8-digit numeric code.\\n\\nA new UDPRN is automatically assigned to each new Delivery Point added to PAF."},"umprn":{"type":"integer","format":"int32","description":"Optionally returned field, representing the UMPRN of a Multiple Residence household"},"urls":{"title":"URLs","type":"object","required":["udprn"],"properties":{"udprn":{"type":"string","description":"URL to retrieve the entire details for a given address suggestion by the UDPRN"},"umprn":{"type":"string","description":"Optionally returned field, to retrieve the entire details for a suggested Multiple Residence household"}}}}},"AutocompleteResponse":{"title":"Address Autocomplete Response","type":"object","required":["message","code","result"],"properties":{"result":{"type":"object","required":["hits"],"properties":{"hits":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/AddressSuggestion"},{"$ref":"#/components/schemas/UkAddressSuggestion"}]}}}},"code":{"type":"integer","format":"int32","enum":[2000]},"message":{"type":"string","enum":["Success"]}}},"GbrResolveAddressResponse":{"title":"Address Resolution Response (GBR)","type":"object","required":["message","code","result"],"properties":{"code":{"type":"integer","format":"int32","enum":[2000]},"message":{"type":"string","enum":["Success"]},"result":{"$ref":"#/components/schemas/Address"}}},"AddressResponse":{"title":"Address Search Response","type":"object","required":["message","code","result"],"properties":{"code":{"type":"integer","format":"int32","enum":[2000]},"message":{"type":"string","enum":["Success"]},"result":{"type":"object","required":["hits","total","limit","page"],"properties":{"hits":{"type":"array","description":"List of matching addresses\\n","items":{"$ref":"#/components/schemas/AddressListItem"}},"total":{"minimum":0,"maximum":10000,"type":"integer","format":"int32"},"limit":{"maximum":100,"minimum":0,"default":10,"example":10,"type":"integer","format":"int32"},"page":{"minimum":0,"default":0,"example":0,"maximum":10,"type":"integer","format":"int32"}}}}},"place_id":{"title":"ID","type":"string","description":"Unique identifier for place\\n","example":"geonames_7296662"},"place_name":{"title":"Place Name","type":"string","description":"Place name\\n","example":"Strumpshaw"},"place_descriptive_name":{"title":"Descriptive Place Name","type":"string","description":"Longer form description of the place.\\n","example":"Strumpshaw, Norfolk, England"},"place_country_iso":{"title":"Country","type":"string","description":" 3 letter country code (ISO 3166-1)\\n","example":"GBR"},"PlaceSuggestion":{"title":"Place Suggestion","description":"Represents a possible place given an autocomplete query.\\n","type":"object","required":["id","name","descriptive_name","country_iso"],"properties":{"id":{"$ref":"#/components/schemas/place_id"},"name":{"$ref":"#/components/schemas/place_name"},"descriptive_name":{"$ref":"#/components/schemas/place_descriptive_name"},"country_iso":{"$ref":"#/components/schemas/place_country_iso"}},"example":{"id":"geonames_7296662","name":"Strumpshaw","descriptive_name":"Strumpshaw, Norfolk, England","country_iso":"GBR"}},"PlaceResponse":{"title":"Place Search Response","type":"object","required":["message","code","result"],"properties":{"code":{"type":"integer","format":"int32","enum":[2000]},"message":{"type":"string","enum":["Success"]},"result":{"type":"object","required":["hits"],"properties":{"hits":{"type":"array","description":"List of up to 10 matching places\\n","items":{"oneOf":[{"$ref":"#/components/schemas/PlaceSuggestion"}]}}}}}},"GeonamesPlace":{"title":"GeoNames Place","description":"The GeoNames record backing a place, as indexed.\\n\\nOnly administrative divisions (feature class `A`) and capital or seat-of-administration cities (feature codes `PPLC` and `PPLA*`) are indexed. Historical features (feature codes ending in `H`) are excluded.","type":"object","required":["id","dataset","geonameid","name","asciiname","alternatenames","language","latitude","longitude","feature_class","feature_code","country_code","country_iso","cc2","admin1_name","admin1_geonameid","admin1_code","admin2_name","admin2_geonameid","admin2_code","admin3_code","admin4_code","population","elevation","dem","timezone","modification_date"],"properties":{"id":{"type":"string","description":"Unique place ID"},"dataset":{"type":"string","description":"Indicates the provenance of a place","enum":["geonames"]},"geonameid":{"type":"integer","format":"int32","description":"Unique identifier for GeoNames place"},"name":{"type":"string","description":"Place name (UTF8)","minLength":0,"maxLength":200},"asciiname":{"type":"string","description":"Place name (ASCII). Empty string if not available","minLength":0,"maxLength":200},"alternatenames":{"type":"array","description":"List of alternate names for the place","items":{"type":"string","description":"Alternate name for place"}},"language":{"$ref":"#/components/schemas/Language"},"latitude":{"$ref":"#/components/schemas/Latitude"},"longitude":{"$ref":"#/components/schemas/Longitude"},"feature_class":{"type":"string","description":"GeoNames single letter feature class (http://www.geonames.org/export/codes.html). Only two are indexed\\n\\n - `A` Country, state, region\\n - `P` City, village","enum":["A","P"]},"feature_code":{"type":"string","description":"Full GeoNames feature code (http://www.geonames.org/export/codes.html)","minLength":0,"maxLength":10},"country_code":{"type":"string","description":"2 letter ISO country code. Empty string if not available","minLength":0,"maxLength":2},"country_iso":{"type":"string","description":"3 letter ISO country code derived from `country_code`. Empty string if the country cannot be resolved","minLength":0,"maxLength":3},"cc2":{"type":"array","description":"List of other country codes mapping to this place","items":{"type":"string","description":"2 letter ISO country code","minLength":2,"maxLength":2}},"admin1_name":{"type":"string","description":"Name of first administrative area. Empty string if not available"},"admin1_geonameid":{"type":"integer","format":"int32","nullable":true,"description":"GeoName ID for first administrative area"},"admin1_code":{"type":"string","description":"Fipscode (subject to change to iso code)","minLength":0,"maxLength":20},"admin2_name":{"type":"string","description":"Name of second administrative area. Empty string if not available"},"admin2_geonameid":{"type":"integer","format":"int32","nullable":true,"description":"GeoName ID for second administrative area"},"admin2_code":{"type":"string","description":"Code for the second administrative division","minLength":0,"maxLength":101}
1,"admin3_code":{"type":"string","description":"Code for third level administrative division","minLength":0,"maxLength":122},"admin4_code":{"type":"string","description":"Code for fourth level administrative division","minLength":0,"maxLength":143},"population":{"type":"string","description":"Population at place. Represented as a string as it can be larger than a 32 bit integer"},"elevation":{"type":"integer","format":"int32","nullable":true,"description":"Elevation in metres. `null` if not available"},"dem":{"type":"integer","format":"int32","nullable":true,"description":"Digital elevation model (srtm3 or gtopo30), average elevation in metres"},"timezone":{"type":"string","description":"The IANA timezone ID. Empty string if not available","minLength":0,"maxLength":40},"modification_date":{"type":"string","format":"date-time","description":"Date the GeoNames record was last modified"}},"example":{"id":"geonames_7296662","dataset":"geonames","geonameid":7296662,"name":"Strumpshaw","asciiname":"Strumpshaw","alternatenames":[],"language":"en","latitude":52.60599,"longitude":1.47572,"feature_class":"A","feature_code":"ADM4","country_code":"GB","country_iso":"GBR","cc2":[],"admin1_name":"England","admin1_geonameid":6269131,"admin1_code":"ENG","admin2_name":"Norfolk","admin2_geonameid":2641455,"admin2_code":"I9","admin3_code":"33UC","admin4_code":"33UC056","population":"0","elevation":null,"dem":25,"timezone":"Europe/London","modification_date":"2010-05-25T00:00:00.000Z"}},"Place":{"title":"Place","description":"A geographical place: an administrative division, capital or seat of administration city drawn from GeoNames. `GET /places` returns a suggestion for each match and `GET /places/{place}` resolves a suggestion id to the full place. `native` holds the underlying GeoNames record.\\n","type":"object","required":["id","dataset","name","descriptive_name","country_iso","language","longitude","latitude","native"],"properties":{"id":{"title":"Place Identifier","type":"string","description":"Global unique internally generated identifier for a place"},"dataset":{"title":"Dataset","type":"string","description":"Indicates the provenance of a place.","enum":["geonames"]},"name":{"$ref":"#/components/schemas/place_name"},"descriptive_name":{"$ref":"#/components/schemas/place_descriptive_name"},"country_iso":{"$ref":"#/components/schemas/place_country_iso"},"language":{"$ref":"#/components/schemas/Language"},"longitude":{"$ref":"#/components/schemas/Longitude"},"latitude":{"$ref":"#/components/schemas/Latitude"},"native":{"description":"Native representation of a place","oneOf":[{"$ref":"#/components/schemas/GeonamesPlace"}]}},"example":{"id":"geonames_7296662","dataset":"geonames","name":"Strumpshaw","descriptive_name":"Strumpshaw, Norfolk, England","country_iso":"GBR","language":"en","longitude":1.47572,"latitude":52.60599,"native":{"id":"geonames_7296662","dataset":"geonames","geonameid":7296662,"name":"Strumpshaw","asciiname":"Strumpshaw","alternatenames":[],"language":"en","latitude":52.60599,"longitude":1.47572,"feature_class":"A","feature_code":"ADM4","country_code":"GB","country_iso":"GBR","cc2":[],"admin1_name":"England","admin1_geonameid":6269131,"admin1_code":"ENG","admin2_name":"Norfolk","admin2_geonameid":2641455,"admin2_code":"I9","admin3_code":"33UC","admin4_code":"33UC056","population":"0","elevation":null,"dem":25,"timezone":"Europe/London","modification_date":"2010-05-25T00:00:00.000Z"}}},"ResolvePlaceResponse":{"title":"Place Resolution Response","type":"object","required":["message","code","result"],"properties":{"code":{"type":"integer","format":"int32","enum":[2000]},"message":{"type":"string","enum":["Success"]},"result":{"$ref":"#/components/schemas/Place"}}},"LicenseeEditable":{"title":"Licensee","description":"Licensee object which can be defined by user","type":"object","properties":{"name":{"type":"string","example":"Qwerty Widgets Limited","description":"Licensee individual or organisation name"},"address":{"example":"12 High Street, Manchester","type":"string","description":"Licensee\'s first, second and third line address as well as post town concatenated by commas"},"postcode":{"example":"ID1 1QD","type":"string","description":"Licensee\'s postcode"},"whitelist":{"type":"array","items":{"type":"string","example":"https://www.example.com"},"description":"A list of allowed URLs. An empty list means that whitelisting is disabled"},"daily":{"type":"object","properties":{"limit":{"example":10000,"x-nullable":true,"nullable":true,"minimum":0,"format":"int32","type":"number","description":"The maximum number of lookups this licensee can perform in a day. `null` indicates the limit is not active"}}
1}}},"Licensee":{"title":"Licensee","allOf":[{"$ref":"#/components/schemas/LicenseeEditable"},{"type":"object","required":["id","key","createdAt","name","address","postcode","whitelist","daily"],"properties":{"id":{"type":"string","example":"56a11209ebe230380bf104c3","description":"An immutable ID provided for every licensee. Primarily used for paginated list requests.\\n"},"key":{"type":"string","example":"sl_ijoiqsxeQgXW2gkiE0X94","description":"Uniquely identifies a licensee for a key. \\n\\nRequired to perform paid lookups for a specific licensee. Typically begins `sk_`.\\n"},"createdAt":{"type":"string","example":"2016-01-21T17:14:49.971Z","description":"Timestamp for when the licensee was created"},"daily":{"required":["count","updatedAt"],"type":"object","properties":{"count":{"example":232,"minimum":0,"type":"number","format":"int32","description":"The number lookups performed by the licensee on the day represented b `licesees.daily.updatedAt`"},"updatedAt":{"type":"string","example":"2016-08-05T16:43:28.865Z","description":"The timestamp when the limit was last used."}}}}}]},"LicenseesResponse":{"title":"Licensee List Response","type":"object","required":["message","code","result"],"properties":{"result":{"description":"List of licensees","type":"object","properties":{"licensees":{"type":"array","items":{"$ref":"#/components/schemas/Licensee"}},"hasMore":{"type":"boolean","description":"Returns true if there are more licensees listed after the maximum number of results as implied by `limit`"}}},"message":{"type":"string","enum":["Success"]},"code":{"type":"integer","format":"int32","enum":[2000]}}},"LicenseeResponse":{"title":"Licensee Response","type":"object","required":["message","code","result"],"properties":{"result":{"$ref":"#/components/schemas/Licensee"},"code":{"type":"integer","format":"int32","enum":[2000]},"message":{"type":"string","enum":["Success"]}}},"Config":{"title":"Config Object","type":"object","required":["updatedAt","createdAt","name","payload"],"properties":{"updatedAt":{"type":"string","example":"2016-01-21T17:14:49.971Z","description":"Timestamp for when the config was created"},"createdAt":{"type":"string","example":"2016-01-21T17:14:49.971Z","description":"Timestamp for when the config was updated"},"name":{"type":"string","example":"woocommerce","description":"A unique name to identify the configuration payload","minLength":1,"maxLength":32},"payload":{"example":"{\\n \\"removeOrganisation\\": false\\n}\\n","type":"string","minLength":0,"maxLength":65536,"description":"A serialised payload of up to `65536` characters"}}},"ConfigsResponse":{"title":"Config List Response","type":"object","required":["message","code","result"],"properties":{"result":{"description":"List of configurations","type":"object","required":["configs"],"properties":{"configs":{"type":"array","items":{"$ref":"#/components/schemas/Config"}}}},"message":{"type":"string","enum":["Success"]},"code":{"type":"integer","format":"int32","enum":[2000]}}},"ConfigNewParam":{"title":"New Config Object","description":"Required configuration object parameters","type":"object","required":["name","payload"],"properties":{"name":{"type":"string","example":"woocommerce","description":"A unique name to identify the configuration payload","minLength":1,"maxLength":32},"payload":{"example":"{\\n \\"removeOrganisation\\": false\\n}\\n","type":"string","minLength":0,"maxLength":65536,"description":"A serialised payload of up to `65536` characters"}}},"ConfigResponse":{"title":"Config Response","type":"object","required":["result","code","message"],"properties":{"result":{"$ref":"#/components/schemas/Config"},"code":{"type":"integer","format":"int32","enum":[2000]},"message":{"type":"string","enum":["Success"]}}},"NotFoundResponse":{"title":"Not Found Response","allOf":[{"$ref":"#/components/schemas/ErrorResponse"},{"type":"object","required":["code","message"],"properties":{"code":{"type":"integer","description":"`404X` type error response code","format":"int32"},"message":{"type":"string","description":"Resource not found error description"}}}]},"ConfigUpdateParam":{"title":"Update Config Object","description":"Config object update parameters","type":"object","properties":{"payload":{"example":"{\\n \\"removeOrganisation\\": false\\n}\\n","type":"string","minLength":0,"maxLength":65536,"description":"A serialised payload of up to `65536` characters"}}},"Email":{"title":"Email Object","type":"object","required":["result","deliverable","role","free","disposable","catchall","suggestions"],"properties":{"result":{"type":"string","enum":["deliverable","not_deliverable"]},"deliverable":{"type":"boolean","description":"Returns `true` if the email can be delivered"}
1,"disposable":{"type":"boolean","description":"Returns `true` if email comes from a disposable email service like temp-mail"},"free":{"type":"boolean","description":"Returns `true` if the email originates from a free service like Outlook or Gmail."},"role":{"type":"boolean","description":"Returns `true` if email address represents an organisational role like `admin`, `support`, `postmaster` etc"},"catchall":{"type":"boolean","description":"Returns `true` if this domain accepts all emails regardless of username"},"suggestions":{"type":"array","items":{"type":"string"},"description":"Returns an array of suggested email addresses if the email address is not deliverable. The suggested emails are not validated.","example":["[email protected]"]}}},"UnknownEmail":{"title":"Unknown Email Object","type":"object","required":["result","deliverable","role","free","disposable","catchall","suggestions"],"properties":{"result":{"type":"string","enum":["unknown"]},"deliverable":{"type":"boolean","x-nullable":true,"nullable":true,"description":"Deliverability is not known","enum":[null]},"disposable":{"type":"boolean","x-nullable":true,"nullable":true,"description":"Disposability is not known","enum":[null]},"free":{"type":"boolean","x-nullable":true,"nullable":true,"description":"Free email provider is not known","enum":[null]},"role":{"type":"boolean","x-nullable":true,"nullable":true,"description":"Role is not known","enum":[null]},"catchall":{"type":"boolean","x-nullable":true,"nullable":true,"description":"Catch-all status is not known","enum":[null]},"suggestions":{"type":"array","items":{"type":"string"},"description":"Suggestions will be empty"}}},"EmailResponse":{"title":"Email Verification Response","type":"object","required":["message","code","result"],"properties":{"code":{"type":"integer","format":"int32","enum":[2000]},"message":{"type":"string","enum":["Success"]},"result":{"oneOf":[{"$ref":"#/components/schemas/Email"},{"$ref":"#/components/schemas/UnknownEmail"}]}}},"Carrier":{"title":"Carrier Object","type":"object","x-nullable":true,"nullable":true,"required":["network_code","name","country","network_type"],"properties":{"network_code":{"title":"Network Code","type":"string","x-nullable":true,"nullable":true,"description":"The [Mobile Country Code](https://en.wikipedia.org/wiki/Mobile_country_code) for the carrier.","example":"234"},"name":{"title":"Name","type":"string","x-nullable":true,"nullable":true,"description":"The full name of the carrier that number is associated with.","example":"BT Group"},"country":{"title":"Country ISO Alpha-2 Code","type":"string","x-nullable":true,"nullable":true,"description":"Country that number is associated with. In ISO 3166-1 alpha-2 format.","example":"GB"},"network_type":{"title":"Network Type","type":"string","x-nullable":true,"nullable":true,"description":"Type of network that number is associated with.","enum":["mobile","landline","landline_premium","landline_tollfree","virtual","unknown","pager","mobile_or_landline","shared_cost","uan","voicemail"]}}},"PhoneNumber":{"title":"Phone Number Object","type":"object","required":["valid","national_format","international_format","iso_country","iso_country_2","country","current_carrier","original_carrier"],"properties":{"valid":{"type":"boolean","enum":[true]},"national_format":{"description":"Phone number formatted to local standard","type":"string","example":"020 7112 8019"},"international_format":{"description":"Phone number formatted to international standard","type":"string","example":"442071128019"},"iso_country":{"description":"Country code in 3 letter ISO format","type":"string","example":"GBR"},"iso_country_2":{"description":"Country code in 2 letter ISO format","type":"string","example":"GB"},"country":{"description":"Full country name","type":"string","example":"United Kingdom"},"current_carrier":{"description":"Representation of current phone carrier information like network code, name, country, network type","$ref":"#/components/schemas/Carrier"},"original_carrier":{"description":"Representation of original phone carrier information like network code, name, country, network type","$ref":"#/components/schemas/Carrier"}}},"InvalidPhoneNumber":{"title":"Invalid Phone Number Object","type":"object","required":["valid","national_format","international_format","iso_country","iso_country_2","country"],"properties":{"valid":{"type":"boolean","enum":[false]},"national_format":{"description":"Phone number formatted to local standard","x-nullable":true,"nullable":true,"type":"string","enum":[null]},"international_format":{"description":"Phone number formatted to international standard","x-nullable":true,"nullable":true,"type":"string","enum":[null]}
1,"iso_country":{"description":"Country code in 3 letter ISO format","x-nullable":true,"nullable":true,"type":"string","enum":[null]},"iso_country_2":{"description":"Country code in 2 letter ISO format","x-nullable":true,"nullable":true,"type":"string","enum":[null]},"country":{"description":"Full country name","x-nullable":true,"nullable":true,"type":"string","enum":[null]},"current_carrier":{"description":"Representation of current phone carrier information like network code, name, country, network type","x-nullable":true,"nullable":true,"type":"string","enum":[null]},"original_carrier":{"description":"Representation of original phone carrier information like network code, name, country, network type","x-nullable":true,"nullable":true,"type":"string","enum":[null]}}},"PhoneNumberResponse":{"title":"Phone Number Verification Response","type":"object","required":["message","code","result"],"properties":{"code":{"type":"integer","format":"int32","enum":[2000]},"message":{"type":"string","enum":["Success"]},"result":{"oneOf":[{"$ref":"#/components/schemas/PhoneNumber"},{"$ref":"#/components/schemas/InvalidPhoneNumber"}]}}}}},"x-tagGroups":[{"name":"Address Search","tags":["Address Search","UK"]},{"name":"Place Search","tags":["Place Search"]},{"name":"Management","tags":["Keys","Licensees","Configs","Emails","Phone Numbers"]},{"name":"Models","tags":["address","address_list_item","suggestion","paf_native","mr_native","nyb_native","pafa_native","pafw_native","ab_address","abp_address","bev_address","swt_address","ecaf_address","ecad_address","gnaf_address","fodbosa_address","cannar_address","sdfi_address","ban_address","upujp_address","mois_address","kadaster_address","kartverket_address","here_address","geonames_place"]}]}')},59256(e,t,n){n.d(t,{C8:()=>i.C8,D0:()=>i.D0,JL:()=>m,QY:()=>l.Q});var s=n(2838),i=n(26114),r=n(52539),a=n(52797),o=n(64228),d=n(65723),l=n(68328);const p=["oneOf","anyOf","allOf"],c=({example:e,enumValues:t,format:n,defaultValue:s})=>{const r=[];return n&&r.push({label:"Format",value:n}),void 0!==s&&r.push({label:"Default",value:String(s)}),null!=e&&""!==e&&r.push({label:"Example",value:String(e)}),r.length||t?.length?(0,d.jsxs)(d.Fragment,{children:[r.length>0&&(0,d.jsx)("div",{className:"atlas-params__meta",children:r.map(e=>(0,d.jsxs)("span",{children:[(0,d.jsx)("span",{children:e.label})," ",(0,d.jsx)("code",{children:e.value})]},e.label))}),t?.length?(0,d.jsx)(i.CP,{values:t}):null]}):null},u=({property:e})=>(0,d.jsx)(s.A,{children:(0,d.jsxs)("section",{className:"atlas-prop atlas-prop--missing",children:[(0,d.jsx)(i.h,{name:e}),(0,d.jsx)("p",{children:"Schema not found."})]})}),m=e=>{const{components:t}=e,{schemas:n}=t,l=t=>{if(t&&"object"==typeof t&&"$ref"in t){return t.$ref.replace(/^#\//,"").split("/").reduce((e,t)=>e?e[t]:void 0,e)}return t},{Response:m,ResponseInline:h,ResponseLinked:g}=(0,r.yS)(l),{RequestSamples:y,ResponseSample:_,RequestBodySample:f}=(0,a.O)(e,l),{model:b}=(0,o.T)(e);return{Property:({property:e,schema:t})=>{if(!t)return(0,d.jsx)(u,{property:e});const n=(e=>{for(const t of p){const n=e[t];if(Array.isArray(n))return{kind:t,schemas:n}}return null})(t);return n?(0,d.jsx)(s.A,{children:(0,d.jsxs)("section",{className:"atlas-prop",children:[(0,d.jsx)(i.h,{name:e,type:n.kind}),(0,d.jsx)(i.VY,{...t}),(0,d.jsx)("ul",{className:"atlas-prop__variants",children:n.schemas.map((e,t)=>{const n=e,s="type"in n&&n.type||"object";return(0,d.jsxs)("li",{children:[(0,d.jsx)("span",{className:"atlas-prop__variant-type",children:Array.isArray(s)?s.join(" | "):s}),n.description&&(0,d.jsx)("p",{className:"atlas-prop__variant-desc",children:n.description})]},t)})})]})}):(0,d.jsx)(s.A,{children:(0,d.jsxs)("section",{className:"atlas-prop",children:[(0,d.jsx)(i.h,{name:e,type:t.type}),(0,d.jsx)(i.VY,{...t}),(0,d.jsx)(i.w3,{example:t.example,enumValues:t.enum,format:t.format,defaultValue:t.default})]})})},Parameters:({path:t,method:n="get",in:s})=>{const r=e.paths?.[t]?.[n],a=(r?.parameters??[]).map(e=>l(e)).filter(e=>e&&e.in===s);return a.length?(0,d.jsx)("dl",{className:"atlas-params",children:a.map(e=>{const t=e.schema||{},n=Array.isArray(t.type)?t.type.join(" | "):t.type||"string";return(0,d.jsxs)("div",{className:"atlas-params__row",children:[(0,d.jsxs)("dt",{className:"atlas-params__ident",children:[(0,d.jsx)("code",{className:"atlas-params__name",children:e.name})," ",(0,d.jsx)("span",{className:"atlas-params__type",children:n})," ",!e.required&&(0,d.jsx)("span",{className:"atlas-params__optional",children:"optional"})]}),(0,d.jsxs)("dd",{className:"atlas-params__body",children:[t.title&&(0,d.jsx)("div",{className:"atlas-params__title",children:t.title}),(0,d.jsx)(i.VY,{description:e.description??t.description}),(0,d.jsx)(c,{example:e.example??t.example,enumValues:t.enum,format:t.format,defaultValue:t.default})]})]},e.name)})}):null},Response:m,ResponseInline:h,ResponseLinked:g,RequestSamples:y,ResponseSample:_,RequestBody:({path:t,method:n="post",maxDepth:s})=>{const i=e.paths?.[t]?.[n],r=i?.requestBody?.content?.["application/json"]?.schema;return r?(0,d.jsx)(m,{property:"body",schema:r,mode:"inline",badges:"both",maxDepth:s}):null},RequestBodySample:f,schemas:n,components:t,model:b,spec:e}}},64228(e,t,n){n.d(t,{T:()=>i});const s=(e,t)=>{if(t&&"object"==typeof t&&"$ref"in t){const n=t.$ref.replace(/^#\//,"").split("/").reduce((e,t)=>
1e?e[t]:void 0,e);return s(e,n)}return t},i=e=>{const t=n=>{const i=s(e,n);if(!i)return i;const{allOf:r,...a}=i,o=Array.isArray(r)?r.map(t):[],d=[...o,a].reduce((e,t)=>({...e,...t}),{}),l=Object.assign({},...o.map(e=>e.properties),a.properties),p=[...o,a].flatMap(e=>e.required??[]);return Object.keys(l).length&&(d.properties=Object.fromEntries(Object.entries(l).map(([t,n])=>[t,s(e,n)]))),p.length&&(d.required=p),d};return{resolve:t,model:n=>t(e.components.schemas[n])}}},68328(e,t,n){n.d(t,{Q:()=>c});var s=n(22155),i=n(26114),r=n(65723);const a=e=>"object"==typeof e&&null!==e,o=([,e])=>void 0!==e,d=e=>"string"==typeof e?`"${e}"`:String(e),l="Jump to the full definition",p=({entries:e,hrefFor:t,nested:n=!1})=>{const i=n?"atlas-json__line atlas-json__line--nested":"atlas-json__line",c=({href:e,children:t})=>e?(0,r.jsx)("a",{className:i,href:e,title:l,children:t}):(0,r.jsx)("div",{className:i,children:t});return(0,r.jsx)(r.Fragment,{children:e.map(([l,u],m)=>{const h=m<e.length-1?",":"",g=n?void 0:t(l);return a(u)?(0,r.jsxs)(s.Fragment,{children:[(0,r.jsxs)(c,{href:g,children:[(0,r.jsx)("span",{className:"atlas-json__key",children:`"${l}"`}),(0,r.jsx)("span",{className:"atlas-json__punct",children:": {"})]}),(0,r.jsx)(p,{entries:Object.entries(u).filter(o),hrefFor:t,nested:!0}),(0,r.jsx)("div",{className:i,children:(0,r.jsx)("span",{className:"atlas-json__punct",children:`}${h}`})})]},l):(0,r.jsxs)(c,{href:g,children:[(0,r.jsx)("span",{className:"atlas-json__key",children:`"${l}"`}),(0,r.jsx)("span",{className:"atlas-json__punct",children:": "}),(0,r.jsx)("span",{className:(y=u,"string"==typeof y?"atlas-json__str":"boolean"==typeof y?"atlas-json__bool":null===y?"atlas-json__null":"atlas-json__num"),children:d(u)}),h&&(0,r.jsx)("span",{className:"atlas-json__punct",children:h})]},l);var y})})},c=({schema:e,idPrefix:t="",linkBase:n="",note:d="Every field is documented below."})=>{const[c,u]=(0,s.useState)("table"),m=e?.example;if(!m)return null;const h=t=>e?.properties?.[t]?.title,g=s=>{const r=e?.properties?.[s];if(r)return`${n}#${t}${r.title?(0,i.yR)(r.title):s}`},y=Object.entries(m).filter(o);return(0,r.jsxs)("div",{className:"atlas-example",children:[(0,r.jsx)("div",{className:"atlas-example__head",children:(0,r.jsxs)("div",{className:"atlas-example__toggle",children:[(0,r.jsx)("button",{type:"button","aria-pressed":"table"===c,onClick:()=>u("table"),children:"Table"}),(0,r.jsx)("button",{type:"button","aria-pressed":"json"===c,onClick:()=>u("json"),children:"JSON"})]})}),(0,r.jsx)("div",{className:"atlas-example__table-wrap",hidden:"table"!==c,children:(0,r.jsxs)("table",{className:"atlas-example__table",children:[(0,r.jsx)("thead",{children:(0,r.jsxs)("tr",{children:[(0,r.jsx)("th",{children:"Field"}),(0,r.jsx)("th",{children:"Example"}),(0,r.jsx)("th",{children:"Type"})]})}),(0,r.jsx)("tbody",{children:y.map(([e,t])=>{const n=g(e),s=(0,r.jsxs)(r.Fragment,{children:[h(e)&&(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)("span",{className:"atlas-example__key-title",children:h(e)})," "]}),(0,r.jsx)("code",{children:e})]});return(0,r.jsxs)("tr",{className:n?"atlas-example__row--link":void 0,title:n?l:void 0,onClick:n?()=>{window.location.hash=n}:void 0,children:[(0,r.jsx)("td",{className:"atlas-example__key",children:n?(0,r.jsx)("a",{href:n,children:s}):s}),(0,r.jsx)("td",{className:"atlas-example__value",children:""===t?(0,r.jsx)("span",{className:"atlas-example__empty",children:i.wg}):"string"==typeof t?(0,r.jsx)("span",{className:"atlas-example__text",children:t}):(0,r.jsx)("code",{children:a(t)?`{ ${Object.keys(t).length} fields }`:String(t)})}),(0,r.jsx)("td",{className:"atlas-example__type",children:(0,r.jsx)("code",{children:a(t)?"object":typeof t})})]},e)})})]})}),(0,r.jsx)("div",{className:"atlas-json",hidden:"json"!==c,children:(0,r.jsxs)("code",{children:[(0,r.jsx)("div",{children:"{"}),(0,r.jsx)(p,{entries:y,hrefFor:g}),(0,r.jsx)("div",{children:"}"})]})}),d&&(0,r.jsx)("p",{className:"atlas-example__note",children:d})]})}},71632(e,t,n){n.d(t,{A:()=>r});n(22155);var s=n(84277),i=n(65723);function r(e){const t=e.line.map(e=>e.content).join("").trimEnd().endsWith("\\")?[...e.classNames??[],"idpc-code-continues"]:e.classNames;return(0,i.jsx)(s.A,{...e,classNames:t})}}
1,76215(e,t,n){n.d(t,{o:()=>a});var s=n(18962),i=n(29981),r=n(65723);const a=({children:e})=>e?(0,r.jsx)(s.oz,{components:{code({className:e,children:t,...n}){const s=/language-(\w+)/.exec(e||"");return s?(0,r.jsx)(i.A,{language:s[1],children:String(t).replace(/\n$/,"")}):(0,r.jsx)("code",{className:e,...n,children:t})},pre:({children:e})=>(0,r.jsx)(r.Fragment,{children:e})},children:e}):null}}]);
Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.