Overview

Welcome to the Munzee API! This API is focused on easily allowing you to use Munzee data within your own apps. We hope that you will use this API to make great things. If you need help or like to talk with us more, please go to https://www.munzee.com/api/ or email api@munzee.com.

Authentication

To authorize, use this code:

# With shell, you can just pass the correct header with each request
curl "https://api.munzee.com/"\
-H "Authorization: BEARER-TOKEN"

The Munzee API is using OAuth 2.0 technology. You have to authenticate with every request by including an issued access token at the HTTP Authorization header field. Please get in touch with us to get OAuth credentials for your app.

You must replace `BEARER-TOKEN` with a real access token to build proper requests.

Get Latest Logs

{"data":[{"username":"moonraker99","user_id":"132106","created_at":"2013-12-29 15:00:37","notes":"Schade","type_name":"Unable to Locate","type_id":"3","entry_at":"2013-12-29T15:00:37-06:00","entry_id":"2433868","entry_at_unix":1388350837,"type":"entry"},{"username":"dafi87","user_id":"5582","created_at":"2013-11-04 19:40:29","notes":"This munzee has been verified by the owner.","type_name":"Verified","type_id":"6","entry_at":"2013-11-04T19:40:29-06:00","entry_id":"2170802","entry_at_unix":1383615629,"type":"entry"},{"username":"schnaddeli","user_id":"134791","captured_at":"2013-11-04 19:29:38","points":5,"capture_id":"6710930","entry_at":"2013-11-04T19:29:38-06:00","entry_at_unix":1383614978,"type":"capture"},{"username":"Leni89","user_id":"10313","captured_at":"2013-03-06 10:05:37","points":5,"capture_id":"2330348","entry_at":"2013-03-06T10:05:37-06:00","entry_at_unix":1362585937,"type":"capture"},{"username":"dafi87","user_id":"5582","created_at":"2013-02-01 10:13:41","notes":"This munzee has been verified by the owner.","type_name":"Verified","type_id":"6","entry_at":"2013-02-01T10:13:41-06:00","entry_id":"820137","entry_at_unix":1359735221,"type":"entry"}]}

Get deployed Munzees within a Bounding Box. Filter options can be applied. It’s possible to get more than one box at a time. Needed data fields can be specified.
If the number of munzees in a box exceeds the maximum limit of 1000 munzees, returned data for that box will be picked randomly. So try to keep the boxes small.

Get Clan Details

{"data":{"details":{"name":"Munzee HQ","simple_name":"munzeehq","tagline":"We work, so you can play.","logo":"http://static.munzee.com/images/clan_logos/1.png","notes":"Team Munzee represent!","created_by_userid":"9","clan_id":1,"clan_logo":"http://static.munzee.com/images/clan_logos/1.png"},"users":[{"username":"coachV","user_id":"4281","is_admin":"1","is_premium":"1","user_image":"http://www.gravatar.com/avatar/d7449b42a3ca780cf85da6979a987397?d=http%3A%2F%2Fstatic.munzee.com%2Fimages%2Fsite%2Fblank-avatar.png&s=65","deploy_points":160,"capture_points":590,"capture_on_points":1826,"total_points":2576,"user_hash":"d7449b42a3ca780cf85da6979a987397"},{"username":"TeeJayOoo","user_id":"40359","is_admin":"1","is_premium":"1","user_image":"http://www.gravatar.com/avatar/c774c2936d0c8b9cbd0903770dd809ed?d=http%3A%2F%2Fstatic.munzee.com%2Fimages%2Fsite%2Fblank-avatar.png&s=65","deploy_points":0,"capture_points":90,"capture_on_points":363,"total_points":453,"user_hash":"c774c2936d0c8b9cbd0903770dd809ed"},{"username":"VanderArban","user_id":"102851","is_admin":"0","is_premium":"1","user_image":"http://www.gravatar.com/avatar/0309ea2c3d05a78c8a9a6513bc2719fd?d=http%3A%2F%2Fstatic.munzee.com%2Fimages%2Fsite%2Fblank-avatar.png&s=65","deploy_points":0,"capture_points":0,"capture_on_points":242,"total_points":242,"user_hash":"0309ea2c3d05a78c8a9a6513bc2719fd"},{"username":"coolant","user_id":"9","is_admin":"1","is_premium":"1","user_image":"http://www.gravatar.com/avatar/37c0ec8e8e83bb7cce4d8a5b3f5c7213?d=http%3A%2F%2Fstatic.munzee.com%2Fimages%2Fsite%2Fblank-avatar.png&s=65","deploy_points":20,"capture_points":85,"capture_on_points":111,"total_points":216,"user_hash":"37c0ec8e8e83bb7cce4d8a5b3f5c7213"}],"admins":{"9":"9","4281":"4281","40359":"40359"},"ranking":163,"number_of_clans":"280"}}

Get details for a specific clan and all clan members. Point values are for the current clan battle.

{"data":{"munzee_data":{"munzee_id":"1285176","creator_user_id":"59589","points":"5","latitude":"0","longitude":"0","deployed":"1","archived":"0","created_at":"2013-09-18 22:48:05","notes":"The home of Robin Hood and Nottingham Forest Football Club.","friendly_name":"Greetings from Nottingham UK.","munzee_code":"999","deployed_at":"2013-12-03 21:50:03","capture_type_id":"32","maintenance":"0","points_for_capturing":"5","first_to_capture_user_id":"9626","archived_at":null,"motel_id":"0","motel_room":null,"country":null,"last_updated_at":"2014-04-23 11:27:31","first_captured_user_id":"9626","first_captured_username":"firstfirst","last_captured_at":"2014-10-07 03:14:22","last_captured_by_id":"169110","last_captured_points":"0","number_of_captures":"535","creator_username":"useruser","code":"https:\/\/www.munzee.com\/m\/useruser\/999\/","is_virtual":0,"secure_social":0,"rovers":[],"needs_rover_level":999999,"has_user_captured_munzee":0,"owned_by_user":0,"proximity_radius_ft":50},"friendly_name":"Greetings from Nottingham UK.","result":"You've captured the social munzee, \"Greetings from Nottingham UK.\"!","feet_away":18620128,"capture":1,"captured_munzee_id":"1285176","points":"0"}}

Captures a physical munzee, quiz munzees excluded.

This endpoint requires an access token having the capture_light scope applied.

HTTP Request

POST https://api.munzee.com/capture/light/

Parameters

Parameter

Description

latitude

current user position

longitude

current user position

accuracy

current GPS accuracy value in meters

code

scanned barcode value

time

current Unix timestamp

language

optional, result messages will be returned in the specific language if available (see languages)