You can return an array of beacon identifiers you are subscribed to on the BeaconsInSpace Marketplace. The identifiers allow you to detect beacon signals in your app.

Example: Get all of my beacon identifiers I'm subscribed to.
GET /v1/beacon?
key= 'Your API Key
{
    "code": 200,
    "message": "Success",
    "data": [
        {
            "protocol": "ibeacon",
            "uuid": "99259a46-a024-11e5-8994-feff819cdc9f"
        }
    ]
}
    
This route will return detailed place information and your Capsules on an individual beacon. You can create some cool things by plugging this data into other APIs.

Example: Get place data about a beacon region a user of my app just entered.
GET /v1/beacon?
key= 'Your API Key'
uuid= '99259a46-a024-11e5-8994-feff819cdc9f'
major= '2434'
minor= '2'
createdAt= '1459781305.548'
{
    "code": 200,
    "message": "Success",
    "data": {
        "beaconId": "beaconjR",
        "protocol": "ibeacon",
        "establishment": "Foley's Tavern",
        "establishmentType": "restaurant",
        "touchpoint": "Bar",
        "touchpointType": [
            "Social",
            "Comedy",
            "Food and Dining",
            "Restaurants",
            "Irish",
            "International"
        ],
        "verticalPosition": "1st Floor",
        "website": "https:\/\/www.beaconsinspace.com",
        "tel": "(617) 299-1311",
        "email": "contact@beaconsinspace.com",
        "hoursDisplay": "Mon-Fri 12:00 AM-2:00 AM, 4:00 PM-11:59 PM; Sat-Sun 12:00 AM-2:00 AM, 5:00 PM-11:59 PM",
        "hours": {
            "monday": [
                [
                    "00:00",
                    "2:00"
                ],
                [
                    "16:00",
                    "23:59"
                ]
            ],
            "tuesday": [
                [
                    "00:00",
                    "2:00"
                ],
                [
                    "16:00",
                    "23:59"
                ]
            ],
            "wednesday": [
                [
                    "00:00",
                    "2:00"
                ],
                [
                    "16:00",
                    "23:59"
                ]
            ],
            "thursday": [
                [
                    "00:00",
                    "2:00"
                ],
                [
                    "16:00",
                    "23:59"
                ]
            ],
            "friday": [
                [
                    "00:00",
                    "2:00"
                ],
                [
                    "16:00",
                    "23:59"
                ]
            ],
            "saturday": [
                [
                    "00:00",
                    "2:00"
                ],
                [
                    "17:00",
                    "23:59"
                ]
            ],
            "sunday": [
                [
                    "00:00",
                    "2:00"
                ],
                [
                    "17:00",
                    "23:59"
                ]
            ]
        },
        "hoursToday": [
            [
                "00:00",
                "2:00"
            ],
            [
                "16:00",
                "23:59"
            ]
        ],
        "isOpen": 0,
        "street": "100 Foghladha Street",
        "city": "Boston",
        "state": "MA",
        "zip": "02111",
        "country": "USA",
        "timezone": "America\/New_York",
        "latitude": 42.3514653,
        "longitude": -71.0601767,
        "capsules": [
            {
                "capsuleId": "capsulep2",
                "capsule": "Hello World!",
                "dataType": "TEXT"
            },
            {
                "capsuleId": "capsuleq2",
                "capsule": "Augment places everywhere!",
                "dataType": "TEXT"
            }
        ]
    }
}
    
Capsules are the best way for you to augment places in the real world with your own information. You should think about a Capsule as your own custom meta-data that can be triggered when your app enters a beacon region.

Example: Add a capsule containing the text "Hello World!" to all restaurant beacons in Boston.
POST /v1/capsule?
key= 'Your API Key' 
capsule= 'Hello World!'
establishmentType= 'Restaurant'
city= 'Boston'
state= 'MA'
{
    "code": 200,
    "message": "Success",
    "data": {
        "capsuleId": "capsulewR"
    }
}
    
You can send and store user events like when a user enters and exits a beacon region. Events can be used to create real-world analytics on your users or as a trigger for webhook integrations you setup in Mission Control.

Example: Send an event every time a user enters a beacon region.
POST /v1/event?
key= 'Your API Key' 
uuid= '99259a46-a024-11e5-8994-feff819cdc9f'
major= '2434'
minor= '2'
userId= 'Your unique user Id'
userIdType= 'Unique user Id Type'
detect= 'Enter'
createdAt= '1459781305.548'
{
    "code": 200,
    "message": "Success",
    "data": {
        "beaconId": "beaconjR",
        "latitude": 42.3514653,
        "longitude": -71.0601767,
        "duration": 0,
        "detect": "enter"
    }
}