Endpoints

All operations are performed using http GET

GET /api/pointsbyvibe ¶

This endpoint is intended for mapping applications. It takes a bounding box and a vibe and returns a list of points.

Operators:

swlat: southwest latitude of the bounding box

swlng: southwest longitude of the bounding box

nelat: northeast latitude of the bounding box

nelng: northeast longitude of the bounding box

vibe

one of the following vibe categories or sub-categories:

events
now
hip
- edgy_cool
- up_and_coming
- mainstream
foodie
- food_trucks
- coffee_lovers
- organic
- fine_dining"
sights
- attractions
- monuments
- photo_op"
the_arts
- theater
- galleries
- architecture"
nightlife
- dance
- sports_bars
- live_music"
healthy
- active_living
- healthy_eats
- outdoors
- yoga"
love
- majestic_views
- date_night"
family
- sports
- excursions
- educational"
culture
- lgbt
- latin_corridor
- chinatown"
nature
- parks
- water"

apikey: provided key

numgroups (optional): number of point clusters to return, default is 10

d (optional)

day of the week, one of:

mon
tue
wed
thu
fri
sat
sun

s (optional): time of day, in seconds after midnight; return items between s and an hour later

Example Query:

GET https://spatial.ai/api/pointsbyvibe?swlat=40.509559&swlng=-74.236877&nelat=40.883347&nelng=-73.697174&vibe=hip&apikey=YOURAPIKEY

Example Response:


[  
    {  
        "lat":40.75900903,
        "lng":-73.98775802
    },
    {  
        "lat":40.7586,
        "lng":-73.98618
    },
    {  
        "lat":40.75900107,
        "lng":-73.98670793
    },
    {  
        "lat":40.75943,
        "lng":-73.98558
    },
    {  
        "lat":40.75897,
        "lng":-73.98489
    },
    

    ...
    

    {  
        "lat":40.7581136,
        "lng":-73.9874761
    },
    {  
        "lat":40.76111111,
        "lng":-73.98583333
    },
    {  
        "lat":40.7586107,
        "lng":-73.9874561
    },
    {  
        "lat":40.75932538,
        "lng":-73.98667837
    }
]

GET /api/pointdetail ¶

This endpoint returns the vibe rating of a point.

Operators:

lat: latitude

lng: longitude

apikey: provided key

Example Query:

https://spatial.ai/api/pointdetail?lat=40.76111111&lng=-73.98583333&apikey=YOURAPIKEY

Example Response:


{  
    "foodie":"9.0/10",
    "hot":"9.8/10",
    "active":"9.8/10",
    "culture":"9.4/10",
    "food-trucks":"5.0/10",
    "sights":"7.0/10",
    "romantic":"10.0/10",
    "hip":"9.4/10",
    "lgbt":"4.9/10",
    "now":"10.0/10",
    "dance":"9.6/10",
    "healthy":"9.4/10",
    "family":"9.0/10",
    "nightlife":"10.0/10",
    "healthy-eats":"8.2/10",
    "active-living":"9.6/10",
    "photo-op":"0.5/10",
    "organic":"7.8/10",
    "chinatown":"4.4/10",
    "edgy-cool":"3.9/10",
    "up-and-coming":"7.0/10",
    "mainstream":"10.0/10",
    "coffee-lovers":"9.8/10",
    "fine-dining":"7.6/10",
    "the-arts":"10.0/10",
    "theater":"10.0/10",
    "galleries":"8.8/10",
    "architecture":"5.0/10",
    "attractions":"9.0/10",
    "monuments":"10.0/10",
    "sports-bars":"10.0/10",
    "live-music":"10.0/10",
    "outdoors":"10.0/10",
    "yoga":"9.0/10",
    "majestic-views":"10.0/10",
    "date-night":"10.0/10",
    "sports":"7.0/10",
    "excursions":"2.9/10",
    "educational":"10.0/10",
    "nature":"4.8/10",
    "parks":"4.0/10",
    "water":"2.9/10",
    "lat":40.76111111,
    "lng":-73.98583333,
    "top_behaviors":[  
        "entertainment",
        "eating",
        "drinking"
    ],
    "media_volume":"high",
    "top_hashtags":[  
        "nyc",
        "timessquare",
        "newyork",
        "broadway",
        "newyorkcity",
        "manhattan"
    ]
}

GET /api/getevents ¶

This endpoint returns event listings.

Operators:

swlat: southwest latitude of the bounding box

swlng: southwest longitude of the bounding box

nelat: northeast latitude of the bounding box

nelng: northeast longitude of the bounding box

starts_before (optional): events starting before this time (in epoch seconds)

starts_after (optional): events starting after this time (in epoch seconds)

ends_before (optional): events ending before this time (in epoch seconds)

ends_after (optional): events ending after this time (in epoch seconds)

filter (optional): filter event name by this

Example Query:

https://spatial.ai/api/getevents?swlat=39.961299&swlng=-105.298001&nelat=40.095373&nelng=-105.187108&starts_before=1463708397&starts_after=1463679597&apikey=YOURAPIKEY

Example Response:


[  
    {  
        "lat":39.9844668,
        "lng":-105.2491333,
        "name":"Open Mic Night",
        "start_time":1463702400,
        "end_time":1463713200
    },
    {  
        "lat":40.01778810831,
        "lng":-105.28111666109,
        "location":"Boulder Book Store",
        "name":"Ren & Helen Davis - \"Landscapes for the People\"",
        "start_time":1463707800,
        "end_time":1463711400,
        "category":""
    },
    {  
        "lat":40.020120333631,
        "lng":-105.27544222577,
        "location":"Etown",
        "name":"Glue Talk with Dr. Stan Tatkin and Bruce Tift",
        "start_time":1463707800,
        "end_time":1463711400,
        "category":""
    },
    {  
        "lat":40.0155716,
        "lng":-105.2616425,
        "location":"The mama'hood Boulder",
        "name":"The Wisdom of Birth",
        "start_time":1463702400,
        "end_time":1463713200,
        "category":""
    },
    {  
        "lat":40.0155716,
        "lng":-105.2616425,
        "location":"The mama'hood Boulder",
        "name":"Kids Yoga",
        "start_time":1463696100,
        "end_time":1463699700,
        "category":""
    },
    {  
        "lat":40.022613,
        "lng":-105.247622,
        "location":"Sanitas Brewing",
        "name":"Pullin' The Nails on the Barrels Beer Tasting",
        "start_time":1463702400,
        "end_time":1463713200,
        "category":""
    },
    {  
        "lat":40.01822,
        "lng":-105.22924,
        "location":"Vapor Distillery",
        "name":"C-Bob's Gin Joint Jam at Vapor's Speakeasy",
        "start_time":1463702400,
        "end_time":1463716800,
        "category":""
    },
    {  
        "lat":40.0269814,
        "lng":-105.2823868,
        "location":"The Integral Center",
        "name":"Game Night ~ Permission with Maria Bailey and Jason Digges",
        "start_time":1463706000,
        "end_time":1463713200,
        "category":""
    },
    {  
        "lat":40.0347701,
        "lng":-105.2764318,
        "location":"Growing Gardens",
        "name":"After School Gardening Club",
        "start_time":1463694300,
        "end_time":1463699700,
        "category":""
    },
    {  
        "lat":40.0081062,
        "lng":-105.2648163,
        "location":"Roadhouse Boulder Depot",
        "name":"Going Away Party for Marni",
        "start_time":1463700600,
        "end_time":1463704200,
        "category":""
    },
    {  
        "lat":40.02642,
        "lng":-105.24419,
        "location":"Green Guru",
        "name":"Fundraiser Happy Hour",
        "start_time":1463698800,
        "end_time":1463713200,
        "category":""
    },
    {  
        "lat":40.019420085765,
        "lng":-105.26099695362,
        "location":"Dairy Arts Center",
        "name":"International OCEAN FILM TOUR Volume 3 | Boulder",
        "start_time":1463707800,
        "end_time":1463711400,
        "category":""
    }
]

GET /api/query ¶

This endpoint processes a query string, such as 'show me hip bars in pittsburgh' or 'events in detroit monday'

Operators:

q: query string

apikey: provided key

swlat: southwest latitude of the bounding box

swlng: southwest longitude of the bounding box

nelat: northeast latitude of the bounding box

nelng: northeast longitude of the bounding box

Response

Returns a dictionary with the following

poi: array of points of interest; events or venues

hex: array of regions matching combined vibes in the query

vibes: list of vibes processed from query string

recenter: coordinates to recenter the map

Example Query:

GET https://spatial.ai/api/query?q=show%20me%20hip%20bars%20in%20pittsburgh&apikey=YOUR_API_KEY

Example Response:


{  
    "poi":[  
        {  
            "name":"Cattivo",
            "lat":40.472509,
            "lng":-79.961687,
            "rating":4,
            "tags":[  
                "bars",
                "music venues"
            ],
            "type":"venue"
        },
        {  
            "name":"New Amsterdam",
            "lat":40.472148,
            "lng":-79.959533,
            "rating":4,
            "tags":[  
                "dance clubs",
                "pubs"
            ],
            "type":"venue"
        },
        {  
            "name":"Mister Grooming & Goods",
            "lat":40.472132,
            "lng":-79.958813,
            "rating":4.5,
            "tags":[  
                "barbers"
            ],
            "type":"venue"
        },

        ...

        {  
            "name":"Industry Public House",
            "lat":40.4707662016153,
            "lng":-79.9603226780891,
            "rating":3.5,
            "tags":[  
                "american (new)",
                "cocktail bars"
            ],
            "type":"venue"
        },
        {  
            "name":"Tender Bar & Kitchen",
            "lat":40.470578,
            "lng":-79.960043,
            "rating":3.5,
            "tags":[  
                "american (new)",
                "cocktail bars"
            ],
            "type":"venue"
        },
        {  
            "name":"Hambone's Pub",
            "lat":40.470474,
            "lng":-79.960431,
            "rating":3.5,
            "tags":[  
                "pubs",
                "american (new)"
            ],
            "type":"venue"
        }
    ],
    "hex":[  
        {  
            "swlat":40.42798792337201,
            "swlng":-79.9681528346991,
            "nelat":40.43161115225921,
            "nelng":-79.96340835811442
        },
        {  
            "swlat":40.42798792337201,
            "swlng":-79.97764178786844,
            "nelat":40.43161115225921,
            "nelng":-79.97289731128376
        },

        ...

        {  
            "swlat":40.42798792337201,
            "swlng":-79.97289731128376,
            "nelat":40.43161115225921,
            "nelng":-79.9681528346991
        },
        {  
            "swlat":40.42436469448481,
            "swlng":-79.98238626445311,
            "nelat":40.42798792337201,
            "nelng":-79.97764178786844
        }
    ],
    "vibes":[  
        "hip"
    ],
    "recenter":{  
        "lat":40.436945,
        "lng":-79.9755245
    }
}