Stream Colocation Data from the Equinix API

The Streaming API supports creating a subscription to enable retrieving your data from the Equinix API.

Prerequisites

• Submit your user credentials, Client ID, and Client Secret for OAuth2 authentication. Refer to API Authentication for more information on how to authenticate your requests to the Equinix API.

• Create a Subscription. Send a POST request to the /smartview/v2/streaming/subscriptions endpoint and specify the channelType as REST. The Location header in the response contains the subscription ID required to consume the real-time feed. For more information, see Creating a Subscription.

Retrieving the Data

To retrieve your REST streaming channel messages, send a GET request to the smartview/v2/streaming/subscriptionData/{subscriptionId} endpoint.

Sample cURL Request:

curl -X   
GET 'https://api.equinix.com/smartview/v2/streaming/subscriptionData/0f6bdb36-e130-4924-b038-ee1785fad999'

Sample Response:

{  
    "alarmMessageData": [],  
    "alertMessageData": [],  
    "environmentMessageData": [],  
    "meteredPowerMessageData": [],  
    "powerMessageData": [  
        {  
            "type": "power",  
            "data": {  
                "streamId": "20409808",  
                "ibx": "LD9",  
                "asset": {  
                    "id": "20409808",  
                    "type": "CIRCUIT"  
                },  
                "cage": "LD9:0G:0Z10BB",  
                "cabinet": "LD9:0G:0Z10BB:0109",  
                "accountNumber": "116710",  
                "description": "32-amp 230v Single Phase Primary AC Power",  
                "oid": "1.3.6.1.2.1.299.36.10.4442",  
                "realPower": {  
                    "value": "0.000",  
                    "unit": "kW"  
                },  
                "apparentPower": {  
                    "value": "0.000",  
                    "unit": "kVA"  
                },  
                "current": {  
                    "value": "0.000",  
                    "unit": "A"  
                },  
                "powerFactor": {  
                    "value": "0.000",  
                    "unit": "pf"  
                },  
                "soldCurrent": {  
                    "value": "32.000",  
                    "unit": "A"  
                },  
                "soldPower": {  
                    "value": "7.360",  
                    "unit": "kVA"  
                },  
                "powerConsumptionToContractual": {  
                    "value": "0.000",  
                    "unit": "PERCENT"  
                },  
                "peakLastSevenDays": {  
                    "value": "0.000",  
                    "unit": "kVA"  
                },  
                "peakLastSevenDaysRatio": {  
                    "value": "0.000",  
                    "unit": "PERCENT"  
                },  
                "peakLastSevenDaysContractualPower": {  
                    "value": "7.360",  
                    "unit": "kVA"  
                },  
                "peakLastSevenDaysTime": "2023-12-06T05:45:00",  
                "lastUpdated": "2023-12-07T15:49:00",  
                "readingTime": "2023-12-07T15:45:00"  
            }  
        },  
        {  
            "type": "power",  
            "data": {  
                "streamId": "20409809",  
                "ibx": "LD9",  
                "asset": {  
                    "id": "20409809",  
                    "type": "CIRCUIT"  
                },  
                "cage": "LD9:0G:0Z10BB",  
                "cabinet": "LD9:0G:0Z10BB:0109",  
                "accountNumber": "116710",  
                "description": "32-amp 230v Single Phase Redundant AC Power",  
                "oid": "1.3.6.1.2.1.299.36.10.4443",  
                "realPower": {  
                    "value": "0.000",  
                    "unit": "kW"  
                },  
                "apparentPower": {  
                    "value": "0.000",  
                    "unit": "kVA"  
                },  
                "current": {  
                    "value": "0.000",  
                    "unit": "A"  
                },  
                "powerFactor": {  
                    "value": "0.000",  
                    "unit": "pf"  
                },  
                "soldCurrent": {  
                    "value": "32.000",  
                    "unit": "A"  
                },  
                "soldPower": {  
                    "value": "7.360",  
                    "unit": "kVA"  
                },  
                "powerConsumptionToContractual": {  
                    "value": "0.000",  
                    "unit": "PERCENT"  
                },  
                "peakLastSevenDays": {  
                    "value": "0.000",  
                    "unit": "kVA"  
                },  
                "peakLastSevenDaysRatio": {  
                    "value": "-1.000",  
                    "unit": "PERCENT"  
                },  
                "peakLastSevenDaysContractualPower": {  
                    "value": "0.000",  
                    "unit": "kVA"  
                },  
                "peakLastSevenDaysTime": "2023-12-06T22:15:00",  
                "lastUpdated": "2023-12-07T15:49:00",  
                "readingTime": "2023-12-07T15:45:00"  
            }  
        }  
    ],  
    "tagPointMessageData": [],  
    "pagination": {  
        "offset": 0,  
        "limit": 250,  
        "total": 46,  
        "next": null,  
        "previous": "?offset=0&limit=250"  
    }  
}