Example Request

The following is a valid request to our OpenRTB API using OpenRTB 2.5. For more examples, you can refer to our prebid server tests. See our required fields page to know what data is required for the request to be valid.

{
  "device": {
    "dnt": 0,
    "h": 1120,
    "ip": "98.249.0.0",
    "language": "en",
    "os": "macos",
    "ua": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/85.0.4183.102 Safari/537.36",
    "w": 1792
  },
  "id": "TL3JS6F43CKNDQFY",
  "imp": [
    {
      "banner": {
        "format": [
          {
            "h": 600,
            "w": 300
          }
        ],
        "h": 600,
        "pos": 1,
        "w": 300
      },
      "tagid": "example-ad-unit-id", // this will be available in our reporting as ad unit id
      "id": "1",
      "secure": 1
    }
  ],
  "regs": {
    "ext": {
      "gdpr": 0,
      "us_privacy": "1---"
    }
  },
  "site": {
    "domain": "www.example.com",
    "ext": {
      "amp": 0
    },
    "publisher": {
      // 🎯 IMPORTANT: Replace "YOUR_AMX_TAGID" with your actual tagId.
      // It links this request to your specific publisher account.
      // This unique identifier is provided by us and can be found in your account UI under Tags: https://dashboard.adaptmx.com/tags
      "id": "YOUR_AMX_TAGID"
    },
    "page": "https://www.example.com/es6/es6_objects.htm",
    "ref": "https://www.example.com/es6/es6_objects.htm"
  },
  "source": {
    "ext": {
      "schain": {
        "complete": 1,
        "nodes": [
          {
            "asi": "amxrtb.com",
            "hp": 1,
            "sid": "1234"
          }
        ],
        "ver": "1.0"
      }
    }
  },
  "test": 0,
  "tmax": 300,
  "user": {
    "ext": {
      "eids": [
        {
          "source": "amxid",
          "uids": [
            {
              "atype": 1,
              "id": "88de601e-3d98-48e7-81d7-00000000"
            }
          ]
        },
        {
          "source": "adserver.org",
          "uids": [
            {
              "id": "1234567",
              "ext": {
                "rtiPartner": "TDID"
              }
            }
          ]
        }
      ],
      "gdpr": 0,
      "us_privacy": "1---"
    }
  }
}

OpenRTB 2.6 vs OpenRTB 2.5

There are a few differences with OpenRTB 2.6, mainly:

user.ext.eids replaced with user.eids
source.ext.schain replaced with source.schain
addition of device.sua

{
  "device": {
    "dnt": 0,
    "h": 1120,
    "ip": "98.249.0.0",
    "language": "en",
    "os": "macos",
    "ua": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/85.0.4183.102 Safari/537.36",
    "w": 1792,
    "sua": {
      "platform": {
        "version": ["10", "15", "6"],
        "name": "Mac OS"
      },
      "browsers": [{"name": "safari"}],
      "architecture": "x86"
    }
  },
  "id": "TL3JS6F43CKNDQFY",
  "imp": [
    {
      "banner": {
        "format": [
          {
            "h": 600,
            "w": 300
          }
        ],
        "h": 600,
        "pos": 1,
        "w": 300
      },
      "tagid": "example-ad-unit-id",
      "id": "1",
      "secure": 1
    }
  ],
  "regs": {
    "ext": {
      "gdpr": 0,
      "us_privacy": "1---"
    }
  },
  "site": {
    "domain": "www.example.com",
    "ext": {
      "amp": 0
    },
    "publisher": {
      "id": "adaptmx-tag-id"
    },
    "page": "https://www.example.com",
    "ref": "https://www.example.com"
  },
  "source": {
    "schain": {
      "complete": 1,
      "nodes": [
        {
          "asi": "amxrtb.com",
          "hp": 1,
          "sid": "1234"
        }
      ],
      "ver": "1.0"
    }
  },
  "test": 0,
  "tmax": 300,
  "user": {
    "eids": [
      {
        "source": "amxid",
        "uids": [
          {
            "atype": 1,
            "id": "88de601e-3d98-48e7-81d7-00000000"
          }
        ]
      },
      {
        "source": "adserver.org",
        "uids": [
           {
            "id": "1234567",
            "ext": {
              "rtiPartner": "TDID"
             }
          }
        ]
      }
   ],
   "gdpr": 0,
   "us_privacy": "1---"
  }
}