CINXE.COM

<!DOCTYPE html><html lang="en"><head><link rel="shortcut icon" href="/content/wm_favicon.ico"><meta charset="utf-8"><meta name="viewport" content="width=device-width,minimum-scale=1,initial-scale=1"><link href="/styles/theme.css" rel="stylesheet" type="text/css"><script src="/scripts/theme.js" type="text/javascript"></script><title>Wood Mackenzie API Portal - The Basics - Microsoft Azure API Management - developer portal</title><meta name="description" content="Discover APIs, learn how to use them, try them out interactively, and sign up to acquire keys."><meta name="keywords" content="Azure, API Management, API, developer"><meta name="author" content="Microsoft Azure API Management"><link href="/styles/styles.css" rel="stylesheet" type="text/css"><meta property="og:type" content="article"><meta property="og:site_name" content="Microsoft Azure API Management - developer portal"><meta property="og:title" content="Wood Mackenzie API Portal - The Basics"><meta property="og:description" content="Discover APIs, learn how to use them, try them out interactively, and sign up to acquire keys."><meta property="og:url" content="/basics"><link href="/basics/styles.css" rel="stylesheet" type="text/css"></head><body class="block"><div class="flex flex-column flex-grow fill"><div class="popup-host"></div><section class="yducimamxb yducimamxb-sm yducimamxb-md yducimamxb-lg yducimamxb-xl" access-id="02725094-2584-e156-ff8d-255d5c6ca126"><div class="gjpnqnxbbj gjpnqnxbbj-sm gjpnqnxbbj-md gjpnqnxbbj-lg gjpnqnxbbj-xl"><div class="kltazpmqso kltazpmqso-sm kltazpmqso-xl kltazpmqso-md" role="article"><a href="/"><img class="content picture picture-nhebn" src="/content/WMlogo-title.png" alt="Picture" width="400" style="width:400px;height:55px" height="55"></a><div class="collapsible collapsible-panel legacy"><div class="collapsible-backdrop"></div><div class="collapsible-content rqgdafxoox-md rqgdafxoox-lg rqgdafxoox-xl rqgdafxoox rqgdafxoox-sm"><nav access-id="1b9d3211-3525-527d-af10-e78629b1321c" class="menu menu-r8rew inline-block"><div class="menu menu-horizontal"><ul class="nav"><li class="nav-item"><a href="/" class="nav-link" data-bind="text: item.label, hyperlink: item.hyperlink, css: { 'nav-link-active': item.isActive }">HOME</a></li><li class="nav-item"><a href="#" class="nav-link" data-toggle="dropdown" data-bind="text: item.label, hyperlink: item.hyperlink, css: { 'nav-link-active': item.isActive }">HOW TO</a><div class="dropdown"><ul class="nav"><li class="nav-item"><a href="/get-started" class="nav-link" data-bind="text: item.label, hyperlink: item.hyperlink, css: { 'nav-link-active': item.isActive }" target="_self">GET STARTED</a></li><li class="nav-item"><a href="/basics" class="nav-link nav-link-active" data-bind="text: item.label, hyperlink: item.hyperlink, css: { 'nav-link-active': item.isActive }" target="_self">THE BASICS</a></li><li class="nav-item"><a href="/import-data-into-excel" class="nav-link" data-bind="text: item.label, hyperlink: item.hyperlink, css: { 'nav-link-active': item.isActive }" target="_self">IMPORT DATA INTO EXCEL</a></li><li class="nav-item"><a href="/query-data-in-bulk" class="nav-link" data-bind="text: item.label, hyperlink: item.hyperlink, css: { 'nav-link-active': item.isActive }" target="_self">QUERY DATA IN BULK</a></li></ul></div></li></ul></div></nav><nav access-id="a479939e-aa14-caa0-6afc-5f0d251113cf" class="menu menu-r8rew inline-block"><div class="menu menu-horizontal"><ul class="nav"><li class="nav-item"><a href="/guests-overview" class="nav-link" data-bind="text: item.label, hyperlink: item.hyperlink, css: { 'nav-link-active': item.isActive }" target="_self">OVERVIEW</a></li><li class="nav-item"><a href="/quests-faq" class="nav-link" data-bind="text: item.label, hyperlink: item.hyperlink, css: { 'nav-link-active': item.isActive }" target="_self">FAQ</a></li><li class="nav-item"><a href="/signin?" class="nav-link" data-bind="text: item.label, hyperlink: item.hyperlink, css: { 'nav-link-active': item.isActive }" target="_self">SIGN IN</a></li></ul></div></nav><button class="collapsible-panel-close" aria-label="Toggle" data-dismiss="collapsible"><i class="icon-emb icon-emb-simple-remove"></i></button></div><button class="collapsible-panel-open" aria-label="Toggle" data-toggle="collapsible"><i class="icon-emb icon-emb-menu-8"></i></button></div></div></div></section><section class="nfsmvqtubj nfsmvqtubj-sm nfsmvqtubj-md nfsmvqtubj-lg nfsmvqtubj-xl" access-id="a5a79c1f-eee4-b4e5-6306-480a2bcacaa5"><div class="znryzltdgl znryzltdgl-sm znryzltdgl-md znryzltdgl-lg znryzltdgl-xl"><div class="bwdtzpqkil" role="main"><div class="flex flex-column flex-grow fill block"><section class="nryubbkygy" access-id="d0b222df-6d11-6ac8-fcc5-a1bfbbfbb6e3"><div class="ijxmorzbxt ijxmorzbxt-lg"><div class="jhyoftxmum" role="article"><div class="ProseMirror"><h1 id="gnrJw">The Basics</h1></div></div></div></section><section class="hbbwietbha" access-id="cc38989b-8bd6-f2a2-1d72-4f78165d31b7"><div class="oluuagwycu oluuagwycu-lg"><div class="wjoakbnhuo" role="article"><div class="ProseMirror"><h2 id="VJm7W"><span class="colors-qid-f6">Connecting to the API</span></h2><p>Wood Mackenzie鈥檚 Data API service environment can be found at: <code><span class="colors-f-jz0-k">https://api.genscape.com/</span></code></p></div></div></div></section><section class="mhzvupgdbu" access-id="2cfd553e-e0be-9172-c0c1-e72e27d2024b"><div class="knvczsvomx knvczsvomx-lg"><div class="ukcrznamlg" role="article"><div class="ProseMirror"><h2 id="2G7rf"><span class="colors-qid-f6">API Keys</span></h2><p><mark>API keys should be considered the same as a password. DO NOT share or distribute your key. If you feel your key has been compromised, a new key can be regenerated in the API Profile section under the My Accounts menu.</mark></p><p>Every request to the Wood Mackenzie Data API requires an API key to be passed along with the request. Your API keys can be found in the API Profile section under the My Accounts menu.</p><p>Every API-entitled Wood Mackenzie user will automatically get one API key. The Wood Mackenzie Data API expects your key to be passed via the URL with the <code><span class="colors-f-jz0-k">genApiKey</span></code> parameter. So if your API key was abcdef and you were requesting North America current megawatts transmission data, you would send a request to <code><span class="colors-f-jz0-k">https://api.genscape.com/power/na/v1/generation-transmission/current/?genApiKey=abcdef</span></code>.</p><p>Alternatively, you can pass the API key using the <code><span class="colors-f-jz0-k">HTTP</span></code><span class="colors-f-jz0-k"> </span>header:</p><pre><code>curl -v -X GET "https://api.genscape.com/power/na/v1/generation-transmission/current?limit=200&offset=0&format=json" -H "Gen-Api-Key: {API key}"</code></pre></div></div></div></section><section class="xtxnzuuzgn" access-id="3f4449d1-9bae-c898-8b1c-94f0c3a6a483"><div class="molklrxjvi molklrxjvi-lg"><div class="zjlidiwqmf" role="article"><div class="ProseMirror"><h2 id="eM44L"><span class="colors-qid-f6">Return Types</span></h2><p>The Wood Mackenzie Data API service offers 3 return types: JSON, XML and CSV. Just like your API key, you can specify the return type by passing the format parameter in the query string of the request. The options you can pass are json, xml, or csv. If you do not pass any format parameter, JSON will be returned.</p></div></div></div></section><section class="dmyyilxkak" access-id="f2c89a3c-6fe7-b6ef-e55a-35b460bb321c"><div class="ogucdswrdr ogucdswrdr-lg"><div class="oxfzadkhpz" role="article"><div class="ProseMirror"><h2 id="pgLeY"><span class="colors-qid-f6">Sending Endpoint Arguments</span></h2><p>When sending data to the Data API service for filtering on listing endpoints, you should pass all your data using application/x-www-form-urlencoded strings. For GET methods, these are passed via the query string (after the "?" in the request URL).</p></div></div></div></section><section class="jaukpkbjmp" access-id="3304ba82-4221-aef4-2efc-7386ec416737"><div class="qvisqkcjyq qvisqkcjyq-lg"><div class="phxlnjkkeg" role="article"><div class="ProseMirror"><h2 id="BQYfw"><span class="colors-qid-f6">Request Limit</span></h2><p>Wood Mackenzie has a bandwidth rate limiting system in place to prevent abuse and system overload. If you receive a response code of 503, that means you have exceeded the rate limit and you should send your requests at a slower rate. Our rate limits currently are subject to the following restrictions:</p><ul><li><p>30 requests per minute</p></li><li><p>1,000 requests per day</p></li></ul><p>Note that these limits are current guidelines only and are subject to change without notice. The counter resets every night at midnight Eastern Standard Time. If you need more requests than this, please contact us about options.</p></div></div></div></section><section class="gzgzfwiaed" access-id="e599828a-7a88-faab-d4dd-4709ec93469f"><div class="mnvimiihfl mnvimiihfl-lg"><div class="ihdlrnvqui" role="article"><iframe frameborder="0" allow="clipboard-read; clipboard-write; camera; microphone; geolocation" sandbox="allow-scripts allow-modals allow-forms allow-popups allow-popups-to-escape-sandbox allow-top-navigation allow-pointer-lock" src="/content/html_widgets/ov5x1.html" class="jdhhswcsxn jdhhswcsxn-sm jdhhswcsxn-md jdhhswcsxn-lg jdhhswcsxn-xl"></iframe></div><div class="ufpskumbfv" role="article"><div class="ProseMirror"><h2 id="66KEQ"><span class="colors-qid-f6">Response Codes</span></h2><ul><li><p>All requests will return an appropriate response code.</p></li><li><p>An error response will describe the specifics of any errors.</p></li></ul></div></div></div></section></div></div></div></section><section class="flsbrjhydb flsbrjhydb-sm flsbrjhydb-md flsbrjhydb-lg flsbrjhydb-xl" access-id="56024eca-7bff-a53b-ea56-865f1ba0236b"><div class="tzyyathlgq tzyyathlgq-sm tzyyathlgq-md tzyyathlgq-lg tzyyathlgq-xl"><div class="tbzdikbocf tbzdikbocf-md" role="aside"><iframe frameborder="0" allow="clipboard-read; clipboard-write; camera; microphone; geolocation" sandbox="allow-scripts allow-modals allow-forms allow-popups allow-popups-to-escape-sandbox allow-top-navigation allow-pointer-lock" src="/content/html_widgets/BXwrT.html" class="giwdylrjno giwdylrjno-sm giwdylrjno-md giwdylrjno-lg giwdylrjno-xl"></iframe></div><div class="hnmidtqfsn hnmidtqfsn-md" role="article"><iframe frameborder="0" allow="clipboard-read; clipboard-write; camera; microphone; geolocation" sandbox="allow-scripts allow-modals allow-forms allow-popups allow-popups-to-escape-sandbox allow-top-navigation allow-pointer-lock" src="/content/html_widgets/IUMdg.html" class="fmmnryimgc fmmnryimgc-sm fmmnryimgc-md fmmnryimgc-lg fmmnryimgc-xl"></iframe></div></div></section></div><script type="text/javascript" src="/_Incapsula_Resource?SWJIYLWA=719d34d31c8e3a6e6fffd425f7e032f3&ns=1&cb=857403524" async></script></body></html>