The frame at a location

curl --request GET \
  --url https://api.staging.loci.ng/v1/frames/at \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.staging.loci.ng/v1/frames/at', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.staging.loci.ng/v1/frames/at",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.staging.loci.ng/v1/frames/at"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.staging.loci.ng/v1/frames/at")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": "2163551",
    "geometry": {
      "type": "Polygon",
      "coordinates": [
        [
          [
            7.5003,
            9.05143
          ],
          [
            7.49131,
            9.05143
          ],
          [
            7.49129,
            9.05145
          ],
          [
            7.48751,
            9.05811
          ],
          [
            7.48753,
            9.06201
          ],
          [
            7.5003,
            9.06201
          ],
          [
            7.5003,
            9.05143
          ]
        ]
      ]
    },
    "bbox": [
      7.48751,
      9.05143,
      7.5003,
      9.06201
    ]
  }
}

Frames

The frame at a location

Resolves a longitude and latitude to the frame that contains it: the cell’s id, its shape, and its bounding box.

This is the first call most integrations make. The id it returns is what the other three calls take. A device’s own position, a geocoded address, a tapped point on a map: any of them becomes a frame id here.

lng is accepted as a spelling of lon. The answer is cacheable for ten minutes; the grid only changes when it is reloaded.

Needs the frame.read capability, which every scope preset grants.

GET

frames

The frame at a location

curl --request GET \
  --url https://api.staging.loci.ng/v1/frames/at \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.staging.loci.ng/v1/frames/at', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.staging.loci.ng/v1/frames/at",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.staging.loci.ng/v1/frames/at"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.staging.loci.ng/v1/frames/at")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": "2163551",
    "geometry": {
      "type": "Polygon",
      "coordinates": [
        [
          [
            7.5003,
            9.05143
          ],
          [
            7.49131,
            9.05143
          ],
          [
            7.49129,
            9.05145
          ],
          [
            7.48751,
            9.05811
          ],
          [
            7.48753,
            9.06201
          ],
          [
            7.5003,
            9.06201
          ],
          [
            7.5003,
            9.05143
          ]
        ]
      ]
    },
    "bbox": [
      7.48751,
      9.05143,
      7.5003,
      9.06201
    ]
  }
}

Authorizations

Authorization

string

header

required

An API key minted in the Developers tab of the LOCI app, sent as Authorization: Bearer loci_sk_…. Acts for one organisation, is read-only, and expires.

Query Parameters

lat

number

required

Latitude in degrees, −90 to 90.

lon

number

required

Longitude in degrees, −180 to 180. lng is accepted too.

Response

The frame containing the point.

data

object

required

A cell of the spatial index.

Show child attributes