RTB API

Using merchenta.io for real-time bidding

User Agent metadata 

The endpoints detailed below provides information on the User Agents that visit a publisher’s websites. All the information available under these services is useful for setting up inventory during campaign setup. Every single visitor on the publisher’s page has his own User Agent entry which is always in the same format. However, this UA is not very easy to read by a human, e.g.

Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/37.0.2062.120 Safari/537.36

As each day lots of new User Agent entries appear, we provide endpoints below to allow easy access.

Due to the validation in device targeting settings only information got from these services is allowed.

Operating systems list 

Gets the list of supported operating systems.

/v3/metadata/os
  • Curl
  • Copy
    curl -i \ -X GET \ -H 'Authorization: Bearer {YOUR_TOKEN_HERE}' \ https://sandbox.rtbapi.io/v3/metadata/os
  • Response  200
  • Headers
    Content-Type: application/json
    Schema
    {
        "type": "array",
        "items": {
            "type": "object",
            "properties": {
                "osName": {
                    "type": "string"
                },
                "osFamily": {
                    "type": "string"
                },
                "osMajorVersion": {
                    "type": "string",
                    "required": false
                },
                "osMinorVersion": {
                    "type": "string",
                    "required": false
                }
            }
        }
    }
    
    Example body
    {
        "status": "success",
        "data": {
            "oses": [
                {
                    "osName": "Mac OS X Mavericks (10.9)",
                    "osFamily": "Mac OS X",
                    "osMajorVersion": "10",
                    "osMinorVersion": "9"
                },
                {
                    "osName": "Windows 8",
                    "osFamily": "Windows 8"
                }
            ]
        }
    }

Browsers list 

Gets the list of supported browsers.

/v3/metadata/browsers
  • Curl
  • Copy
    curl -i \ -X GET \ -H 'Authorization: Bearer {YOUR_TOKEN_HERE}' \ https://sandbox.rtbapi.io/v3/metadata/browsers
  • Response  200
  • Headers
    Content-Type: application/json
    Schema
    {
        "type": "array",
        "items": {
            "type": "object",
            "properties": {
                "browserName": {
                    "type": "string"
                },
                "browserFamily": {
                    "type": "string"
                },
                "browserMajorVersion": {
                    "type": "string",
                    "required": false
                },
                "browserMinorVersion": {
                    "type": "string",
                    "required": false
                }
            }
        }
    }
    
    Example body
    {
        "status": "success",
        "data": {
            "browsers": [
                {
                    "browserName": "Chrome 31",
                    "browserFamily": "Chrome",
                    "browserMajorVersion": "31"
                },
                {
                    "browserName": "Firefox 25",
                    "browserFamily": "Firefox",
                    "browserMajorVersion": "25"
                }
            ]
        }
    }

Devices list 

Gets the list of supported devices.

/v3/metadata/devices
  • Curl
  • Copy
    curl -i \ -X GET \ -H 'Authorization: Bearer {YOUR_TOKEN_HERE}' \ https://sandbox.rtbapi.io/v3/metadata/devices
  • Response  200
  • Headers
    Content-Type: application/json
    Schema
    {
        "type": "array",
        "items": {
            "type": "object",
            "properties": {
                "deviceName": {
                    "type": "string"
                },
                "deviceFamily": {
                    "type": "string"
                },
                "deviceMajorVersion": {
                    "type": "string",
                    "required": false
                },
                "deviceMinorVersion": {
                    "type": "string",
                    "required": false
                }
            }
        }
    }
    
    Example body
    {
        "status": "success",
        "data": {
            "devices": [
                {
                    "deviceName": "Kindle Fire HD 8.9\" 4G",
                    "deviceFamily": "Kindle Fire HD 8.9\" 4G"
                },
                {
                    "deviceName": "Lenovo",
                    "deviceFamily": "Lenovo.*"
                }
            ]
        }
    }

Device nested list 

Get the list of nested objects of devices, operating systems and browsers

/v3/metadata/device-os-browser
  • Curl
  • Copy
    curl -i \ -X GET \ -H 'Authorization: Bearer {YOUR_TOKEN_HERE}' \ https://sandbox.rtbapi.io/v3/metadata/device-os-browser
  • Response  200
  • Headers
    Content-Type: application/json
    Example body
    {
          "status": "success",
          "data": {
            "devices": [
              {
                "device": {
                  "deviceName": "MOBILE",
                  "deviceFamily": "MOBILE"
                },
                "operatingSystems": [
                  {
                    "operatingSystem": {
                      "osName": "Android",
                      "osFamily": "Android"
                    },
                    "browsers": [
                      {
                        "browserName": "Firefox",
                        "browserFamily": "Firefox",
                        "browserMajorVersion": "7",
                        "browserMinorVersion": "7"
                      },
                      {
                        "browserName": "Firefox",
                        "browserFamily": "Firefox",
                        "browserMajorVersion": "8",
                        "browserMinorVersion": "8"
                      }
                    ]
                  }
                ]
              }
            ]
          }
        }
Next page  Previous page