NAV
cURL

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.

Munzees

Get a Munzee by ID

curl "https://api.munzee.com/munzee/" \
  -H "Authorization: BEARER-TOKEN" \
  -F 'data={"munzee_id":100, "closest":1}'

The above command returns JSON structured like this:

{
  "data": {
    "munzee_id": 100,
    "friendly_name": "OLD AH: Warm-up",
    "number_of_captures": 0,
    "points": 5,
    "latitude": "33.049298753322",
    "longitude": "-96.8477738797665",
    "deployed": 0,
    "archived": 1,
    "archived_at": "2015-02-02T00:50:12-06:00",
    "deployed_at": "2011-07-01T00:00:00-05:00",
    "notes": "Arbor Hills Nature Preserve: Easy find not far from the parking lot. ",
    "motel_id": "0",
    "hotel_id": "0",
    "rovers": [ ],
    "creator_user_id": 6,
    "creator_username": "snicker",
    "creator_userhash": "0c572e1d13a8b8585a9ed1bd07955e03",
    "url": "\/m\/snicker\/13\/",
    "code": "http:\/\/www.munzee.com\/m\/snicker\/13\/",
    "generic_code": false,
    "has_user_captured_munzee": 0,
    "has_user_subscribed_munzee": 0,
    "last_updated_at": "2015-02-02T00:50:12-06:00",
    "number_of_entries": 0,
    "pin_icon": "http:\/\/static.munzee.com\/images\/pins\/munzee.png",
    "capture_type_id": "0",
    "is_virtual": 0,
    "closest": [
        {
            "munzee_id": "17848505",
            "friendly_name": "AH Brown Box",
            "capture_type_id": "0",
            "code": "\/m\/9key\/803\/",
            "munzee_logo": null,
            "distance": "0.04144",
            "pin_icon": "http:\/\/static.munzee.com\/images\/pins\/munzee.png"
        },
        {
            "munzee_id": "17848506",
            "friendly_name": "AH Birdie 23",
            "capture_type_id": "0",
            "code": "\/m\/9key\/804\/",
            "munzee_logo": null,
            "distance": "0.04656",
            "pin_icon": "http:\/\/static.munzee.com\/images\/pins\/munzee.png"
        },
        {
            "munzee_id": "17827163",
            "friendly_name": "Arbor Hills Ruby",
            "capture_type_id": "131",
            "code": "\/m\/9key\/736\/",
            "munzee_logo": "http:\/\/static.munzee.com\/images\/pins\/ruby.png",
            "distance": "0.05150",
            "pin_icon": "http:\/\/static.munzee.com\/images\/pins\/ruby.png"
        },
        {
            "munzee_id": "6641981",
            "friendly_name": "Roaming Arbor Hills #21",
            "capture_type_id": "0",
            "code": "\/m\/theroamingitinerant\/28\/",
            "munzee_logo": null,
            "distance": "0.08312",
            "pin_icon": "http:\/\/static.munzee.com\/images\/pins\/munzee.png"
        },
        {
            "munzee_id": "17827196",
            "friendly_name": "Arbor Hills 1",
            "capture_type_id": "0",
            "code": "\/m\/9key\/737\/",
            "munzee_logo": null,
            "distance": "0.09661",
            "pin_icon": "http:\/\/static.munzee.com\/images\/pins\/munzee.png"
        }
    ]
  }
}

HTTP Request

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

Parameters

Parameter Description
munzee_id The ID of the munzee to retrieve
closest 0 or 1 if closest munzee data should be included (1 by default)

Get a Munzee by URL

curl "https://api.munzee.com/munzee/" \
  -H "Authorization: BEARER-TOKEN" \
  -F 'data={"url":"/m/snicker/13/", "closest":0}'

The above command returns JSON structured exactly like getting it by id.

This endpoint retrieves a specific munzee.

HTTP Request

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

Parameters

Parameter Description
url The URL of the munzee to retrieve
closest 0 or 1 if closest munzee data should be included (1 by default)

Get Latest Logs

curl "https://api.munzee.com/munzee/logs/" \
  -H "Authorization: BEARER-TOKEN" \
  -F 'data={"munzee_id":12345}'

The above command returns JSON structured like this:

{
  "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 the latest captures and entries for a specific munzee.

HTTP Request

POST https://api.munzee.com/munzee/logs/

Parameters

Parameter Description
munzee_id munzee ID

Create Entry

curl "https://api.munzee.com/munzee/entries/new/" \
  -H "Authorization: BEARER-TOKEN" \
  -F 'data={"munzee_id":12345,"type_id":1,"notes":"test test"}'

The above command returns JSON structured like this:

{
  "data": {
    "created": 1,
    "result": "A journal entry has been made and will show up on the Munzee creator's feed."
  }
}

Create a journal entry for a specific munzee.

HTTP Request

POST https://api.munzee.com/munzee/entries/new/

Parameters

Parameter Description
munzee_id munzee ID
type_id entry type ID (see entry types)
notes entry text

Has User Captured

curl "https://api.munzee.com/munzee/hascaptured/" \
  -H "Authorization: BEARER-TOKEN" \
  -F 'data={"munzee_ids":"645133,300989, 695468"}'

The above command returns JSON structured like this:

{
  "data": {
    "300989": 0,
    "645133": 1,
    "695468": 0
  }
}

Returns if the authenticated user has captured the munzee or not.

HTTP Request

POST https://api.munzee.com/munzee/hascaptured/

Parameters

Parameter Description
munzee_ids munzee IDs

Players

Get Current Player

curl "https://api.munzee.com/user/current" \
  -H "Authorization: BEARER-TOKEN"

The above command returns JSON structured like this:

{
  "data": {
    "username": "coolant",
    "user_id": 9,
    "avatar": "http:\/\/static.munzee.com\/images\/avatars\/ua9.png",
    "number_of_captures": 16575,
    "number_of_deployments": 93,
    "number_of_undeployments": 496,
    "number_of_archived": 163,
    "number_of_badges": 47,
    "hash": "37c0ec8e8e83bb7cce4d8a5b3f5c7213",
    "premium": 1,
    "level": 104,
    "rank": 624,
    "points": 276811,
    "join_time": "2011-04-10T23:11:33-05:00",
    "days_old": 1459,
    "premium_expires": "Jul 2, 2022",
    "clan": {
      "id": 1,
      "name": "Munzee HQ",
      "url": "\/clans\/munzeehq\/",
      "logo": "http:\/\/static.munzee.com\/images\/clan_logos\/1.png",
      "rank": 214,
      "total_clans": 591
    }
  }
}

HTTP Request

GET https://api.munzee.com/user/current

Get Player By Name

curl "https://api.munzee.com/user/" \
  -H "Authorization: BEARER-TOKEN" \
  -F 'data={"username":"coolant"}'

The above command returns JSON structured like this:

{
  "data": {
    "username": "coolant",
    "user_id": 9,
    "avatar": "http:\/\/static.munzee.com\/images\/avatars\/ua9.png",
    "number_of_captures": 16575,
    "number_of_deployments": 93,
    "number_of_undeployments": 496,
    "number_of_archived": 163,
    "number_of_badges": 47,
    "hash": "37c0ec8e8e83bb7cce4d8a5b3f5c7213",
    "premium": 1,
    "level": 104,
    "rank": 624,
    "points": 276811,
    "join_time": "2011-04-10T23:11:33-05:00",
    "days_old": 1459,
    "premium_expires": "Jul 2, 2022",
    "clan": {
      "id": 1,
      "name": "Munzee HQ",
      "url": "\/clans\/munzeehq\/",
      "logo": "http:\/\/static.munzee.com\/images\/clan_logos\/1.png",
      "rank": 214,
      "total_clans": 591
    }
  }
}

HTTP Request

POST https://api.munzee.com/user/

Parameters

Parameter Description
username the username of the person you want to get

Get Player By ID

curl "https://api.munzee.com/user/" \
  -H "Authorization: BEARER-TOKEN" \
  -F 'data={"user_id":9}'

The above command returns JSON structured exactly like getting it by name.

HTTP Request

POST https://api.munzee.com/user/

Parameters

Parameter Description
user_id the ID of the person you want to get

Get Daily Player Stats

curl "https://api.munzee.com/statzee/player/day/" \
  -H "Authorization: BEARER-TOKEN" \
  -F 'data={"day":"2015-04-02"}'

The above command returns JSON structured like this:

{
  "data": {
    "captures": [ ],
    "captures_on": [
    {
      "captured_at": "2015-04-02T01:47:11-05:00",
      "points_for_creator": "0",
      "points": "0",
      "code": "227",
      "friendly_name": "Scott's AWESOME Social Munzee!",
      "capture_type_id": "32",
      "username": "supersilli",
      "pin": "http:\/\/static.munzee.com\/images\/pins\/social.png"
    },
    {
      "captured_at": "2015-04-02T13:55:04-05:00",
      "points_for_creator": "0",
      "points": "0",
      "code": "438",
      "friendly_name": "Atta' Boy, Scott!",
      "capture_type_id": "32",
      "username": "MoraM85",
      "pin": "http:\/\/static.munzee.com\/images\/pins\/social.png"
    }
  ],
  "deploys": [ ],
  "archived": [ ],
  "total_points": 276811,
  "level": 104
  }
}

HTTP Request

POST https://api.munzee.com/statzee/player/day/

Parameters

Parameter Description
day date (YYYY-MM-DD)

Get Captured Types Stats

curl "https://api.munzee.com/statzee/player/captures/types/" \
  -H "Authorization: BEARER-TOKEN" \
  -F 'data={"username":"coolant"}'

The above command returns JSON structured like this:

{
  "data": {
    "types": [
      {
        "captures": "10",
        "points": "50",
        "average": "5.0000",
        "capture_type_id": "171",
        "name": "Hotel Room"
      },
      {
        "captures": "2",
        "points": "10",
        "average": "5.0000",
        "capture_type_id": "0",
        "name": "Standard"
      },
      {
        "captures": "1",
        "points": "10",
        "average": "10.0000",
        "capture_type_id": "170",
        "name": "Hotel Munzee"
      },
      {
        "captures": "1",
        "points": "0",
        "average": "0.0000",
        "capture_type_id": "32",
        "name": "Social"
      }
    ],
    "total_points": 70
  }
}

HTTP Request

POST https://api.munzee.com/statzee/player/captures/types/

Parameters

Parameter Description
username player name

Get Deployed Types Stats

curl "https://api.munzee.com/statzee/player/deploys/types/" \
  -H "Authorization: BEARER-TOKEN" \
  -F 'data={"username":"coolant"}'

The above command returns JSON structured like this:

{
  "data": {
    "types": [
      {
        "munzees": "45",
        "points": "185",
        "capture_type_id": "0",
        "name": "Normal Munzee",
        "captures": "217",
        "cap_on_points": "703",
        "combined_points": 888
      },
      {
        "munzees": "23",
        "points": "125",
        "capture_type_id": "3",
        "name": "Virtual Munzee",
        "captures": "129",
        "cap_on_points": "399",
        "combined_points": 524
      },
      {
        "munzees": "4",
        "points": "200",
        "capture_type_id": "40",
        "name": "Diamond Munzee",
        "captures": "33",
        "cap_on_points": "243",
        "combined_points": 443
      },
      {
        "munzees": "14",
        "points": "135",
        "capture_type_id": "1",
        "name": "Mystery Munzee",
        "captures": "77",
        "cap_on_points": "243",
        "combined_points": 378
      }
    ],
    "total_points": 2345
  }
}

HTTP Request

POST https://api.munzee.com/statzee/player/deploys/types/

Parameters

Parameter Description
username player name

Get Capture Days Stats

curl "https://api.munzee.com/statzee/player/captures/" \
  -H "Authorization: BEARER-TOKEN" \
  -F 'data={"username":"coolant"}'

Number of munzees captured per day for a specific player.

The above command returns JSON structured like this:

{
  "data": {
    "2011-07-08": 1,
    "2011-07-30": 1,
    "2011-08-07": 1,
    "2011-08-15": 1,
    "2011-10-02": 1,
    "2011-10-11": 2,
    "2011-10-15": 1,
    "2011-10-16": 1,
    "2011-10-24": 1,
    "2011-10-25": 1,
    "2011-10-27": 1,
    "2011-10-29": 2,
    "2011-10-30": 3,
    "2011-11-06": 8,
    "2011-11-23": 1
  }
}

HTTP Request

POST https://api.munzee.com/statzee/player/captures/

Parameters

Parameter Description
username player name

Get Deploy Days Stats

curl "https://api.munzee.com/statzee/player/deploys/" \
  -H "Authorization: BEARER-TOKEN" \
  -F 'data={"username":"coolant"}'

Number of munzees deployed per day for a specific player.

The above command returns JSON structured exactly like getting capture days.

HTTP Request

POST https://api.munzee.com/statzee/player/deploys/

Parameters

Parameter Description
username player name

Map

Bounding Box

curl "https://api.munzee.com/map/boundingbox/" \
  -H "Authorization: BEARER-TOKEN" \
  -F 'data={"exclude":"own","limit":3,"fields":"munzee_id,friendly_name,latitude,longitude,original_pin_image,proximity_radius_ft,creator_username", "points":{"box1":{"timestamp": 1304554511,"lat2":50.85229979649992,"lng1":12.919996137208939,"lng2":12.92009802365303,"lat1":50.84729979649992}}}'

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.

The above command returns JSON structured like this:

{
  "data": [
    {
      "key": "box1",
      "munzees": [
        {
          "munzee_id": "830366",
          "friendly_name": "Schönherrpark #3",
          "latitude": "50.8497691154465",
          "longitude": "12.9200291633602",
          "original_pin_image": "http://static.munzee.com/images/pins/munzee.png",
          "proximity_radius_ft": 50,
          "creator_username": "BHaus"
        },
        {
          "munzee_id": "830432",
          "friendly_name": "Schönherrpark #2",
          "latitude": "50.849177",
          "longitude": "12.92005",
          "original_pin_image": "http://static.munzee.com/images/pins/munzee.png",
          "proximity_radius_ft": 50,
          "creator_username": "BHaus"
        },
        {
          "munzee_id": "138713",
          "friendly_name": "Im Schönherrpark",
          "latitude": "50.849403",
          "longitude": "12.920053",
          "original_pin_image": "http://static.munzee.com/images/pins/munzee.png",
          "proximity_radius_ft": 50,
          "creator_username": "dafi87"
        }
      ],
      "last_updated_at": 1414754711,
      "count": 3
    }
  ]
}

HTTP Request

POST https://api.munzee.com/map/boundingbox/

Parameters

Parameter Description
exclude comma separated list of munzees status types that will be exluded
options: own, captured, maintenance
fields comma separated list of data fields for a munzee
See the list of available data fields
limit limit the number of munzees per box (optional, max number per box is 1000)
points JSON encoded list of named bounding boxes to request. See table below for parameters.

Bounding Box Parameters

Parameter Description
lat1 first corner
lng1 first corner
lat2 second corner
lng2 second corner
timestamp only include munzees that were last updated after the specified timestamp (use 0 to make sure to get all)

Clan

Get Clan ID

curl "https://api.munzee.com/clan/id/" \
  -H "Authorization: BEARER-TOKEN" \
  -F 'data={"simple_name":"munzeehq"}'

The above command returns JSON structured like this:

{
  "data": {
    "clan_id": 1
  }
}

Convert a clan’s simple name into the correcponsing clan ID needed for other requests.

HTTP Request

POST https://api.munzee.com/clan/id/

Parameters

Parameter Description
simple_name the clan’s simple name

Get Clan Details

curl "https://api.munzee.com/clan/" \
  -H "Authorization: BEARER-TOKEN" \
  -F 'data={"clan_id":1}'

The above command returns JSON structured like this:

{
  "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.

HTTP Request

POST https://api.munzee.com/clan/

Parameters

Parameter Description
clan_id clan ID

Get Clan Statistics

curl "https://api.munzee.com/clan/stats/" \
  -H "Authorization: BEARER-TOKEN" \
  -F 'data={"clan_id":11}'

The above command returns JSON structured like this:

{
  "data": {
    "deploy": {
      "dafi87": 2100,
      "h0tdog": 675
    },
    "capture": {
      "dafi87": 1,
      "h0tdog": 2481
    },
    "capture_on": {
      "dafi87": 304,
      "h0tdog": 18
    },
    "total": {
      "dafi87": 2405,
      "h0tdog": 3174
    },
    "number of greenies captured": {
      "Flogni": 2
    },
    "total distance of rovers transported": {
      "dafi87": 54
    },
    "number of deployed": {
      "dafi87": 156,
      "h0tdog": 63
    }
  }
}

Get current statistics for a specific clan.

HTTP Request

POST https://api.munzee.com/clan/stats/

Parameters

Parameter Description
clan_id clan ID

Leaderboards

Global

curl "https://api.munzee.com/leaderboard/players/overall/" \
  -H "Authorization: BEARER-TOKEN" \
  -F 'data={"limit":10}'

The above command returns JSON structured like this:

{
  "data": [
    {
      "user_id": "79501",
      "username": "pilsleyguy",
      "score": "4485945",
      "global_rank": 1,
      "hash": "e14fc5c138262ef08cac99131793c800",
      "user_image": "http:\/\/www.gravatar.com\/avatar\/e14fc5c138262ef08cac99131793c800?d=http%3A%2F%2Fstatic.munzee.com%2Fimages%2Fsite%2Fblank-avatar.png&s=65",
      "level": 122,
      "number_of_first_to_captured": 2321,
      "number_of_captured": 135560,
      "number_of_deployed": 3350,
      "number_of_special_munzees_captured": 122599
    },
    {
      "user_id": "55761",
      "username": "arts5",
      "score": "3536012",
      "global_rank": 2,
      "hash": "a1dee92a51b87ab00410936ea75baf0b",
      "user_image": "http:\/\/www.gravatar.com\/avatar\/a1dee92a51b87ab00410936ea75baf0b?d=http%3A%2F%2Fstatic.munzee.com%2Fimages%2Fsite%2Fblank-avatar.png&s=65",
      "level": 121,
      "number_of_first_to_captured": 1284,
      "number_of_captured": 54658,
      "number_of_deployed": 2778,
      "number_of_special_munzees_captured": 51829
    }
  ]
}

Gets the overall leaderboard

HTTP Request

POST https://api.munzee.com/leaderboard/players/overall/

Parameters

Parameter Description
limit number of players

Get For Range

curl "https://api.munzee.com/leaderboard/players/" \
  -H "Authorization: BEARER-TOKEN" \
  -F 'data={"start":"2015-04-01","end":"2015-04-05","limit":3}'

The above command returns JSON structured like this:

{
  "data": [
    {
      "userid": 4437,
      "username": "Georiffles",
      "score_in_range": "101,058",
      "hash": "c7bd67d1a5ba68ba971fe14b861384f9"
    },
    {
      "userid": 51618,
      "username": "alohakas",
      "score_in_range": "99,121",
      "hash": "e74ce84dd5bdd349207f48e20ef73e32"
    },
    {
      "userid": 173704,
      "username": "mrsg9064",
      "score_in_range": "97,673",
      "hash": "20bc7124032f38446a1c170dc80cdf57"
    }
  ]
}

Gets the leaderboard for a specific date range

HTTP Request

POST https://api.munzee.com/leaderboard/players/

Parameters

Parameter Description
start start date (YYYY-MM-DD)
end end date (YYYY-MM-DD)
limit number of players

Capture

Capture A Munzee

curl "https://api.munzee.com/capture/light/" \
  -H "Authorization: BEARER-TOKEN" \
  -F 'data={"language":"EN","latitude":50.67587352,"longitude":12.3747593,"code":"https://www.munzee.com/m/useruser/999/W20CWW/","time":1429261132,"accuracy":6}'

The above command returns JSON structured like this:

{
  "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.

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)

Lists

Available Data Fields for Munzees

Data Field Description
munzee_id unique munzee ID
friendly_name munzee name
notes munzee notes
creator_user_id munzee owner user ID
creator_username munzee owner username
number_of_captures the number of captures on that munzee
has_user_captured_munzee 0 or 1 (for the authenticated user)
owned_by_user 0 or 1 (for the authenticated user)
maintenance 0 or 1 if munzee is in maintenance mode
latitude location
longitude location
deployed 0 or 1
deployed_at when the munzee got deployed
archived 0 or 1
last_captured_at when the munzee was captured last
original_pin_image munzee pin image URI
proximity_radius_ft radius of the proximity circle for a specific munzee and user combination
last_updated_at when the munzee was updated for the last time
capture_type_id the type ID (see list of munzee types)
is_virtual 0 or 1 if it’s a virtual munzee type
code the URL to the munzee’s details page
special_good_until unix timestamp of the expiration date of a hosted special, if any
rovers a list of rovers that are currently at the munzee

Munzee Types

ID Type
0 Normal Munzee
2 Business Munzee
3 Virtual Munzee
4 Premium Munzee
6 NFC Munzee
32 Social Munzee
40 Diamond Munzee
52 Mace Munzee
53 Longsword Munzee
70 Motel Munzee
71 Motel Room
76 Mustache
80 Mystery Virtual
103 Virtual Red
104 Virtual Orange
105 Virtual Yellow
106 Virtual Green
107 Virtual Blue
108 Virtual Indigo
109 Virtual Violet
110 Virtual Black
111 Virtual Brown
112 Virtual Rainbow
113 Virtual Mystery Red
114 Virtual Mystery Orange
115 Virtual Mystery Yellow
116 Virtual Mystery Green
117 Virtual Mystery Indigo
118 Virtual Mystery Violet
119 Virtual Mystery Black
120 Virtual Mystery Brown
121 Virtual Mystery Rainbow
123 RMH Virtual
131 Ruby Munzee
140 Battle Axe Munzee
146 Ice Bucket
148 Virtual Emerald
170 Hotel Munzee
171 Hotel Room
190 Trail Munzee
196 2015 Heart yellow
197 2015 Heart green
198 2015 Heart orange
199 2015 Heart pink
200 Personal Munzee
218 Aquamarine
220 Sillyman
242 Topaz
250 Accessibility Munzee
280 Mystery
290 Virtual Amethyst
294 Event Indicator
306 The Hammer
307 Virtual Mystery Pink
308 Scorpio
312 Sagittarius
313 Capricorn
314 Aquarius
315 Pisces
316 Aries
317 Taurus
318 Gemini
319 Cancer
320 Leo
321 Virgo
322 Libra
353 Flat Rob
390 Virtual Trail
400 Surprise Munzee
440 Virtual Shamrock
441 Shamrock
444 Prize Wheel Munzee
470 Virtual Resort
471 Virtual Resort Room
500 Scatter Munzee
505 The Unicorn
508 Leprechaun
510 Munzee Madness Reseller
511 GeoStuff Reseller
512 GeoHobbies Reseller
513 DDCards Reseller
514 NEGS Reseller
515 GeoLoggers Reseller
516 MM Cocoa Beach Reseller
521 Nomad Mystery
522 Rock Paper Scissors
532 Fire Mystery
536 MVM White
537 MVM Black
538 MVM Blue
539 MVM Brown
540 MVM Dark Green
541 MVM Green
542 MVM Indigo
543 MVM Light Blue
544 MVM Orange
545 MVM Pink
546 MVM Purple
547 MVM Rainbow
548 MVM Red
549 MVM Yellow
550 Ruja Reseller
573 Dragon
584 Pink Diamond
600 Event Trail
601 Laupe Reseller
658 Tomato
659 Ear of Corn
660 Carrot
661 Peas
678 Golden Carrot
681 Virtual Sapphire
682 TX Historical Location
684 Milk
685 Bacon
686 BCA Garden
687 BCA Pin
696 SCGS Reseller
702 Championship Horse
703 Eggs

Available Languages

Language
EN
DE
ES
FI
FR
HU
NL
DK

Entry Types

Type ID description can be created
1 General Comment yes
2 Found It no
3 Unable to Locate yes
4 Needs Repair yes
5 Report a Violation no
6 Verified no