Idescat. 脌rea de desenvolupadors. API. Cerca de poblaci贸

<!DOCTYPE html>     <html lang="ca">  <head> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> <meta charset="utf-8" />  <link rel="alternate" type="application/rss+xml" title="Idescat. API" href="/api/?f=rss" /> <title>Idescat. 脌rea de desenvolupadors. API. Cerca de poblaci贸</title> <link rel="stylesheet" type="text/css" media="all" href="/estils/std.css" /> <link rel="stylesheet" type="text/css" media="all" href="/estils/doc.css" /> <link rel="preload" as="font" crossorigin type="font/woff" href="/estils/fonts/opensans-regular.woff" /> <link rel="preload" as="font" crossorigin type="font/woff" href="/estils/fonts/opensans-semibold.woff" /> <link rel="preload" as="font" crossorigin type="font/woff" href="/estils/fonts/opensans-bold.woff" /> <link rel="preload" as="image" href="/images/gencat.svg" media="(min-width: 741px)" /> <link rel="preload" as="image" href="/images/mgencat.png" media="(max-width: 740px)" /> <link rel="preload" as="image" href="/images/mlupa.png" /> <link rel="search" type="application/opensearchdescription+xml" href="/xml/opensearch-ca.xml" title="Idescat" /> <link rel="shortcut icon" href="/images/favicon.ico" type="image/x-icon" /> <link rel="icon" sizes="192x192" href="/images/favicon192.png" type="image/png" /> <link rel="apple-touch-icon" sizes="180x180" href="/images/favicon180.png" /> <link rel="apple-touch-icon" sizes="152x152" href="/images/favicon152.png" /> <link rel="apple-touch-icon" sizes="120x120" href="/images/favicon120.png" /> <link rel="alternate" type="application/rss+xml" title="Idescat. Novetats" href="/novetats/?m=rss" /> <script src="/commonScripts/idescat.js"></script> <script src="/commonScripts/cat/idescat.js"></script>  <script async src="https://www.googletagmanager.com/gtag/js?id=G-0Z6NJ7PL6K"></script> <script>IDESCAT.analitica({"seccio":"serveis","tema":"-","estad":"-","prod":"-"});</script> </head> <body>  <noscript><iframe title="Google Tag Manager" src="https://www.googletagmanager.com/ns.html?id=GTM-NH8MVLN" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>  <div id="Contingut"> <a class="WAIocult" href="#Titol">Saltar al contingut principal</a> <header class="ca"> <div class="aplec"> <div id="principal"> <div id="logo"><a href="/" title="Institut d’Estadística de Catalunya (Idescat)">idescat</a></div> <div class="idiomes" role="navigation" aria-label="Idioma de la p脿gina"> <ul><li><a href="?lang=es" title="Esta página está traducida total o parcialmente al castellano" hreflang="es">es</a></li><li><a href="?lang=en" title="This page is totally or partially translated into English" hreflang="en">en</a></li></ul> </div> <div id="logogencat"><a href="//web.gencat.cat/ca/inici/" title="Generalitat de Catalunya">gencat</a></div> </div> <div id="org"><a href="/">Institut d’Estadística de Catalunya</a></div> <nav> <ul> <li id="dades"> <h2><a href="/dades/" aria-haspopup="true" aria-expanded="false" aria-controls="ARIAnavdades">Dades</a></h2> <div id="ARIAnavdades" class="tab"> <div class="aplec"> <div class="grup"> <h3>Demografia i societat</h3> <ul> <li><a href="/tema/xifpo">Població</a></li> <li><a href="/tema/cultu">Cultura · Llengua</a></li> <li><a href="/tema/educa">Educació</a></li> <li><a href="/tema/elecc">Eleccions</a></li> <li><a href="/tema/justi">Justícia · Seguretat</a></li> <li><a href="/tema/salut">Salut</a></li> <li><a href="/tema/treba">Treball</a></li> </ul> <h3>Qualitat de vida</h3> <ul> <li><a href="/tema/cvida">Condicions de vida</a></li> <li><a href="/tema/habit">Habitatges i edificis</a></li> <li><a href="/tema/ingre">Ingressos i consum de les llars</a></li> <li><a href="/tema/proso">Protecció social</a></li> </ul> </div> <div class="grup"> <h3>Economia</h3> <ul> <li><a href="/tema/macro">Macromagnituds</a></li> <li><a href="/tema/empre">Empreses · Finances</a></li> <li><a href="/tema/finan">Finances públiques</a></li> <li><a href="/tema/inver">Inversió i comerç exterior</a></li> <li><a href="/tema/preus">Preus</a></li> <li><a href="/tema/recer">Recerca · Tecnologia</a></li> </ul> <h3>Sectors econòmics</h3> <ul> <li><a href="/tema/agrar">Agricultura · Ramaderia · Pesca</a></li> <li><a href="/tema/comer">Comerç · Serveis</a></li> <li><a href="/tema/const">Construcció</a></li> <li><a href="/tema/indus">Indústria · Energia</a></li> <li><a href="/tema/trans">Transport</a></li> <li><a href="/tema/turis">Turisme</a></li> </ul> <h3>Medi ambient · Territori</h3> <ul> <li><a href="/tema/media">Medi ambient</a></li> <li><a href="/tema/terri">Territori</a></li> </ul> </div> <div class="grup"> <h3>Temes transversals</h3> <ul> <li><a href="/estad/iig">Índex d'igualtat de gènere</a></li> <li><a href="/dades/ods/">Objectius de desenvolupament sostenible</a></li> </ul> <h3>Per àmbit geogràfic</h3> <ul> <li><a href="/estad/?geo=prov">Províncies</a></li> <li><a href="/estad/?geo=at">Àmbits del Pla territorial</a></li> <li><a href="/estad/?geo=mt">Marques tur铆stiques</a></li> <li><a href="/estad/?geo=com">Comarques i Aran</a></li> <li><a href="/estad/?geo=mun">Municipis</a></li> <li><a href="/estad/?geo=ac">Agrupacions censals</a></li> <li><a href="/estad/?geo=ep">Entitats de poblaci贸</a></li> <li><a href="/estad/?geo=dis">Districtes</a></li> <li><a href="/estad/?geo=sec">Seccions censals</a></li> </ul> <h3>Dades b脿siques</h3> <ul> <li><a href="/indicadors/?id=basics">Indicadors bàsics de Catalunya</a></li> <li><a href="/indicadors/?id=ue">Indicadors de la Unió Europea</a></li> <li><a href="/pub/?id=inddt">Indicadors demogràfics i de territori</a></li> <li><a href="/indicadors/?id=aec">Anuari estadístic de Catalunya</a></li> <li><a href="/emex/">El municipi en xifres</a></li> </ul> </div> <div class="peu"><a href="/estad/">Estadístiques A–Z</a> <strong>•</strong> <a href="/cal/">Calendari</a> <strong>•</strong> <a href="/novetats/">Novetats</a> <strong>•</strong> <a href="/dades/encurs/">Enquestes en curs</a> <strong>•</strong> <a href="/dades/obertes/">Dades obertes</a> <strong>•</strong> <a href="/rectificacions/">Rectificacions</a> <strong>•</strong> <a href="/dades/infografies/">Infografies</a></div> </div> </div> </li> <li id="serveis" class="active"> <h2><a href="/serveis/" aria-haspopup="true" aria-expanded="false" aria-controls="ARIAnavserveis">Serveis</a></h2> <div id="ARIAnavserveis" class="tab"> <div class="aplec"> <div class="grup"> <h3>Informació estadística</h3> <ul> <li><a href="/serveis/consultes/">Consultes</a></li> <li><a href="/serveis/certificats/">Certificats</a></li> <li><a href="/serveis/cendoc/">Centre de Documentaci贸</a></li> <li><a href="/serveis/biblioteca/publicacions/">Publicacions de l'Idescat</a></li> <li><a href="/serveis/suggeriments/">Suggeriments</a></li> <li class="abanda"><a href="/serveis/carta/">Carta de serveis</a></li> </ul> </div> <div class="grup"> <h3>Per als mitjans de comunicació</h3> <ul> <li><a href="/serveis/premsa/">Notes de premsa i consultes</a></li> </ul> <h3>Per al sector educatiu</h3> <ul> <li><a href="/serveis/educacio/visites/">Visites a l'Idescat</a></li> <li><a href="/serveis/educacio/sessions/">Sessions monogr脿fiques</a></li> <li><a href="/serveis/educacio/concursos/">Concursos</a></li> </ul> <h3>Per a investigadors</h3> <ul> <li><a href="/serveis/dades/">Dades confidencials</a></li> </ul> <h3>Per a desenvolupadors</h3> <ul> <li><a href="/dev/api/">API</a></li> <li><a href="/dev/visual/">Visual</a></li> </ul> </div> <div class="grup"> <h3>Per al Sistema estadístic de Catalunya</h3> <ul> <li><a href="/formacio/">Formació i activitats</a></li> </ul> <h3>Generals</h3> <ul> <li><a href="/serveis/lloguer/">Lloguer d'espais</a></li> <li><a href="/pagaments/">Pagaments</a></li> </ul> </div> </div> </div> </li> <li id="metodes"> <h2><a href="/metodes/" aria-haspopup="true" aria-expanded="false" aria-controls="ARIAnavmetodes">Mètodes</a></h2> <div id="ARIAnavmetodes" class="tab"> <div class="aplec"> <div class="grup"> <h3>Classificacions i codis</h3> <ul> <li><a href="/metodes/classificacions/">Classificacions estadístiques</a></li> <li><a href="/codis/">Codis territorials i d'entitats</a></li> </ul> </div> <div class="grup"> <h3>Instruments de qualitat</h3> <ul> <li><a href="/cal/">Calendari de difusió de resultats</a></li> <li><a href="/metodes/difusio/">Pol铆tica de difusi贸 de resultats</a></li> <li><a href="/dades/encurs/">Enquestes en curs</a></li> <li><a href="/rectificacions/">Rectificacions</a></li> <li><a href="/metodes/bonespractiques/">Codi de bones pràctiques</a></li> <li><a href="/metodes/siie/">SIIE: Plataforma Cerdà i Qualitas</a></li> <li><a href="/serveis/carta/">Carta de serveis</a></li> </ul> </div> <div class="grup"> <h3>Recerca i innovació</h3> <ul> <li><a href="/sort/">Journal SORT</a></li> <li><a href="/metodes/manifestdades/">Manifest de les dades</a></li> </ul> </div> </div> </div> </li> <li id="institut"> <h2><a href="/institut/" aria-haspopup="true" aria-expanded="false" aria-controls="ARIAnavinstitut">L'Institut</a></h2> <div id="ARIAnavinstitut" class="tab"> <div class="aplec"> <div class="grup"> <h3>L'Institut d'Estadística de Catalunya (Idescat)</h3> <ul> <li><a href="/institut/idescat/">Presentació</a></li> <li><a href="/institut/idescat/organitzacio/">Organització</a></li> <li><a href="/institut/idescat/memoria/">Memòria anual</a></li> <li><a href="/institut/idescat/convenis/">Convenis</a></li> <li><a href="/institut/web/privadesa/">Protecci贸 de dades</a></li> <li><a href="/institut/idescat/transparencia/">Transparència</a></li> <li><a href="/institut/idescat/contractacio/">Perfil del contractant</a></li> <li><a href="/institut/idescat/ofertes/">Ofertes de treball</a></li> <li class="abanda"><a href="/institut/idescat/contacte/">Contacte</a></li> </ul> </div> <div class="grup"> <h3>El Sistema estadístic de Catalunya (SEC)</h3> <ul> <li><a href="/institut/sec/">Presentació</a></li> <li><a href="/institut/sec/crsec/">Consell Rector</a></li> <li><a href="/institut/sec/legislacio/">Legislació</a></li> <li><a href="/pec/">Pla estadístic de Catalunya</a></li> <li><a href="/institut/sec/ciutadans/">Els ciutadans i l'estadística oficial</a></li> <li><a href="/institut/sec/rfe/">Registre de fitxers estadístics</a></li> <li><a href="/institut/sec/extranet/">Extranet del SEC</a></li> </ul> </div> </div> </div> </li> <li id="cercador"> <form method="get" action="/cercador/" accept-charset="UTF-8" role="search"> <label class="WAIocult" for="inputSearch">Cercar</label><input aria-label="Cercar" id="inputSearch" value="" name="q" accesskey="T" type="search" spellcheck="false" /> </form> </li> </ul> </nav> </div> </header> <main> <div id="Titular"><div class="aplec"> <ul id="BarraSituacio"><li><a href="/dev/">脌rea de desenvolupadors</a></li><li><a href="/dev/api/">API</a></li></ul> <h1 id="Titol">Cerca de poblaci贸. <abbr title="Interf铆cie de programaci贸 d'aplicacions">API</abbr> <a href="/api/?f=rss"><img src="/images/rss.png" alt="RSS" title="RSS: API" class="rss" /></a></h1> </div></div> <div class="aplec"><aside class="Promo"> <a class="Boto" id="cdu" href="/dev/api/#cdu">Condicions d'煤s</a> </aside> <div class="Doc"> <div class="Apart Intro"> <div class="ApartCont"> <p>L'<abbr title="Interf铆cie de programaci贸 d'aplicacions">API</abbr> de <a href="/poblacio/">Cerca de poblaci贸</a> proporciona informaci贸 de la poblaci贸 per sexe de qualsevol entitat territorial de Catalunya.</p> <p>La utilitzaci贸 d'aquest servei comporta l'acceptaci贸 de les <a href="/dev/api/#cdu">condicions d'煤s de les APIs de l'Idescat</a>.</p> </div> </div> <div class="ApartD TaulaD"> <table class="ApartD"> <caption>Resum</caption> <tbody class="fil"> <tr> <th scope="row"><abbr title="Identificador uniforme de recurs">URI</abbr> base</th> <td>https://api.idescat.cat/pob/v1/{operaci贸}.{format}[?par脿metres]</td> </tr> <tr> <th scope="row">M猫tode HTTP</th> <td>GET</td> </tr> <tr> <th scope="row">Formats de la resposta</th> <td>xml, json, php, txt</td> </tr> <tr> <th scope="row">Versi贸</th> <td>1.00 (20/05/2010)</td> </tr> <tr> <th scope="row">Dreceres</th> <td><a href="#a1">Petici贸</a>, <a href="#a2">Resposta</a></td> </tr> <tr> <th scope="row">Operacions</th> <td>cerca, sug</td> </tr> </tbody> </table> </div> <div class="Index multinivell"> <div class="Apart"> <div class="ApartContAmbVincles"> <ul> <li><a href="#a1">1. Petici贸</a> <ul> <li><a href="#a1.1">1.1. Anatomia de les peticions</a> <ul> <li><a href="#a1.1.1">1.1.1. Identificador del servei i versi贸</a></li> <li><a href="#a1.1.2">1.1.2. Operacions</a></li> </ul> </li> <li><a href="#a1.2">1.2. Par脿metres espec铆fics</a> <ul> <li><a href="#a1.2.1">1.2.1. Par脿metres espec铆fics comuns a totes les operacions</a> <ul> <li><a href="#a1.2.1.1">1.2.1.1. Filtre <var>q</var></a></li> <li><a href="#a1.2.1.2">1.2.1.2. Filtre <var>tipus</var></a></li> </ul> </li> <li><a href="#a1.2.2">1.2.2. Par脿metres espec铆fics de l'operaci贸 <kbd>cerca</kbd></a> <ul> <li><a href="#a1.2.2.1">1.2.2.1. Filtre <var>sim</var></a></li> <li><a href="#a1.2.2.2">1.2.2.2. Filtre <var>selec</var></a></li> <li><a href="#a1.2.2.3">1.2.2.3. Par脿metre <var>orderby</var></a></li> <li><a href="#a1.2.2.4">1.2.2.4 Par脿metre <var>posicio</var></a></li> </ul> </li> </ul> </li> <li><a href="#a1.3">1.3. Invocaci贸 sense operaci贸</a></li> </ul> </li> <li><a href="#a2">2. Resposta</a> <ul> <li><a href="#a2.1">2.1. Operaci贸 <kbd>cerca</kbd></a> <ul> <li><a href="#a2.1.1">2.1.1. Elements de l'est脿ndard OpenSearch</a> <ul> <li><a href="#a2.1.1.1">2.1.1.1. <var>subtitle</var></a></li> <li><a href="#a2.1.1.2">2.1.1.2. <var>category</var></a></li> <li><a href="#a2.1.1.3">2.1.1.3. <var>content</var></a></li> <li><a href="#a2.1.1.4">2.1.1.4. <var>link</var></a></li> </ul> </li> <li><a href="#a2.1.2">2.1.2. Elements basats en l'est脿ndard SDMX</a></li> </ul> </li> <li><a href="#a2.2">2.2. Operaci贸 <kbd>sug</kbd></a></li> <li><a href="#a2.3">2.3. Errors</a></li> </ul> </li> </ul> </div> </div> </div> <div class="Apart"> <h2 id="a1">1. Petici贸</h2> <div class="ApartCont"> <h3 id="a1.1">1.1. Anatomia de les peticions</h3> <p>Tota petici贸 ha d'especificar obligat貌riament el servei, la versi贸, l'operaci贸 i el format. Versi贸 i operaci贸 s贸n caracter铆stiques espec铆fiques de cada servei. A m茅s dels formats de resposta generals de les APIs de l'Idescat, per conveni猫ncia el servei de Cerca de poblaci贸 suporta el format text en l'operaci贸 <kbd>sug</kbd>. Per a m茅s informaci贸, consulteu l'apartat Anatomia de les peticions a la <a href="/dev/api/#a1.1">documentaci贸 general de les APIs de l'Idescat</a>.</p> <h4 id="a1.1.1">1.1.1. Identificador del servei i versi贸</h4> <p>L'identificador d'aquest servei 茅s <kbd>pob</kbd>.</p> <pre class="uri">https://api.idescat.cat/<kbd>pob</kbd><wbr />/<kbd>v1</kbd><wbr />/{…}</pre> <h4 id="a1.1.2">1.1.2. Operacions</h4> <p>Admet dos tipus d'operacions:</p> <ul> <li> <kbd>cerca</kbd>: Retorna resultats d'una cerca per nom d'entitat territorial amb informaci贸 sobre la seva poblaci贸. Vegeu l'apartat <a href="/dev/api/pob/#a1.2">1.2.</a>. <pre class="uri">https://api.idescat.cat/pob<wbr />/v1<wbr />/<kbd>cerca</kbd>.{…}</pre> </li> <li> <kbd>sug</kbd>: Retorna la llista d'entitats territorials que comencen pels car脿cters especificats. Vegeu l'apartat <a href="/dev/api/pob/#a1.2">1.2.</a>. <pre class="uri">https://api.idescat.cat/pob<wbr />/v1<wbr />/<kbd>sug</kbd>.{…}</pre> </li> </ul> <h3 id="a1.2">1.2. Par脿metres espec铆fics</h3> <p>Els par脿metres espec铆fics ("variables") permeten escollir la informaci贸 que retornar脿 una determinada operaci贸 del servei. Es poden especificar com a par脿metres individuals o en un 煤nic par脿metre <var>p</var> (<a href="/dev/api/#a1.3.1">forma compacta</a>). En aquesta documentaci贸, s'utilitza sempre la forma compacta.</p> <p>Per con猫ixer els par脿metres generals disponibles per a qualsevol servei, consulteu la <a href="/dev/api/#1.2">documentaci贸 de les APIs de l'Idescat</a>.</p> <h4 id="a1.2.1">1.2.1. Par脿metres espec铆fics comuns a totes les operacions</h4> <h5 id="a1.2.1.1">1.2.1.1. Filtre <var>q</var></h5> <p>Tant l'operaci贸 <kbd>cerca</kbd> com l'operaci贸 <kbd>sug</kbd> permeten seleccionar les entitats territorials que s'inclouran a la resposta segons la seva denominaci贸 utilitzant el par脿metre <var>q</var>. El significat d'aquest par脿metre varia segons l'operaci贸.</p> <ul> <li>Operaci贸 <kbd>cerca</kbd>: Selecciona entitats territorials que continguin la cadena de car脿cters especificada. 脡s un par脿metre opcional.</li> <li>Operaci贸 <kbd>sug</kbd>: Selecciona entitats territorials que comencin amb la cadena de car脿cters especificada. 脡s un par脿metre opcional, per貌 si no s'especifica o el seu valor t茅 menys de dos car脿cters, no es retornar脿 cap resultat.</li> </ul> <h6 id="e1" class="Exemple"><a href="#e1">Ex. 1</a>: Llista d'entitats territorials que comencen amb "ab", separades per salts de l铆nia</h6> <pre class="uri">https://api.idescat.cat/pob<wbr />/v1<wbr />/sug.txt<wbr />?<var>p</var>=<kbd>q/ab</kbd></pre> <h5 id="a1.2.1.2">1.2.1.2. Filtre <var>tipus</var></h5> <p>Tant l'operaci贸 <kbd>cerca</kbd> com l'operaci贸 <kbd>sug</kbd> permeten seleccionar les entitats territorials que s'inclouran a la resposta d'acord amb la tipologia seg眉ent:</p> <ul> <li><kbd>cat</kbd>: Catalunya</li> <li><kbd>prov</kbd>: Prov铆ncies</li> <li><kbd>atp</kbd>: 脌mbit territorial de planificaci贸 del Pla territorial general de Catalunya</li> <li><kbd>com</kbd>: Comarques</li> <li><kbd>mun</kbd>: Municipis</li> <li><kbd>ec</kbd>: Entitats col路lectives</li> <li><kbd>es</kbd>: Entitats singulars</li> <li><kbd>np</kbd>: Nuclis de poblaci贸</li> <li><kbd>dis</kbd>: Disseminats (aquest valor pot no donar cap resultat perqu猫, almenys en el moment de redactar aquesta documentaci贸, no hi havia a Catalunya cap entitat disseminada que tingu茅s un nom espec铆fic)</li> </ul> <p>Aquests valors es poden concatenar separats per comes. Per defecte, <var>tipus</var> 茅s igual a <kbd>cat,prov,atp,com,mun,ec,es,np,dis</kbd>.</p> <h6 id="e2" class="Exemple"><a href="#e2">Ex. 2</a>: Llista de municipis i nuclis de poblaci贸 que comencen amb "ab", en format text</h6> <pre class="uri">https://api.idescat.cat/pob<wbr />/v1<wbr />/sug.txt<wbr />?<var>p</var>=<kbd>q/ab<wbr />;tipus/mun,np</kbd></pre> <h6 id="e3" class="Exemple"><a href="#e3">Ex. 3</a>: Poblaci贸 de totes les comarques de Catalunya, en format XML</h6> <pre class="uri">https://api.idescat.cat/pob<wbr />/v1<wbr />/cerca.xml<wbr />?<var>p</var>=<kbd>tipus/com</kbd></pre> <h4 id="a1.2.2">1.2.2. Par脿metres espec铆fics de l'operaci贸 <kbd>cerca</kbd></h4> <h5 id="a1.2.2.1">1.2.2.1. Filtre <var>sim</var></h5> <p>Els resultats de l'operaci贸 <kbd>cerca</kbd> tenen associada una categoria de similitud amb la cadena <var>q</var> buscada. El par脿metre <var>sim</var> permet filtrar els resultats segons aquesta similitud:</p> <ul> <li><kbd>0</kbd>: Nom茅s es retornen les entitats territorials la denominaci贸 de les quals coincideix amb l'especificada a <var>q</var> (ignorant maj煤scules i min煤scules i accents). Cal tenir en compte que la denominaci贸 utilitzada aplica la normativa oficial de la llengua catalana segons la qual els articles que acompanyen top貌nims en una llista s'escriuen a la dreta del top貌nim en min煤scula i despr茅s d'una coma, per tal de respectar l'ordenaci贸 alfab猫tica. Aquesta norma 茅s v脿lida per a qualsevol tipus d'article normatiu, sigui normal, amb ap貌strof o salat (per exemple, 芦Agar贸, s'禄).</li> <li><kbd>1</kbd>: Nom茅s es retornen les entitats territorials que contenen la cadena <var>q</var> especificada com a paraula (o expressi贸) i no estan incloses a l'apartat anterior.</li> <li><kbd>2</kbd>: Nom茅s es retornen les entitats territorials que contenen la cadena <var>q</var> especificada com a fragment i no estan incloses als apartats anteriors.</li> </ul> <p>Aquests valors es poden concatenar separats per comes. Per defecte, <var>sim</var> 茅s igual a <kbd>0,1,2</kbd>.</p> <h6 id="e4" class="Exemple"><a href="#e4">Ex. 4</a>: Poblaci贸 de les entitats territorials que es diuen "abrera" o contenen aquest nom, en format JSON</h6> <pre class="uri">https://api.idescat.cat/pob<wbr />/v1<wbr />/cerca.json<wbr />?<var>p</var>=<kbd>q/abrera<wbr />;sim/0,1</kbd></pre> <h5 id="a1.2.2.2">1.2.2.2. Filtre <var>selec</var></h5> <p>En la majoria de casos, l'API 茅s capa莽 de suggerir un resultat destacat fins i tot quan hi ha m茅s d'una entitat territorial en la categoria de similitud 0 (vegeu l'apartat <a href="#a1.2.2.1">1.2.2.1. Filtre <var>sim</var></a>). Per fer-ho, t茅 en compte la tipologia d'entitats territorials (vegeu l'apartat <a href="#a1.2.1.2">1.2.1.2. Filtre <var>tipus</var></a>), prioritzant-les en aquest ordre:</p> <ul> <li>Municipis</li> <li>Prov铆ncies</li> <li>Entitats col路lectives</li> <li>Entitats singulars</li> <li>Nuclis de poblaci贸</li> <li>Disseminats</li> </ul> <p>El par脿metre <var>selec</var> permet simplificar la resposta perqu猫 contingui nom茅s un resultat (o cap).</p> <ul> <li><kbd>1</kbd>: La resposta nom茅s inclou el resultat destacat (si n'hi ha).</li> <li><kbd class="defecte">0</kbd>: La resposta inclou tots els resultats. 脡s el valor per defecte.</li> </ul> <h6 id="e5" class="Exemple"><a href="#e5">Ex. 5</a>: Resultat destacat per a la cerca "abrera", en angl猫s i en format JSON amb funci贸 de devoluci贸 ("f")</h6> <pre class="uri">https://api.idescat.cat/pob<wbr />/v1<wbr />/<kbd>cerca</kbd>.<kbd>json</kbd><wbr />?<var>p</var>=<kbd>q/abrera<wbr />;selec/1</kbd><wbr />&<var>callback</var>=<kbd>f</kbd><wbr />&<var>lang</var>=<kbd>en</kbd></pre> <h5 id="a1.2.2.3">1.2.2.3. Par脿metre <var>orderby</var></h5> <p>Els resultats es mostren ordenats per proximitat amb la cerca efectuada: nom de l'entitat igual al text cercat, nom amb la paraula o expressi贸 sencera cercada i nom que cont茅 el text cercat com a fragment no sencer. El par脿metre <var>orderby</var> permet determinar l'ordenaci贸 dels resultats dins d'aquesta ordenaci贸 general. Admet els valors seg眉ents:</p> <ul> <li><kbd class="defecte">tipus</kbd>: L'ordenaci贸 dels resultats prioritza el tipus d'entitat. 脡s el valor per defecte.</li> <li><kbd>nom</kbd>: Els resultats s'ordenen alfab猫ticament segons el nom de l'entitat territorial.</li> </ul> <h5 id="a1.2.2.4">1.2.2.4. Par脿metre <var>posicio</var></h5> <p>Com algunes cerques poden retornar un nombre molt elevat de resultats, la resposta no sempre els inclour脿 tots. El par脿metre <var>posicio</var> permet determinar quin 茅s el primer resultat incl貌s a la resposta. Per defecte, <var>posicio</var> 茅s igual a zero (es retornen resultats comen莽ant pel primer).</p> <h3 id="a1.3">1.3. Invocaci贸 sense operaci贸</h3> <p>Per raons d'amigabilitat, aquesta API admet peticions amb una sintaxi que no requereix especificar operacions (vegeu, a la documentaci贸 general de les APIs de l'Idescat, l'apartat <a href="/dev/api/?#a1.4">1.4. Invocaci贸 sense operaci贸</a>).</p> <ul> <li>Llista d'entitats territorials que comencen amb "ab" en format text <pre class="uri">https://api.idescat.cat/pob<wbr />/v1<wbr />/geo.txt<wbr />?sug=ab</pre> </li> <li>Poblaci贸 de totes les comarques de Catalunya en format XML <pre class="uri">https://api.idescat.cat/pob<wbr />/v1<wbr />/geo.xml<wbr />?tipus=com</pre> </li> <li>Poblaci贸 de totes les entitats territorials de Catalunya que contenen "ab" en format JSON <pre class="uri">https://api.idescat.cat/pob<wbr />/v1<wbr />/geo.json<wbr />?q=ab</pre> </li> </ul> </div> </div> <div class="Apart"> <h2 id="a2">2. Resposta</h2> <div class="ApartCont"> <p>Per con猫ixer els <strong class="important">codis de resposta</strong> <abbr title="HyperText Transfer Protocol">HTTP</abbr> retornats i els <strong class="important">formats suportats</strong> per qualsevol servei, consulteu l'<a href="/dev/api/#a2">apartat 2 de les APIs de l'Idescat</a>. A m茅s d'aquests formats generals, l'operaci贸 <kbd>sug</kbd> tamb茅 suporta el format text (".txt").</p> <h3 id="a2.1">2.1. Operaci贸 <kbd>cerca</kbd></h3> <p>L'operaci贸 <kbd>cerca</kbd> utilitza, per descriure els resultats, l'est脿ndard <a href="http://www.atomenabled.org/developers/syndication/" class="extern" target="_blank" rel="noopener" title="Vincle extern: s'obrir脿 una nova finestra">Atom</a> enriquit amb elements de l'est脿ndard <a href="http://www.opensearch.org/Specifications/OpenSearch/1.1#OpenSearch_response_elements" class="extern" target="_blank" rel="noopener" title="Vincle extern: s'obrir脿 una nova finestra">OpenSearch</a> i elements basats en l'est脿ndard estad铆stic <a href="http://sdmx.org/" class="extern" target="_blank" rel="noopener" title="Vincle extern: s'obrir脿 una nova finestra">SDMX</a>.</p> <h4 id="a2.1.1">2.1.1. Elements de l'est脿ndard OpenSearch</h4> <p>L'est脿ndard <a href="http://www.opensearch.org/Specifications/OpenSearch/1.1#OpenSearch_response_elements" class="extern" target="_blank" rel="noopener" title="Vincle extern: s'obrir脿 una nova finestra">OpenSearch</a> permet enriquir l'est脿ndard <a href="http://www.atomenabled.org/developers/syndication/" class="extern" target="_blank" rel="noopener" title="Vincle extern: s'obrir脿 una nova finestra">Atom</a> per descriure adequadament el resultat d'una cerca. Consulteu la documentaci贸 d'aquests est脿ndards per con猫ixer l'estructura de la resposta de l'operaci贸 <kbd>cerca</kbd>: aqu铆 nom茅s es documenten alguns elements que tenen un 煤s especial.</p> <h5 id="a2.1.1.1">2.1.1.1. <var>subtitle</var></h5> <p>L'operaci贸 <kbd>cerca</kbd> utilitza l'element opcional <var>subtitle</var> (fill de l'element <var>feed</var>) amb un text referit al resultat destacat, si n'hi ha (vegeu l'apartat <a href="#a1.2.2.2">1.2.2.2. Filtre <var>selec</var></a>).</p> <h6 id="e6" class="Exemple"><a href="#e6">Ex. 6</a>: Element <var>subtitle</var></h6> <pre class="codi"><<var>subtitle</var> xml:lang="ca"> Resultat destacat: Sant Adri脿, entitat singular (Tremp) amb 4 habitants (01.01.2008) </<var>subtitle</var>></pre> <h5 id="a2.1.1.2">2.1.1.2. <var>category</var></h5> <p>L'operaci贸 <kbd>cerca</kbd> classifica els diferents resultats (<var>entry</var>) amb l'element <var>category</var>. Al servei de Cerca de poblaci贸, aquest element pot tenir els valors de l'atribut <kbd>term</kbd> seg眉ents:</p> <p><strong class="important">Tipus d'entitat territorial</strong>:</p> <ul> <li><kbd>CAT</kbd>: Catalunya</li> <li><kbd>PROV</kbd>: Prov铆ncia</li> <li><kbd>ATP</kbd>: 脌mbit territorial de planificaci贸 del Pla territorial general de Catalunya</li> <li><kbd>COM</kbd>: Comarca</li> <li><kbd>MUN</kbd>: Municipi</li> <li><kbd>EC</kbd>: Entitat col路lectiva de poblaci贸</li> <li><kbd>ES</kbd>: Entitat singular de poblaci贸</li> <li><kbd>NP</kbd>: Nucli de poblaci贸</li> <li><kbd>DIS</kbd>: Disseminat de poblaci贸</li> </ul> <p><strong class="important">Proximitat de la denominaci贸 de l'entitat amb el text cercat</strong>:</p> <ul> <li><kbd>sim0</kbd></li> <li><kbd>sim1</kbd></li> <li><kbd>sim2</kbd></li> </ul> <p>Consulteu l'apartat <a href="#a1.2.2.1">1.2.2.1. Filtre <var>sim</var></a> per a una explicaci贸 d'aquests tres valors possibles.</p> <p><strong class="important">Resultat destacat</strong>:</p> <ul> <li><kbd>selec</kbd>: Indica que aquella 茅s l'entitat territorial destacada. Pot apar猫ixer una vegada o cap.</li> </ul> <h6 id="e7" class="Exemple"><a href="#e7">Ex. 7</a>: Element <var>category</var></h6> <pre class="codi"><<var>category</var> <kbd>term</kbd>="sim1"/> <<var>category</var> <kbd>term</kbd>="MUN"/> </pre> <h5 id="a2.1.1.3">2.1.1.3. <var>content</var></h5> <p>L'element <var>content</var> de cada <var>entry</var> s'utilitza per incorporar a cada resultat de la cerca un text en l'idioma escollit, amb el tipus i el nombre d'habitants de l'entitat.</p> <h6 id="e8" class="Exemple"><a href="#e8">Ex. 8</a>: Element <var>content</var></h6> <pre class="codi"><<var>content</var> xml:lang="ca">Municipi: 33.761 hab.</<var>content</var>></pre> <h5 id="a2.1.1.4">2.1.1.4. <var>link</var></h5> <p>Alguns resultats (<var>entry</var>) poden incorporar un enlla莽 per ampliar la informaci贸 de l'entitat territorial. Amb aquesta finalitat, s'utilitza l'element <var>link</var>.</p> <h6 id="e9" class="Exemple"><a href="#e9">Ex. 9</a>: Element <var>link</var></h6> <pre class="codi"><<var>link</var> type="text/html" href="https://www.idescat.cat/emex/?id=08194"/></pre> <h4 id="a2.1.2">2.1.2. Elements basats en l'est脿ndard SDMX</h4> <p>Per encapsular els resultats estad铆stics, cada <var>entry</var> de l'est脿ndard <a href="http://www.atomenabled.org/developers/syndication/" class="extern" target="_blank" rel="noopener" title="Vincle extern: s'obrir脿 una nova finestra">Atom</a> s'ha ampliat amb elements de l'est脿ndard <a href="http://sdmx.org/" class="extern" target="_blank" rel="noopener" title="Vincle extern: s'obrir脿 una nova finestra">SDMX</a>.</p> <h6 id="e10" class="Exemple"><a href="#e10">Ex. 10</a>: Resultats estad铆stics</h6> <pre class="codi"><<var>cross:DataSet</var>> <<var>cross:Section</var> <kbd>AREA</kbd>="080018" <kbd>TIME_PERIOD</kbd>="2009-01-01" <kbd>FREQ</kbd>="A" <kbd>UNIT_MULT</kbd>="0" <kbd>DECIMALS</kbd>="0"> <<var>cross:Obs</var> <kbd>SEX</kbd>="M" <kbd>OBS_VALUE</kbd>="5974" <kbd>OBS_STATUS</kbd>="A"/> <<var>cross:Obs</var> <kbd>SEX</kbd>="F" <kbd>OBS_VALUE</kbd>="5547" <kbd>OBS_STATUS</kbd>="A"/> <<var>cross:Obs</var> <kbd>SEX</kbd>="T" <kbd>OBS_VALUE</kbd>="11521" <kbd>OBS_STATUS</kbd>="A"/> </<var>cross:Section</var>> </<var>cross:DataSet</var>></pre> <p>Com es pot veure a l'exemple anterior, el codi de l'entitat territorial s'expressa com a valor de l'atribut <kbd>AREA</kbd>, el per铆ode de refer猫ncia com a valor de l'atribut <kbd>TIME_PERIOD</kbd> i el nombre d'habitants per sexe com a valor de l'atribut <kbd>OBS_VALUE</kbd>.</p> <h3 id="a2.2">2.2. Operaci贸 <kbd>sug</kbd></h3> <p>Per descriure els resultats, l'operaci贸 <kbd>sug</kbd> utilitza l'est脿ndard <a href="http://www.opensearch.org/Specifications/OpenSearch/Extensions/Suggestions/1.1" class="extern" target="_blank" rel="noopener" title="Vincle extern: s'obrir脿 una nova finestra">OpenSearch Suggestions</a>, que especifica una resposta en format <strong class="important">JSON</strong>. Aquesta mateixa estructura s'utilitza en la resposta en format <strong class="important">PHP serialitzat</strong>.</p> <h6 id="e11" class="Exemple"><a href="#e11">Ex. 11</a>: Sortida de l'operaci贸 <kbd>sug</kbd> per a la cerca "ab", en format JSON</h6> <pre class="codi">["ab",["Abadals, els","Abella","Abella d'Adons","Abella de la Conca","Abella, l'","Abrera"]]</pre> <p>La resposta en format <strong class="important">XML</strong> inclou la mateixa informaci贸 estructurada d'acord amb l'est脿ndard <a href="http://msdn.microsoft.com/en-us/library/cc848863%28VS.85%29.aspx" class="extern" target="_blank" rel="noopener" title="Vincle extern: s'obrir脿 una nova finestra">XML Search Suggestions Format</a> (a vegades anomenat <a href="http://blogs.msdn.com/jonbox/archive/2010/02/28/ie8-fundamentals-of-visual-search-providers.aspx" class="extern" target="_blank" rel="noopener" title="Vincle extern: s'obrir脿 una nova finestra">OpenSearch SearchSuggest2</a>).</p> <h6 id="e12" class="Exemple"><a href="#e12">Ex. 12</a>: Sortida de l'operaci贸 <kbd>sug</kbd> per a la cerca "ab", en format XML</h6> <pre class="codi"><<var>SearchSuggestion</var> version="2.0" xmlns="http://opensearch.org/searchsuggest2"> <<var>Query</var> xml:space="preserve">ab</<var>Query</var>> <<var>Section</var>> <<var>Item</var>> <<var>Text</var> xml:space="preserve">Abadals, els</<var>Text</var>> </<var>Item</var>> <<var>Item</var>> <<var>Text</var> xml:space="preserve">Abella</<var>Text</var>> </<var>Item</var>> <<var>Item</var>> <<var>Text</var> xml:space="preserve">Abella d'Adons</<var>Text</var>> </<var>Item</var>> <<var>Item</var>> <<var>Text</var> xml:space="preserve">Abella de la Conca</<var>Text</var>> </<var>Item</var>> <<var>Item</var>> <<var>Text</var> xml:space="preserve">Abella, l'</<var>Text</var>> </<var>Item</var>> <<var>Item</var>> <<var>Text</var> xml:space="preserve">Abrera</<var>Text</var>> </<var>Item</var>> </<var>Section</var>> </<var>SearchSuggestion</var>></pre> <p>Per conveni猫ncia, tamb茅 s'ofereix la resposta en format text, amb els resultats separats per salts de l铆nia.</p> <h6 id="e13" class="Exemple"><a href="#e13">Ex. 13</a>: Sortida de l'operaci贸 <kbd>sug</kbd> per a la cerca "ab", en format text</h6> <pre class="codi">Abadals, els Abella Abella d'Adons Abella de la Conca Abella, l' Abrera</pre> <h3 id="a2.3">2.3. Errors</h3> <p>Les APIs de l'Idescat utilitzen <a href="/dev/api/#a2.1">codis de resposta</a> normalitzats per indicar si la petici贸 ha tingut 猫xit o si ha fracassat.</p> </div> </div> </div> </div> </main> <footer id="Peu" role="contentinfo"> <div class="aplec"> <div id="OnSou" class="xs-visible"> <h2>Sou aqu铆:</h2> <ul><li><a href="/dev/">脌rea de desenvolupadors</a></li><li><a href="/dev/api/">API</a></li><li>Cerca de poblaci贸. API </li></ul> </div> <div id="idiomes" role="navigation" aria-label="Idioma de la p脿gina"> <ul><li><a href="?lang=es" title="Esta página está traducida total o parcialmente al castellano" hreflang="es">es</a></li><li><a href="?lang=en" title="This page is totally or partially translated into English" hreflang="en">en</a></li></ul> </div> <ul id="Copyright"> <li><a href="/institut/web/">Avís legal</a></li> <li><a href="/institut/web/accessibilitat/">Accessibilitat</a></li> <li><a href="/institut/" class="idescat">Institut d'Estadística de Catalunya</a></li> </ul> <div class="Datacio"><time datetime="2019-03-21T08:37:00Z">21/03/2019</time></div> <ul id="xarxes"> <li><a href="https://x.com/idescat"><img src="/images/xc.png" alt="X" title="X"></a></li> <li><a href="https://www.linkedin.com/company/idescat/"><img src="/images/linkedinc.png" alt="LinkedIn" title="LinkedIn"></a></li> </ul> <ul id="generalitat"> <li><a href="http://web.gencat.cat/ca/inici/"><img src="/images/mgencat.png" alt="www.gencat.cat"></a></li> <li><a class="amunt">Torna amunt</a></li> </ul> <div id="pujar" class="amunt"></div> </div> </footer> </div> <script> IDESCAT.ini(); </script> </body></html>

CINXE.COM

Idescat. 脌rea de desenvolupadors. API. Cerca de poblaci贸