{"__v":46,"_id":"577e4b4a47a9ab0e003e0092","category":{"__v":26,"_id":"564dcf87d3320b0d0028ca10","pages":["564dcfb4d3320b0d0028ca11","564dd25da8671617004e7b71","564dd3a7e39c4435005a1f33","564ddbcbd3320b0d0028ca25","564ddcb2a8671617004e7b8e","564ddfffa8671617004e7b94","564de165a8671617004e7b97","564de17d9176e9170068007b","564de194e39c4435005a1f56","564de3d99176e9170068007e","564de439fe07a81700b5c3af","564ef3911e9a082b00344ea1","564f03dfedbade0d000efa57","564f0978234efc0d006e186e","564f0d9aaf8ae235002db90e","564f133e4f000617007bd68e","564f14d829338a1700beefcd","564f15619eb2701700532470","564f2fec6b10960d00865761","564f302b6b10960d00865764","564f33e219857f2b00387a44","564f35d110b21d3500ad29d3","564f42e41af2c835004bfbe9","564f456ab85ee335004cbdb3","5652e161b83d8e0d00d24b6b","56859949cfc7cf0d001cb3f5"],"project":"564621e00c30fb2100ba3814","version":"564621e10c30fb2100ba3817","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-11-19T13:32:55.176Z","from_sync":false,"order":6,"slug":"api-overview","title":"Ad Request API"},"parentDoc":null,"project":"564621e00c30fb2100ba3814","user":"5731f40dd720220e008ea18b","version":{"__v":14,"_id":"564621e10c30fb2100ba3817","project":"564621e00c30fb2100ba3814","createdAt":"2015-11-13T17:46:09.275Z","releaseDate":"2015-11-13T17:46:09.275Z","categories":["564621e10c30fb2100ba3818","564624cf0c30fb2100ba3822","564628d69f3f550d00fa3db6","564dafeeda00e82b00ed601d","564daff8fc36dc3700882b95","564db0ccda00e82b00ed601f","564dcf87d3320b0d0028ca10","5661a6e436398e0d00f79566","568585153703ed1700e420b0","56858767d96a760d00545da6","56858d693703ed1700e420b2","56858d8d22c41b0d00e4666c","56859e9c009a8d0d00797130","5685a6453703ed1700e420d3"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-07-07T12:30:02.730Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":1,"body":"The following parameters should be used for any type of ad request: [Banner](http://docs.mobfox.com/docs/banners), [Video](http://docs.mobfox.com/docs/request-videos), [Native](http://docs.mobfox.com/docs/request-native-ads-iab) etc.. It is **highly recommended** to populate them for better results.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Anatomy of an Ad Request\"\n}\n[/block]\nAny ad request can be either a [Banner](http://docs.mobfox.com/docs/banners), [Video](http://docs.mobfox.com/docs/request-videos), [Mraid](http://docs.mobfox.com/docs/request-mraid-banners), [Native](http://docs.mobfox.com/docs/request-native-ads-iab) etc. \n\nFor **any type** of ad you must specify some **mandatory parameters**, like **s=fe96717d9875b9da4339ea223267eff1e** or **i=69.197.148.18**. \n\nThen you have **ad type specific parameters**, like **v_autoplay** for [Video ads](http://docs.mobfox.com/docs/request-videos).\n\nLastly, you also need to populate **global request parameters**, like **o_andadvid=c6292267-56ad-4326-965d-deef6fcd5er9**, in order to get the best chances of being returned a high CPM ad.\n\nThe mandatory request parameters and the ad type specific parameters are listed in their corresponding sections. You then add **global request parameters** to the final GET request.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"http://my.mobfox.com/request.php\\n-------------------- Mandatory Parameters ------------------\\n?rt=api\\n&r_type=video\\n&i=69.197.148.18\\n&s=fe96717d9875b9da4339ea5367eff1ec\\n&u=Mozilla%2F5.0%20(iPhone%3B%20CPU%20iPhone%20OS%208_0%20like%20Mac%20OS%20X)%20AppleWebKit%2F600.1.3%20(KHTML%2C%20like%20Gecko)%20Version%2F8.0%20Mobile%2F12A4345d%20Safari%2F600.1.4\\n-------------------- Video Specific Parameters -------------\\n&r_resp=vast20\\n&v_dur_min=10\\n&v_dur_max=60\\n&v_autoplay=1\\n&v_startmute=1\\n------------------- Global Parameters ----------------------\\n&o_andadvid=c6292267-56ad-4326-965d-deef6fcd5er9\\n&longitude=12.12\\n&latitude=280.12\\n&demo_age=1978\\n&adspace_width=320\\n&adspace_height=480\\n&r_floor=0.8\",\n      \"language\": \"curl\",\n      \"name\": \"Example\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Global Ad Request Parameters\"\n}\n[/block]\nBellow lists all possible **global request parameters** that you can use in your ad requests.\n[block:html]\n{\n  \"html\": \"<style type=\\\"text/css\\\">\\n table.tg { border: none !important; }\\n.tg  {border-collapse:collapse;border-spacing:0;}\\n.tg td{font-family:Arial, sans-serif;font-size:14px;padding:10px 5px;border-style:solid;border-width:1px;overflow:hidden;word-break:normal;}\\n.tg th{font-family:Arial, sans-serif;font-size:14px;font-weight:normal;padding:10px 5px;border-style:solid;border-width:1px;overflow:hidden;word-break:normal;}\\n.tg .tg-jogk{font-style:italic}\\n.tg .tg-9hbo{font-weight:bold}\\n.tg .tg-9hbo{font-weight:bold;vertical-align:top}\\n.tg .tg-yw4l{vertical-align:top}\\n.tg .tg-jogk{font-style:italic;vertical-align:top}\\n.bold-span{font-weight:bold}\\n</style>\\n<table class=\\\"tg\\\">\\n  <tr>\\n    <th class=\\\"tg-9hbo\\\">Parameter Name</th>\\n    <th class=\\\"tg-9hbo\\\">Type</th>\\n    <th class=\\\"tg-9hbo\\\">Default Value</th>\\n    <th class=\\\"tg-9hbo\\\">Sample Value</th>\\n    <th class=\\\"tg-9hbo\\\">Description</th>\\n    <th class=\\\"tg-9hbo\\\">Recommended</th>\\n  </tr>\\n\\n  <tr>\\n    <th class=\\\"tg-9hbo\\\" colspan=\\\"6\\\">Device</th>\\n  </tr>\\n  <tr>\\n    <td class=\\\"tg-9hbo\\\">o_iosadvid</td>\\n    <td class=\\\"tg-yw4l\\\">String</td>\\n    <td class=\\\"tg-9hbo\\\"></td>\\n    <td class=\\\"tg-jogk\\\">1976F519-26D0-4428-9891-3133253A453F</td>\\n    <td class=\\\"tg-yw4l\\\">iOS IFA (available in iOS 6.0+). Apple Advertising ID. Set this parameter to increase your eCPM.</td>\\n    <td class=\\\"tg-9hbo\\\">YES</td>\\n  </tr>  \\n  <tr>\\n    <td class=\\\"tg-9hbo\\\">o_andadvid</td>\\n    <td class=\\\"tg-yw4l\\\">String</td>\\n    <td class=\\\"tg-9hbo\\\"></td>\\n    <td class=\\\"tg-jogk\\\">c6292267-56ad-4326-965d-deef6fcd5er9</td>\\n    <td class=\\\"tg-yw4l\\\">Google Advertising ID. Set this parameter to increase your eCPM.</td>\\n    <td class=\\\"tg-9hbo\\\">YES</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"tg-9hbo\\\">o_androidid</td>\\n    <td class=\\\"tg-yw4l\\\">String</td>\\n    <td class=\\\"tg-9hbo\\\"></td>\\n    <td class=\\\"tg-jogk\\\">13232</td>\\n    <td class=\\\"tg-yw4l\\\">Android ID</td>\\n    <td class=\\\"tg-9hbo\\\"></td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"tg-9hbo\\\">o_androidimei</td>\\n    <td class=\\\"tg-yw4l\\\">String</td>\\n    <td class=\\\"tg-9hbo\\\"></td>\\n    <td class=\\\"tg-jogk\\\">2323-2323-232</td>\\n    <td class=\\\"tg-yw4l\\\">Android Device ID (IMEI)</td>\\n    <td class=\\\"tg-9hbo\\\"></td>\\n  </tr>\\n  \\n  <tr>\\n    <td class=\\\"tg-9hbo\\\">longitude</td>\\n    <td class=\\\"tg-yw4l\\\">Float</td>\\n    <td class=\\\"tg-9hbo\\\"></td>\\n    <td class=\\\"tg-jogk\\\">12.12</td>\\n    <td class=\\\"tg-yw4l\\\">The Users Geo-Location (longitude). Set this parameter to increase your eCPM.</td>\\n    <td class=\\\"tg-9hbo\\\">YES</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"tg-9hbo\\\">latitude</td>\\n    <td class=\\\"tg-yw4l\\\">Float</td>\\n    <td class=\\\"tg-9hbo\\\"></td>\\n    <td class=\\\"tg-jogk\\\">280.12</td>\\n    <td class=\\\"tg-yw4l\\\">The Users Geo-Location (latitude). Set this parameter to increase your eCPM.</td>\\n    <td class=\\\"tg-9hbo\\\">YES</td>\\n  </tr>\\n  \\n  <tr>\\n    <td class=\\\"tg-9hbo\\\">dev_dnt</td>\\n    <td class=\\\"tg-yw4l\\\">Integer</td>\\n    <td class=\\\"tg-9hbo\\\">0</td>\\n    <td class=\\\"tg-jogk\\\">1</td>\\n    <td class=\\\"tg-yw4l\\\">\\n    Specify if \\\"Do not Track\\\" is turned on or off by the browser. This has to be part of your <a href=\\\"https://en.wikipedia.org/wiki/List_of_HTTP_header_field\\\">HTTP Header</a>.\\n      <br/><br/>\\n      You can send this also using the dev_dnt parameter if a HTTP Header does not work for you. But keep in mind that the HTTP Header has priority if it is available.\\n      <br/><br/>\\n      This has to be sent to us at all times when available.\\n      <br/><br/>\\nIf this parameter is missing we assume tracking is allowed. \\n    </td>\\n    <td class=\\\"tg-9hbo\\\">YES</td>\\n  </tr>\\n  \\n  <tr>\\n    <td class=\\\"tg-9hbo\\\">dev_lmt</td>\\n    <td class=\\\"tg-yw4l\\\">Integer</td>\\n    <td class=\\\"tg-9hbo\\\"></td>\\n    <td class=\\\"tg-jogk\\\">1</td>\\n    <td class=\\\"tg-yw4l\\\">\\n    This parameter signals the \\\"Limit Ad Tracking\\\" option the user picked on their device os. When dev_lmt = 1 tracking must be limited per commercial guidelines.\\n      <br/><br/>\\n      This has to be sent to us at all times when available.\\n            <br/><br/>\\nIf this parameter is missing we assume tracking is not limited. \\n    </td>\\n    <td class=\\\"tg-9hbo\\\">YES</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"tg-9hbo\\\">dev_js</td>\\n    <td class=\\\"tg-yw4l\\\">Integer</td>\\n    <td class=\\\"tg-9hbo\\\">1</td>\\n    <td class=\\\"tg-jogk\\\">1</td>\\n    <td class=\\\"tg-yw4l\\\">Indicates if the devices has support for javascript. 1 means yes, 0 means no.</td>\\n    <td class=\\\"tg-yw4l\\\"></td>\\n  </tr>\\n  \\n  \\n  \\n  <tr>\\n    <th class=\\\"tg-9hbo\\\" colspan=\\\"6\\\">Impression</th>\\n  </tr>\\n  <tr>\\n    <td class=\\\"tg-9hbo\\\">adspace_width</td>\\n    <td class=\\\"tg-yw4l\\\">Integer</td>\\n    <td class=\\\"tg-9hbo\\\">320</td>\\n    <td class=\\\"tg-jogk\\\">320</td>\\n    <td class=\\\"tg-yw4l\\\">The Width of your Ad Space. This is also the maximum banner size that our servers will return.<span class=\\\"bold-span\\\"> If not specified, it defaults to 320</span></td>\\n    <td class=\\\"tg-9hbo\\\">YES</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"tg-9hbo\\\">adspace_height</td>\\n    <td class=\\\"tg-yw4l\\\">Integer</td>\\n    <td class=\\\"tg-9hbo\\\">50</td>\\n    <td class=\\\"tg-jogk\\\">480</td>\\n    <td class=\\\"tg-yw4l\\\">The Height of your Ad Space. This is also the maximum banner size that our servers will return.<span class=\\\"bold-span\\\"> If not specified, it defaults to 50</span> </td>\\n    <td class=\\\"tg-9hbo\\\">YES</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"tg-9hbo\\\">adspace_strict</td>\\n    <td class=\\\"tg-yw4l\\\">Integer</td>\\n    <td class=\\\"tg-9hbo\\\">0</td>\\n    <td class=\\\"tg-jogk\\\">1</td>\\n    <td class=\\\"tg-yw4l\\\">If this parameter is set to 1 and an adspace_height and adspace_width are provided, the ad server will only serve ads of these exact dimensions and will not serve any smaller-sized ads. <span class=\\\"bold-span\\\">By default it is set to 0</span>, so the strict constraint is not enforced.</td>\\n    <td class=\\\"tg-9hbo\\\"></td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"tg-9hbo\\\">imp_instl</td>\\n    <td class=\\\"tg-yw4l\\\">Integer</td>\\n    <td class=\\\"tg-9hbo\\\">0</td>\\n    <td class=\\\"tg-jogk\\\">1</td>\\n    <td class=\\\"tg-yw4l\\\">Indicates if the requested ad will be displayed as an interstitial/fullscreen ad. <span class=\\\"bold-span\\\">1</span> means yes, <span class=\\\"bold-span\\\">0</span> means no.</span> </td>\\n    <td class=\\\"tg-9hbo\\\"></td>\\n  </tr>\\n\\n<tr>\\n    <td class=\\\"tg-9hbo\\\">imp_secure</td>\\n    <td class=\\\"tg-yw4l\\\">Integer</td>\\n    <td class=\\\"tg-9hbo\\\">0</td>\\n    <td class=\\\"tg-jogk\\\">1</td>\\n  <td class=\\\"tg-yw4l\\\">Set to <b>1</b> to request secure ads, which only use https:// URLs in src=\\\"\\\" attributes. This setting will enable you to be ATS compliant.</td>\\n    <td class=\\\"tg-9hbo\\\"></td>\\n  </tr>\\n\\n  <tr>\\n    <td class=\\\"tg-9hbo\\\">allow_mr</td>\\n    <td class=\\\"tg-yw4l\\\">Integer</td>\\n    <td class=\\\"tg-9hbo\\\"></td>\\n    <td class=\\\"tg-jogk\\\">1</td>\\n    <td class=\\\"tg-yw4l\\\">Allow 300x250 Medium Rectangle Ad Units to be returned.<span class=\\\"bold-span\\\"> This defaults to 1 for mobile websites, and must be specifically set to 0 when 300x250 ad units should not be shown on mobile websites.</span></td>\\n    <td class=\\\"tg-9hbo\\\"></td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"tg-9hbo\\\">r_floor</td>\\n    <td class=\\\"tg-yw4l\\\">Float</td>\\n    <td class=\\\"tg-9hbo\\\"></td>\\n    <td class=\\\"tg-jogk\\\">0.80</td>\\n    <td class=\\\"tg-yw4l\\\">Pass a CPM floor price for the ad request. Only ads that meet or exceed the given CPM will be returned.</td>\\n    <td class=\\\"tg-9hbo\\\">YES</td>\\n  </tr>\\n\\n\\n  <tr>\\n    <th class=\\\"tg-9hbo\\\" colspan=\\\"6\\\">User Demographics</th>\\n  </tr>\\n  <tr>\\n    <td class=\\\"tg-9hbo\\\">demo_gender</td>\\n    <td class=\\\"tg-yw4l\\\">String</td>\\n    <td class=\\\"tg-9hbo\\\"></td>\\n    <td class=\\\"tg-jogk\\\">female, f, male, m</td>\\n    <td class=\\\"tg-yw4l\\\">The user's gender (male/m or female/f), if available. Set this parameter to increase your eCPM.</td>\\n    <td class=\\\"tg-9hbo\\\">YES</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"tg-9hbo\\\">demo_age</td>\\n    <td class=\\\"tg-yw4l\\\">Integer</td>\\n    <td class=\\\"tg-9hbo\\\"></td>\\n    <td class=\\\"tg-jogk\\\">1990, 27</td>\\n    <td class=\\\"tg-yw4l\\\">The user's year of birth or age, if available. Set this parameter to increase your eCPM.</td>\\n    <td class=\\\"tg-9hbo\\\">YES</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"tg-9hbo\\\">demo_keywords</td>\\n    <td class=\\\"tg-yw4l\\\">String</td>\\n    <td class=\\\"tg-9hbo\\\"></td>\\n    <td class=\\\"tg-jogk\\\">sports, finance, football</td>\\n    <td class=\\\"tg-yw4l\\\">A comma-separated list of keywords. Example: sports, cars, finance, football.</td>\\n    <td class=\\\"tg-9hbo\\\"></td>\\n  </tr>\\n\\n\\n  <tr>\\n    <th class=\\\"tg-9hbo\\\" colspan=\\\"6\\\">Network/Aggregator Parameters</th>\\n  </tr>\\n  <tr>\\n    <td class=\\\"tg-9hbo\\\">s_subid</td>\\n    <td class=\\\"tg-yw4l\\\">String</td>\\n    <td class=\\\"tg-9hbo\\\"></td>\\n    <td class=\\\"tg-jogk\\\">1212_1212</td>\\n    <td class=\\\"tg-yw4l\\\">If you are aggregating traffic for multiple Publishers on a single MobFox Inventory Hash, it is highly recommended you pass a unique ID per Publisher in the API so MobFox can optimise your traffic and achieve better eCPMs.</td>\\n    <td class=\\\"tg-9hbo\\\"></td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"tg-9hbo\\\">sub_name</td>\\n    <td class=\\\"tg-yw4l\\\">String</td>\\n    <td class=\\\"tg-9hbo\\\"></td>\\n    <td class=\\\"tg-jogk\\\">Angry Birds</td>\\n    <td class=\\\"tg-yw4l\\\">You can provide a custom name for the publication, to override the publication name set in your MobFox account. This value will be passed to DSPs as part of the OpenRTB bid request.</td>\\n    <td class=\\\"tg-9hbo\\\">YES</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"tg-9hbo\\\">sub_domain</td>\\n    <td class=\\\"tg-yw4l\\\">String</td>\\n    <td class=\\\"tg-9hbo\\\"></td>\\n    <td class=\\\"tg-jogk\\\">my.appdomain.com</td>\\n    <td class=\\\"tg-yw4l\\\">You can provide a custom domain for the publication, to enable DSPs to identify your app to advertisers. This value will be passed to DSPs as part of the OpenRTB bid request.</td>\\n    <td class=\\\"tg-9hbo\\\">YES</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"tg-9hbo\\\">sub_storeurl</td>\\n    <td class=\\\"tg-yw4l\\\">String</td>\\n    <td class=\\\"tg-9hbo\\\"></td>\\n    <td class=\\\"tg-jogk\\\">http://my.appdomain.com/game</td>\\n    <td class=\\\"tg-yw4l\\\">You can provide an app store url for the publication, or - in absence - a web site url for the publication. This parameter can only be used for downloadable apps, not web sites. This value will be passed to DSPs as part of the OpenRTB bid request.</td>\\n    <td class=\\\"tg-9hbo\\\">YES</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"tg-9hbo\\\">sub_bundle_id</td>\\n    <td class=\\\"tg-yw4l\\\">String</td>\\n    <td class=\\\"tg-9hbo\\\"></td>\\n    <td class=\\\"tg-jogk\\\">2324345</td>\\n    <td class=\\\"tg-yw4l\\\">You can provide your app's bundle id like for example: \\\"com.domain.title\\\" or \\\"3321293\\\"</td>\\n    <td class=\\\"tg-9hbo\\\">YES</td>\\n  </tr>\\n\\n  <tr>\\n    <th class=\\\"tg-9hbo\\\" colspan=\\\"6\\\">Site Parameters</th>\\n  </tr>\\n  <tr>\\n    <td class=\\\"tg-9hbo\\\">p</td>\\n    <td class=\\\"tg-yw4l\\\">String</td>\\n    <td class=\\\"tg-9hbo\\\"></td>\\n    <td class=\\\"tg-jogk\\\"></td>\\n    <td class=\\\"tg-yw4l\\\">On mobile websites, this should be the URL of the page where the ad is being shown. You can leave this parameter blank for mobile apps.</td>\\n    <td class=\\\"tg-9hbo\\\"></td>\\n  </tr>\\n  \\n\\n\\n  <tr>\\n    <th class=\\\"tg-9hbo\\\" colspan=\\\"6\\\">Misc</th>\\n  </tr>\\n  <tr>\\n    <td class=\\\"tg-9hbo\\\">m</td>\\n    <td class=\\\"tg-yw4l\\\">String</td>\\n    <td class=\\\"tg-9hbo\\\">live</td>\\n    <td class=\\\"tg-jogk\\\">live</td>\\n    <td class=\\\"tg-yw4l\\\">If you would like to receive a test-banner, this parameter should be &amp;m=test, otherwise use m=live for real ads.</td>\\n    <td class=\\\"tg-yw4l\\\"></td>\\n  </tr>  \\n</table>\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Recommended parameters for highest eCPMs\",\n  \"body\": \"We recommend passing these parameters on all of your ad requests to get the best eCPM:\\n\\n* adspace_width/adspace_height\\n* r_floor\\n* o_andadvid\\n* o_iosadvid\\n* latitude\\n* longitude\\n* demo_age\\n* demo_gender\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"danger\",\n  \"title\": \"If you are a network/aggregator you must pass us these parameters as well\",\n  \"body\": \"* sub_name\\n* sub_domain\\n* sub_storeurl\\n* sub_bundle_id\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Next Step\"\n}\n[/block]\nMake your first ad request for [Banner](http://docs.mobfox.com/docs/banners), [Video](http://docs.mobfox.com/docs/request-videos) or [Native](http://docs.mobfox.com/docs/request-native-ads-iab).","excerpt":"","slug":"global-request-parameters","type":"basic","title":"Global Request Parameters"}

Global Request Parameters


The following parameters should be used for any type of ad request: [Banner](http://docs.mobfox.com/docs/banners), [Video](http://docs.mobfox.com/docs/request-videos), [Native](http://docs.mobfox.com/docs/request-native-ads-iab) etc.. It is **highly recommended** to populate them for better results. [block:api-header] { "type": "basic", "title": "Anatomy of an Ad Request" } [/block] Any ad request can be either a [Banner](http://docs.mobfox.com/docs/banners), [Video](http://docs.mobfox.com/docs/request-videos), [Mraid](http://docs.mobfox.com/docs/request-mraid-banners), [Native](http://docs.mobfox.com/docs/request-native-ads-iab) etc. For **any type** of ad you must specify some **mandatory parameters**, like **s=fe96717d9875b9da4339ea223267eff1e** or **i=69.197.148.18**. Then you have **ad type specific parameters**, like **v_autoplay** for [Video ads](http://docs.mobfox.com/docs/request-videos). Lastly, you also need to populate **global request parameters**, like **o_andadvid=c6292267-56ad-4326-965d-deef6fcd5er9**, in order to get the best chances of being returned a high CPM ad. The mandatory request parameters and the ad type specific parameters are listed in their corresponding sections. You then add **global request parameters** to the final GET request. [block:code] { "codes": [ { "code": "http://my.mobfox.com/request.php\n-------------------- Mandatory Parameters ------------------\n?rt=api\n&r_type=video\n&i=69.197.148.18\n&s=fe96717d9875b9da4339ea5367eff1ec\n&u=Mozilla%2F5.0%20(iPhone%3B%20CPU%20iPhone%20OS%208_0%20like%20Mac%20OS%20X)%20AppleWebKit%2F600.1.3%20(KHTML%2C%20like%20Gecko)%20Version%2F8.0%20Mobile%2F12A4345d%20Safari%2F600.1.4\n-------------------- Video Specific Parameters -------------\n&r_resp=vast20\n&v_dur_min=10\n&v_dur_max=60\n&v_autoplay=1\n&v_startmute=1\n------------------- Global Parameters ----------------------\n&o_andadvid=c6292267-56ad-4326-965d-deef6fcd5er9\n&longitude=12.12\n&latitude=280.12\n&demo_age=1978\n&adspace_width=320\n&adspace_height=480\n&r_floor=0.8", "language": "curl", "name": "Example" } ] } [/block] [block:api-header] { "type": "basic", "title": "Global Ad Request Parameters" } [/block] Bellow lists all possible **global request parameters** that you can use in your ad requests. [block:html] { "html": "<style type=\"text/css\">\n table.tg { border: none !important; }\n.tg {border-collapse:collapse;border-spacing:0;}\n.tg td{font-family:Arial, sans-serif;font-size:14px;padding:10px 5px;border-style:solid;border-width:1px;overflow:hidden;word-break:normal;}\n.tg th{font-family:Arial, sans-serif;font-size:14px;font-weight:normal;padding:10px 5px;border-style:solid;border-width:1px;overflow:hidden;word-break:normal;}\n.tg .tg-jogk{font-style:italic}\n.tg .tg-9hbo{font-weight:bold}\n.tg .tg-9hbo{font-weight:bold;vertical-align:top}\n.tg .tg-yw4l{vertical-align:top}\n.tg .tg-jogk{font-style:italic;vertical-align:top}\n.bold-span{font-weight:bold}\n</style>\n<table class=\"tg\">\n <tr>\n <th class=\"tg-9hbo\">Parameter Name</th>\n <th class=\"tg-9hbo\">Type</th>\n <th class=\"tg-9hbo\">Default Value</th>\n <th class=\"tg-9hbo\">Sample Value</th>\n <th class=\"tg-9hbo\">Description</th>\n <th class=\"tg-9hbo\">Recommended</th>\n </tr>\n\n <tr>\n <th class=\"tg-9hbo\" colspan=\"6\">Device</th>\n </tr>\n <tr>\n <td class=\"tg-9hbo\">o_iosadvid</td>\n <td class=\"tg-yw4l\">String</td>\n <td class=\"tg-9hbo\"></td>\n <td class=\"tg-jogk\">1976F519-26D0-4428-9891-3133253A453F</td>\n <td class=\"tg-yw4l\">iOS IFA (available in iOS 6.0+). Apple Advertising ID. Set this parameter to increase your eCPM.</td>\n <td class=\"tg-9hbo\">YES</td>\n </tr> \n <tr>\n <td class=\"tg-9hbo\">o_andadvid</td>\n <td class=\"tg-yw4l\">String</td>\n <td class=\"tg-9hbo\"></td>\n <td class=\"tg-jogk\">c6292267-56ad-4326-965d-deef6fcd5er9</td>\n <td class=\"tg-yw4l\">Google Advertising ID. Set this parameter to increase your eCPM.</td>\n <td class=\"tg-9hbo\">YES</td>\n </tr>\n <tr>\n <td class=\"tg-9hbo\">o_androidid</td>\n <td class=\"tg-yw4l\">String</td>\n <td class=\"tg-9hbo\"></td>\n <td class=\"tg-jogk\">13232</td>\n <td class=\"tg-yw4l\">Android ID</td>\n <td class=\"tg-9hbo\"></td>\n </tr>\n <tr>\n <td class=\"tg-9hbo\">o_androidimei</td>\n <td class=\"tg-yw4l\">String</td>\n <td class=\"tg-9hbo\"></td>\n <td class=\"tg-jogk\">2323-2323-232</td>\n <td class=\"tg-yw4l\">Android Device ID (IMEI)</td>\n <td class=\"tg-9hbo\"></td>\n </tr>\n \n <tr>\n <td class=\"tg-9hbo\">longitude</td>\n <td class=\"tg-yw4l\">Float</td>\n <td class=\"tg-9hbo\"></td>\n <td class=\"tg-jogk\">12.12</td>\n <td class=\"tg-yw4l\">The Users Geo-Location (longitude). Set this parameter to increase your eCPM.</td>\n <td class=\"tg-9hbo\">YES</td>\n </tr>\n <tr>\n <td class=\"tg-9hbo\">latitude</td>\n <td class=\"tg-yw4l\">Float</td>\n <td class=\"tg-9hbo\"></td>\n <td class=\"tg-jogk\">280.12</td>\n <td class=\"tg-yw4l\">The Users Geo-Location (latitude). Set this parameter to increase your eCPM.</td>\n <td class=\"tg-9hbo\">YES</td>\n </tr>\n \n <tr>\n <td class=\"tg-9hbo\">dev_dnt</td>\n <td class=\"tg-yw4l\">Integer</td>\n <td class=\"tg-9hbo\">0</td>\n <td class=\"tg-jogk\">1</td>\n <td class=\"tg-yw4l\">\n Specify if \"Do not Track\" is turned on or off by the browser. This has to be part of your <a href=\"https://en.wikipedia.org/wiki/List_of_HTTP_header_field\">HTTP Header</a>.\n <br/><br/>\n You can send this also using the dev_dnt parameter if a HTTP Header does not work for you. But keep in mind that the HTTP Header has priority if it is available.\n <br/><br/>\n This has to be sent to us at all times when available.\n <br/><br/>\nIf this parameter is missing we assume tracking is allowed. \n </td>\n <td class=\"tg-9hbo\">YES</td>\n </tr>\n \n <tr>\n <td class=\"tg-9hbo\">dev_lmt</td>\n <td class=\"tg-yw4l\">Integer</td>\n <td class=\"tg-9hbo\"></td>\n <td class=\"tg-jogk\">1</td>\n <td class=\"tg-yw4l\">\n This parameter signals the \"Limit Ad Tracking\" option the user picked on their device os. When dev_lmt = 1 tracking must be limited per commercial guidelines.\n <br/><br/>\n This has to be sent to us at all times when available.\n <br/><br/>\nIf this parameter is missing we assume tracking is not limited. \n </td>\n <td class=\"tg-9hbo\">YES</td>\n </tr>\n <tr>\n <td class=\"tg-9hbo\">dev_js</td>\n <td class=\"tg-yw4l\">Integer</td>\n <td class=\"tg-9hbo\">1</td>\n <td class=\"tg-jogk\">1</td>\n <td class=\"tg-yw4l\">Indicates if the devices has support for javascript. 1 means yes, 0 means no.</td>\n <td class=\"tg-yw4l\"></td>\n </tr>\n \n \n \n <tr>\n <th class=\"tg-9hbo\" colspan=\"6\">Impression</th>\n </tr>\n <tr>\n <td class=\"tg-9hbo\">adspace_width</td>\n <td class=\"tg-yw4l\">Integer</td>\n <td class=\"tg-9hbo\">320</td>\n <td class=\"tg-jogk\">320</td>\n <td class=\"tg-yw4l\">The Width of your Ad Space. This is also the maximum banner size that our servers will return.<span class=\"bold-span\"> If not specified, it defaults to 320</span></td>\n <td class=\"tg-9hbo\">YES</td>\n </tr>\n <tr>\n <td class=\"tg-9hbo\">adspace_height</td>\n <td class=\"tg-yw4l\">Integer</td>\n <td class=\"tg-9hbo\">50</td>\n <td class=\"tg-jogk\">480</td>\n <td class=\"tg-yw4l\">The Height of your Ad Space. This is also the maximum banner size that our servers will return.<span class=\"bold-span\"> If not specified, it defaults to 50</span> </td>\n <td class=\"tg-9hbo\">YES</td>\n </tr>\n <tr>\n <td class=\"tg-9hbo\">adspace_strict</td>\n <td class=\"tg-yw4l\">Integer</td>\n <td class=\"tg-9hbo\">0</td>\n <td class=\"tg-jogk\">1</td>\n <td class=\"tg-yw4l\">If this parameter is set to 1 and an adspace_height and adspace_width are provided, the ad server will only serve ads of these exact dimensions and will not serve any smaller-sized ads. <span class=\"bold-span\">By default it is set to 0</span>, so the strict constraint is not enforced.</td>\n <td class=\"tg-9hbo\"></td>\n </tr>\n <tr>\n <td class=\"tg-9hbo\">imp_instl</td>\n <td class=\"tg-yw4l\">Integer</td>\n <td class=\"tg-9hbo\">0</td>\n <td class=\"tg-jogk\">1</td>\n <td class=\"tg-yw4l\">Indicates if the requested ad will be displayed as an interstitial/fullscreen ad. <span class=\"bold-span\">1</span> means yes, <span class=\"bold-span\">0</span> means no.</span> </td>\n <td class=\"tg-9hbo\"></td>\n </tr>\n\n<tr>\n <td class=\"tg-9hbo\">imp_secure</td>\n <td class=\"tg-yw4l\">Integer</td>\n <td class=\"tg-9hbo\">0</td>\n <td class=\"tg-jogk\">1</td>\n <td class=\"tg-yw4l\">Set to <b>1</b> to request secure ads, which only use https:// URLs in src=\"\" attributes. This setting will enable you to be ATS compliant.</td>\n <td class=\"tg-9hbo\"></td>\n </tr>\n\n <tr>\n <td class=\"tg-9hbo\">allow_mr</td>\n <td class=\"tg-yw4l\">Integer</td>\n <td class=\"tg-9hbo\"></td>\n <td class=\"tg-jogk\">1</td>\n <td class=\"tg-yw4l\">Allow 300x250 Medium Rectangle Ad Units to be returned.<span class=\"bold-span\"> This defaults to 1 for mobile websites, and must be specifically set to 0 when 300x250 ad units should not be shown on mobile websites.</span></td>\n <td class=\"tg-9hbo\"></td>\n </tr>\n <tr>\n <td class=\"tg-9hbo\">r_floor</td>\n <td class=\"tg-yw4l\">Float</td>\n <td class=\"tg-9hbo\"></td>\n <td class=\"tg-jogk\">0.80</td>\n <td class=\"tg-yw4l\">Pass a CPM floor price for the ad request. Only ads that meet or exceed the given CPM will be returned.</td>\n <td class=\"tg-9hbo\">YES</td>\n </tr>\n\n\n <tr>\n <th class=\"tg-9hbo\" colspan=\"6\">User Demographics</th>\n </tr>\n <tr>\n <td class=\"tg-9hbo\">demo_gender</td>\n <td class=\"tg-yw4l\">String</td>\n <td class=\"tg-9hbo\"></td>\n <td class=\"tg-jogk\">female, f, male, m</td>\n <td class=\"tg-yw4l\">The user's gender (male/m or female/f), if available. Set this parameter to increase your eCPM.</td>\n <td class=\"tg-9hbo\">YES</td>\n </tr>\n <tr>\n <td class=\"tg-9hbo\">demo_age</td>\n <td class=\"tg-yw4l\">Integer</td>\n <td class=\"tg-9hbo\"></td>\n <td class=\"tg-jogk\">1990, 27</td>\n <td class=\"tg-yw4l\">The user's year of birth or age, if available. Set this parameter to increase your eCPM.</td>\n <td class=\"tg-9hbo\">YES</td>\n </tr>\n <tr>\n <td class=\"tg-9hbo\">demo_keywords</td>\n <td class=\"tg-yw4l\">String</td>\n <td class=\"tg-9hbo\"></td>\n <td class=\"tg-jogk\">sports, finance, football</td>\n <td class=\"tg-yw4l\">A comma-separated list of keywords. Example: sports, cars, finance, football.</td>\n <td class=\"tg-9hbo\"></td>\n </tr>\n\n\n <tr>\n <th class=\"tg-9hbo\" colspan=\"6\">Network/Aggregator Parameters</th>\n </tr>\n <tr>\n <td class=\"tg-9hbo\">s_subid</td>\n <td class=\"tg-yw4l\">String</td>\n <td class=\"tg-9hbo\"></td>\n <td class=\"tg-jogk\">1212_1212</td>\n <td class=\"tg-yw4l\">If you are aggregating traffic for multiple Publishers on a single MobFox Inventory Hash, it is highly recommended you pass a unique ID per Publisher in the API so MobFox can optimise your traffic and achieve better eCPMs.</td>\n <td class=\"tg-9hbo\"></td>\n </tr>\n <tr>\n <td class=\"tg-9hbo\">sub_name</td>\n <td class=\"tg-yw4l\">String</td>\n <td class=\"tg-9hbo\"></td>\n <td class=\"tg-jogk\">Angry Birds</td>\n <td class=\"tg-yw4l\">You can provide a custom name for the publication, to override the publication name set in your MobFox account. This value will be passed to DSPs as part of the OpenRTB bid request.</td>\n <td class=\"tg-9hbo\">YES</td>\n </tr>\n <tr>\n <td class=\"tg-9hbo\">sub_domain</td>\n <td class=\"tg-yw4l\">String</td>\n <td class=\"tg-9hbo\"></td>\n <td class=\"tg-jogk\">my.appdomain.com</td>\n <td class=\"tg-yw4l\">You can provide a custom domain for the publication, to enable DSPs to identify your app to advertisers. This value will be passed to DSPs as part of the OpenRTB bid request.</td>\n <td class=\"tg-9hbo\">YES</td>\n </tr>\n <tr>\n <td class=\"tg-9hbo\">sub_storeurl</td>\n <td class=\"tg-yw4l\">String</td>\n <td class=\"tg-9hbo\"></td>\n <td class=\"tg-jogk\">http://my.appdomain.com/game</td>\n <td class=\"tg-yw4l\">You can provide an app store url for the publication, or - in absence - a web site url for the publication. This parameter can only be used for downloadable apps, not web sites. This value will be passed to DSPs as part of the OpenRTB bid request.</td>\n <td class=\"tg-9hbo\">YES</td>\n </tr>\n <tr>\n <td class=\"tg-9hbo\">sub_bundle_id</td>\n <td class=\"tg-yw4l\">String</td>\n <td class=\"tg-9hbo\"></td>\n <td class=\"tg-jogk\">2324345</td>\n <td class=\"tg-yw4l\">You can provide your app's bundle id like for example: \"com.domain.title\" or \"3321293\"</td>\n <td class=\"tg-9hbo\">YES</td>\n </tr>\n\n <tr>\n <th class=\"tg-9hbo\" colspan=\"6\">Site Parameters</th>\n </tr>\n <tr>\n <td class=\"tg-9hbo\">p</td>\n <td class=\"tg-yw4l\">String</td>\n <td class=\"tg-9hbo\"></td>\n <td class=\"tg-jogk\"></td>\n <td class=\"tg-yw4l\">On mobile websites, this should be the URL of the page where the ad is being shown. You can leave this parameter blank for mobile apps.</td>\n <td class=\"tg-9hbo\"></td>\n </tr>\n \n\n\n <tr>\n <th class=\"tg-9hbo\" colspan=\"6\">Misc</th>\n </tr>\n <tr>\n <td class=\"tg-9hbo\">m</td>\n <td class=\"tg-yw4l\">String</td>\n <td class=\"tg-9hbo\">live</td>\n <td class=\"tg-jogk\">live</td>\n <td class=\"tg-yw4l\">If you would like to receive a test-banner, this parameter should be &amp;m=test, otherwise use m=live for real ads.</td>\n <td class=\"tg-yw4l\"></td>\n </tr> \n</table>" } [/block] [block:callout] { "type": "warning", "title": "Recommended parameters for highest eCPMs", "body": "We recommend passing these parameters on all of your ad requests to get the best eCPM:\n\n* adspace_width/adspace_height\n* r_floor\n* o_andadvid\n* o_iosadvid\n* latitude\n* longitude\n* demo_age\n* demo_gender" } [/block] [block:callout] { "type": "danger", "title": "If you are a network/aggregator you must pass us these parameters as well", "body": "* sub_name\n* sub_domain\n* sub_storeurl\n* sub_bundle_id" } [/block] [block:api-header] { "type": "basic", "title": "Next Step" } [/block] Make your first ad request for [Banner](http://docs.mobfox.com/docs/banners), [Video](http://docs.mobfox.com/docs/request-videos) or [Native](http://docs.mobfox.com/docs/request-native-ads-iab).