[{"data":1,"prerenderedAt":735},["ShallowReactive",2],{"page-\u002Fapi\u002Fresponses":3},{"id":4,"title":5,"body":6,"description":727,"extension":728,"meta":729,"navigation":730,"path":731,"seo":732,"stem":733,"__hash__":734},"content\u002F2.api\u002F5.responses.md","Responses and errors",{"type":7,"value":8,"toc":720},"minimark",[9,18,27,143,147,204,208,262,266,302,410,430,512,532,614,634,716],[10,11,12,13,17],"p",{},"Every endpoint returns a GeoJSON ",[14,15,16],"code",{},"FeatureCollection"," in the Pelias shape.",[19,20,22,23,26],"h2",{"id":21},"the-geocoding-block","The ",[14,24,25],{},"geocoding"," block",[28,29,30,43],"table",{},[31,32,33],"thead",{},[34,35,36,40],"tr",{},[37,38,39],"th",{},"Field",[37,41,42],{},"Meaning",[44,45,46,57,67,83,113,133],"tbody",{},[34,47,48,54],{},[49,50,51],"td",{},[14,52,53],{},"version",[49,55,56],{},"Pelias response version.",[34,58,59,64],{},[49,60,61],{},[14,62,63],{},"attribution",[49,65,66],{},"URL of the data attribution page.",[34,68,69,74],{},[49,70,71],{},[14,72,73],{},"engine",[49,75,76,79,80,82],{},[14,77,78],{},"name"," and ",[14,81,53],{}," of the server.",[34,84,85,90],{},[49,86,87],{},[14,88,89],{},"query",[49,91,92,93,96,97,100,101,104,105,108,109,112],{},"The parsed request: ",[14,94,95],{},"text"," or ",[14,98,99],{},"fields",", ",[14,102,103],{},"size",", the ",[14,106,107],{},"tinql"," that ran, and ",[14,110,111],{},"ranking",".",[34,114,115,120],{},[49,116,117],{},[14,118,119],{},"query.ranking",[49,121,122,125,126,129,130,132],{},[14,123,124],{},"importance"," (text score plus importance), ",[14,127,128],{},"importance+distance"," (with a focus point), or ",[14,131,95],{}," (a budget ran out and the text score alone was used).",[34,134,135,140],{},[49,136,137],{},[14,138,139],{},"errors",[49,141,142],{},"Present only on errors: human-readable messages.",[19,144,146],{"id":145},"feature-properties","Feature properties",[10,148,149,150,100,153,100,156,100,159,100,162,100,164,79,167,169,170,100,173,100,176,100,179,100,182,100,185,79,188,191,192,195,196,199,200,203],{},"Each feature has ",[14,151,152],{},"id",[14,154,155],{},"gid",[14,157,158],{},"layer",[14,160,161],{},"source",[14,163,78],{},[14,165,166],{},"label",[14,168,124],{},", plus the fields that are known for that place: ",[14,171,172],{},"street",[14,174,175],{},"postalcode",[14,177,178],{},"locality",[14,180,181],{},"county",[14,183,184],{},"region",[14,186,187],{},"country",[14,189,190],{},"country_code",". Text searches add ",[14,193,194],{},"confidence",". Results near a focus point, and all reverse results, add ",[14,197,198],{},"distance"," in kilometres. The collection also has a ",[14,201,202],{},"bbox"," of all features.",[19,205,207],{"id":206},"status-codes","Status codes",[28,209,210,220],{},[31,211,212],{},[34,213,214,217],{},[37,215,216],{},"Status",[37,218,219],{},"When",[44,221,222,232,242,252],{},[34,223,224,229],{},[49,225,226],{},[14,227,228],{},"200",[49,230,231],{},"Success, including an empty result.",[34,233,234,239],{},[49,235,236],{},[14,237,238],{},"400",[49,240,241],{},"A parameter is missing or invalid.",[34,243,244,249],{},[49,245,246],{},[14,247,248],{},"502",[49,250,251],{},"The database is unavailable.",[34,253,254,259],{},[49,255,256],{},[14,257,258],{},"504",[49,260,261],{},"The text-only fallback query ran out of its budget and no rows were found.",[19,263,265],{"id":264},"validation-errors","Validation errors",[267,268,273],"pre",{"className":269,"code":270,"language":271,"meta":272,"style":272},"language-bash shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","curl 'http:\u002F\u002Flocalhost:4000\u002Fv1\u002Fsearch'\n# HTTP 400\n","bash","",[14,274,275,295],{"__ignoreMap":272},[276,277,280,284,288,292],"span",{"class":278,"line":279},"line",1,[276,281,283],{"class":282},"sBMFI","curl",[276,285,287],{"class":286},"sMK4o"," '",[276,289,291],{"class":290},"sfazB","http:\u002F\u002Flocalhost:4000\u002Fv1\u002Fsearch",[276,293,294],{"class":286},"'\n",[276,296,298],{"class":278,"line":297},2,[276,299,301],{"class":300},"sHwdD","# HTTP 400\n",[267,303,307],{"className":304,"code":305,"language":306,"meta":272,"style":272},"language-json shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","{\n  \"features\": [],\n  \"geocoding\": {\n    \"errors\": [\n      \"missing param 'text'\"\n    ]\n  },\n  \"type\": \"FeatureCollection\"\n}\n","json",[14,308,309,314,332,346,361,373,379,385,404],{"__ignoreMap":272},[276,310,311],{"class":278,"line":279},[276,312,313],{"class":286},"{\n",[276,315,316,319,323,326,329],{"class":278,"line":297},[276,317,318],{"class":286},"  \"",[276,320,322],{"class":321},"spNyl","features",[276,324,325],{"class":286},"\"",[276,327,328],{"class":286},":",[276,330,331],{"class":286}," [],\n",[276,333,335,337,339,341,343],{"class":278,"line":334},3,[276,336,318],{"class":286},[276,338,25],{"class":321},[276,340,325],{"class":286},[276,342,328],{"class":286},[276,344,345],{"class":286}," {\n",[276,347,349,352,354,356,358],{"class":278,"line":348},4,[276,350,351],{"class":286},"    \"",[276,353,139],{"class":282},[276,355,325],{"class":286},[276,357,328],{"class":286},[276,359,360],{"class":286}," [\n",[276,362,364,367,370],{"class":278,"line":363},5,[276,365,366],{"class":286},"      \"",[276,368,369],{"class":290},"missing param 'text'",[276,371,372],{"class":286},"\"\n",[276,374,376],{"class":278,"line":375},6,[276,377,378],{"class":286},"    ]\n",[276,380,382],{"class":278,"line":381},7,[276,383,384],{"class":286},"  },\n",[276,386,388,390,393,395,397,400,402],{"class":278,"line":387},8,[276,389,318],{"class":286},[276,391,392],{"class":321},"type",[276,394,325],{"class":286},[276,396,328],{"class":286},[276,398,399],{"class":286}," \"",[276,401,16],{"class":290},[276,403,372],{"class":286},[276,405,407],{"class":278,"line":406},9,[276,408,409],{"class":286},"}\n",[267,411,413],{"className":269,"code":412,"language":271,"meta":272,"style":272},"curl 'http:\u002F\u002Flocalhost:4000\u002Fv1\u002Fsearch?text=cafe&size=99'\n# HTTP 400\n",[14,414,415,426],{"__ignoreMap":272},[276,416,417,419,421,424],{"class":278,"line":279},[276,418,283],{"class":282},[276,420,287],{"class":286},[276,422,423],{"class":290},"http:\u002F\u002Flocalhost:4000\u002Fv1\u002Fsearch?text=cafe&size=99",[276,425,294],{"class":286},[276,427,428],{"class":278,"line":297},[276,429,301],{"class":300},[267,431,433],{"className":304,"code":432,"language":306,"meta":272,"style":272},"{\n  \"features\": [],\n  \"geocoding\": {\n    \"errors\": [\n      \"size must be between 1 and 40\"\n    ]\n  },\n  \"type\": \"FeatureCollection\"\n}\n",[14,434,435,439,451,463,475,484,488,492,508],{"__ignoreMap":272},[276,436,437],{"class":278,"line":279},[276,438,313],{"class":286},[276,440,441,443,445,447,449],{"class":278,"line":297},[276,442,318],{"class":286},[276,444,322],{"class":321},[276,446,325],{"class":286},[276,448,328],{"class":286},[276,450,331],{"class":286},[276,452,453,455,457,459,461],{"class":278,"line":334},[276,454,318],{"class":286},[276,456,25],{"class":321},[276,458,325],{"class":286},[276,460,328],{"class":286},[276,462,345],{"class":286},[276,464,465,467,469,471,473],{"class":278,"line":348},[276,466,351],{"class":286},[276,468,139],{"class":282},[276,470,325],{"class":286},[276,472,328],{"class":286},[276,474,360],{"class":286},[276,476,477,479,482],{"class":278,"line":363},[276,478,366],{"class":286},[276,480,481],{"class":290},"size must be between 1 and 40",[276,483,372],{"class":286},[276,485,486],{"class":278,"line":375},[276,487,378],{"class":286},[276,489,490],{"class":278,"line":381},[276,491,384],{"class":286},[276,493,494,496,498,500,502,504,506],{"class":278,"line":387},[276,495,318],{"class":286},[276,497,392],{"class":321},[276,499,325],{"class":286},[276,501,328],{"class":286},[276,503,399],{"class":286},[276,505,16],{"class":290},[276,507,372],{"class":286},[276,509,510],{"class":278,"line":406},[276,511,409],{"class":286},[267,513,515],{"className":269,"code":514,"language":271,"meta":272,"style":272},"curl 'http:\u002F\u002Flocalhost:4000\u002Fv1\u002Fsearch?text=cafe&layers=street'\n# HTTP 400\n",[14,516,517,528],{"__ignoreMap":272},[276,518,519,521,523,526],{"class":278,"line":279},[276,520,283],{"class":282},[276,522,287],{"class":286},[276,524,525],{"class":290},"http:\u002F\u002Flocalhost:4000\u002Fv1\u002Fsearch?text=cafe&layers=street",[276,527,294],{"class":286},[276,529,530],{"class":278,"line":297},[276,531,301],{"class":300},[267,533,535],{"className":304,"code":534,"language":306,"meta":272,"style":272},"{\n  \"features\": [],\n  \"geocoding\": {\n    \"errors\": [\n      \"unknown layer 'street'; supported: venue, address\"\n    ]\n  },\n  \"type\": \"FeatureCollection\"\n}\n",[14,536,537,541,553,565,577,586,590,594,610],{"__ignoreMap":272},[276,538,539],{"class":278,"line":279},[276,540,313],{"class":286},[276,542,543,545,547,549,551],{"class":278,"line":297},[276,544,318],{"class":286},[276,546,322],{"class":321},[276,548,325],{"class":286},[276,550,328],{"class":286},[276,552,331],{"class":286},[276,554,555,557,559,561,563],{"class":278,"line":334},[276,556,318],{"class":286},[276,558,25],{"class":321},[276,560,325],{"class":286},[276,562,328],{"class":286},[276,564,345],{"class":286},[276,566,567,569,571,573,575],{"class":278,"line":348},[276,568,351],{"class":286},[276,570,139],{"class":282},[276,572,325],{"class":286},[276,574,328],{"class":286},[276,576,360],{"class":286},[276,578,579,581,584],{"class":278,"line":363},[276,580,366],{"class":286},[276,582,583],{"class":290},"unknown layer 'street'; supported: venue, address",[276,585,372],{"class":286},[276,587,588],{"class":278,"line":375},[276,589,378],{"class":286},[276,591,592],{"class":278,"line":381},[276,593,384],{"class":286},[276,595,596,598,600,602,604,606,608],{"class":278,"line":387},[276,597,318],{"class":286},[276,599,392],{"class":321},[276,601,325],{"class":286},[276,603,328],{"class":286},[276,605,399],{"class":286},[276,607,16],{"class":290},[276,609,372],{"class":286},[276,611,612],{"class":278,"line":406},[276,613,409],{"class":286},[267,615,617],{"className":269,"code":616,"language":271,"meta":272,"style":272},"curl 'http:\u002F\u002Flocalhost:4000\u002Fv1\u002Fsearch?text=cafe&focus.point.lat=48'\n# HTTP 400\n",[14,618,619,630],{"__ignoreMap":272},[276,620,621,623,625,628],{"class":278,"line":279},[276,622,283],{"class":282},[276,624,287],{"class":286},[276,626,627],{"class":290},"http:\u002F\u002Flocalhost:4000\u002Fv1\u002Fsearch?text=cafe&focus.point.lat=48",[276,629,294],{"class":286},[276,631,632],{"class":278,"line":297},[276,633,301],{"class":300},[267,635,637],{"className":304,"code":636,"language":306,"meta":272,"style":272},"{\n  \"features\": [],\n  \"geocoding\": {\n    \"errors\": [\n      \"focus.point.lat and focus.point.lon must be set together\"\n    ]\n  },\n  \"type\": \"FeatureCollection\"\n}\n",[14,638,639,643,655,667,679,688,692,696,712],{"__ignoreMap":272},[276,640,641],{"class":278,"line":279},[276,642,313],{"class":286},[276,644,645,647,649,651,653],{"class":278,"line":297},[276,646,318],{"class":286},[276,648,322],{"class":321},[276,650,325],{"class":286},[276,652,328],{"class":286},[276,654,331],{"class":286},[276,656,657,659,661,663,665],{"class":278,"line":334},[276,658,318],{"class":286},[276,660,25],{"class":321},[276,662,325],{"class":286},[276,664,328],{"class":286},[276,666,345],{"class":286},[276,668,669,671,673,675,677],{"class":278,"line":348},[276,670,351],{"class":286},[276,672,139],{"class":282},[276,674,325],{"class":286},[276,676,328],{"class":286},[276,678,360],{"class":286},[276,680,681,683,686],{"class":278,"line":363},[276,682,366],{"class":286},[276,684,685],{"class":290},"focus.point.lat and focus.point.lon must be set together",[276,687,372],{"class":286},[276,689,690],{"class":278,"line":375},[276,691,378],{"class":286},[276,693,694],{"class":278,"line":381},[276,695,384],{"class":286},[276,697,698,700,702,704,706,708,710],{"class":278,"line":387},[276,699,318],{"class":286},[276,701,392],{"class":321},[276,703,325],{"class":286},[276,705,328],{"class":286},[276,707,399],{"class":286},[276,709,16],{"class":290},[276,711,372],{"class":286},[276,713,714],{"class":278,"line":406},[276,715,409],{"class":286},[717,718,719],"style",{},"html pre.shiki code .sBMFI, html code.shiki .sBMFI{--shiki-light:#E2931D;--shiki-default:#FFCB6B;--shiki-dark:#FFCB6B}html pre.shiki code .sMK4o, html code.shiki .sMK4o{--shiki-light:#39ADB5;--shiki-default:#89DDFF;--shiki-dark:#89DDFF}html pre.shiki code .sfazB, html code.shiki .sfazB{--shiki-light:#91B859;--shiki-default:#C3E88D;--shiki-dark:#C3E88D}html pre.shiki code .sHwdD, html code.shiki .sHwdD{--shiki-light:#90A4AE;--shiki-light-font-style:italic;--shiki-default:#546E7A;--shiki-default-font-style:italic;--shiki-dark:#676E95;--shiki-dark-font-style:italic}html .light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html.light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html pre.shiki code .spNyl, html code.shiki .spNyl{--shiki-light:#9C3EDA;--shiki-default:#C792EA;--shiki-dark:#C792EA}",{"title":272,"searchDepth":297,"depth":297,"links":721},[722,724,725,726],{"id":21,"depth":297,"text":723},"The geocoding block",{"id":145,"depth":297,"text":146},{"id":206,"depth":297,"text":207},{"id":264,"depth":297,"text":265},"Response shape, the geocoding block, and status codes.","md",{},true,"\u002Fapi\u002Fresponses",{"title":5,"description":727},"2.api\u002F5.responses","ugq9Ny0bpzViPe9UmzBSabd-GIRsYfKWJbccvhVHlEo",1791345919968]