Seamlessly integrate our Vortex API into your systems to access real-time pricing and submit contracts. You can connect to the live endpoint at https://quote.jellyfish.rest/ to retrieve this data.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"9702688","collectionId":"b64f1eb8-6ca0-4973-8713-a084ca373242","publishedId":"2s946eBuPm","public":true,"customColor":{"top-bar":"212121","right-sidebar":"303030","highlight":"e72e6f"},"publishDate":"2023-11-03T18:14:03.000Z"},"item":[{"name":"Pricing","item":[{"name":"/pricing","id":"18a8f07f-5176-4f9b-a077-201021996d78","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{VORTEX_ENDPOINT}}/pricing?energy=electricity&mpxn=1591058900229&usage=49994&startDate=2024-05-28&commission=0.75","urlObject":{"path":["pricing"],"host":["{{VORTEX_ENDPOINT}}"],"query":[{"description":{"content":"Choose between \"gas\" or \"electricity\"
\n","type":"text/plain"},"key":"energy","value":"electricity"},{"description":{"content":"MPRN or MPAN which can be retrieved from Address endpoint
\n","type":"text/plain"},"key":"mpxn","value":"1591058900229"},{"description":{"content":"The estimated annual usage in kWh
\n","type":"text/plain"},"key":"usage","value":"49994"},{"description":{"content":"Anticipated start date, should be at least 7 days in the future
\n","type":"text/plain"},"key":"startDate","value":"2024-05-28"},{"description":{"content":"Commission in pence. Max 3p for gas, 5p for electricity
\n","type":"text/plain"},"key":"commission","value":"0.75"},{"disabled":true,"description":{"content":"Partner short code for exclusive/limited products only, not required
\n","type":"text/plain"},"key":"shortCode","value":"JELLY"},{"disabled":true,"description":{"content":"Risk score to show exclusive credit check products, not required
\n","type":"text/plain"},"key":"riskScore","value":"89"},{"disabled":true,"description":{"content":"A unique code to show exclusive products, not required
\n","type":"text/plain"},"key":"promotionCode","value":"123456789"},{"disabled":true,"description":{"content":"A rating based on the existing customer behaviour, not required
\n","type":"text/plain"},"key":"retentionRating","value":"5"}],"variable":[]}},"response":[{"id":"66c27c18-9993-470f-ab68-ab08b69c61f6","name":"/pricing","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{VORTEX_ENDPOINT}}/pricing?energy=gas&mpxn=9213027309&usage=49994&startDate=2023-12-28&commission=0.75&shortCode=JELLY&riskScore=42&retentionRating=5","host":["{{VORTEX_ENDPOINT}}"],"path":["pricing"],"query":[{"key":"energy","value":"gas","description":"Choose between \"gas\" or \"electricity\""},{"key":"mpxn","value":"9213027309","description":"MPRN or MPAN which can be retrieved from Address endpoint"},{"key":"usage","value":"49994","description":"The estimated annual usage in kWh"},{"key":"startDate","value":"2023-12-28","description":"Anticipated start date, should be at least 7 days in the future"},{"key":"commission","value":"0.75","description":"Commission in pence. Max 3p for gas, 5p for electricity"},{"key":"shortCode","value":"JELLY","description":"Partner short code for exclusive/limited products only, not required"},{"key":"riskScore","value":"42","description":"Risk score to show exclusive credit check products"},{"key":"retentionRating","value":"5","description":"A rating based on the existing customer behaviour","type":"text"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"X-RateLimit-Limit","value":"100"},{"key":"X-RateLimit-Remaining","value":"99"},{"key":"Date","value":"Fri, 03 Nov 2023 17:40:51 GMT"},{"key":"X-RateLimit-Reset","value":"1699033260"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"415"},{"key":"ETag","value":"W/\"19f-o7Zj70UVnAG646P21FcE+aeCR7o\""},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"id\": 260,\n \"name\": \"Blue (v8)\",\n \"description\": \"Variable direct debit 12 month fixed\",\n \"facts\": [\n \"Rates locked in\",\n \"Government discounts\",\n \"Jellyfish rewards\"\n ],\n \"fixed\": true,\n \"term\": 12,\n \"unitRate\": 10.556107847,\n \"standingCharge\": 35,\n \"riskScoreExclusive\": false,\n \"costs\": {\n \"annualCost\": 5405.17055702918,\n \"annualCommission\": 374.955,\n \"monthlyCost\": 450.4308797524316,\n \"monthlyCommission\": 31.24625\n }\n }\n ],\n \"errors\": null\n}"}],"_postman_id":"18a8f07f-5176-4f9b-a077-201021996d78"},{"name":"/pricing/domestic","id":"d9458729-b851-4b99-b8c0-cfe9eef0f6f9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{VORTEX_ENDPOINT}}/pricing/domestic?energy=electricity&gsp=_A&gasUsage=49994&electricityUsage=2100&email=tech@jellyfish.energy&e7=55","urlObject":{"path":["pricing","domestic"],"host":["{{VORTEX_ENDPOINT}}"],"query":[{"description":{"content":"Choose between \"dual\" or \"electricity\"
\n","type":"text/plain"},"key":"energy","value":"electricity"},{"description":{"content":"Area code for pricing
\n","type":"text/plain"},"key":"gsp","value":"_A"},{"description":{"content":"The estimated annual usage in kWh (if applicable)
\n","type":"text/plain"},"key":"gasUsage","value":"49994"},{"description":{"content":"The estimated annual usage in kWh
\n","type":"text/plain"},"key":"electricityUsage","value":"2100"},{"description":{"content":"For price notification (optional)
\n","type":"text/plain"},"key":"email","value":"tech@jellyfish.energy"},{"description":{"content":"E7 split (optional)
\n","type":"text/plain"},"key":"e7","value":"55"}],"variable":[]}},"response":[{"id":"ff9f7645-aa90-4912-b030-1fa2482b5dab","name":"/pricing","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{VORTEX_ENDPOINT}}/pricing?energy=electricity&gsp=_A&gasUsage=49994&electricityUsage=2100&email=tech@jellyfish.energy&e7=55","host":["{{VORTEX_ENDPOINT}}"],"path":["pricing"],"query":[{"key":"energy","value":"electricity","type":"text","description":"Choose between \"gas\" or \"electricity\""},{"key":"gsp","value":"_A","type":"text","description":"MPRN or MPAN which can be retrieved from Address endpoint"},{"key":"gasUsage","value":"49994","type":"text","description":"The estimated annual usage in kWh"},{"key":"electricityUsage","value":"2100","type":"text","description":"Anticipated start date, should be at least 7 days in the future"},{"key":"email","value":"tech@jellyfish.energy","type":"text","description":"Commission in pence. Max 3p for gas, 5p for electricity"},{"key":"e7","value":"55","type":"text","description":"Partner short code for exclusive/limited products only, not required"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"X-RateLimit-Limit","value":"100"},{"key":"X-RateLimit-Remaining","value":"99"},{"key":"Date","value":"Fri, 03 Nov 2023 17:40:51 GMT"},{"key":"X-RateLimit-Reset","value":"1699033260"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"415"},{"key":"ETag","value":"W/\"19f-o7Zj70UVnAG646P21FcE+aeCR7o\""},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"id\": 10,\n \"name\": \"Crown\",\n \"description\": \"12 month fixed electricity only product\",\n \"fixed\": true,\n \"term\": 12,\n \"standingCharge\": 45,\n \"rates\": [\n {\n \"type\": \"Day Units\",\n \"rate\": 22\n },\n {\n \"type\": \"Night Units\",\n \"rate\": 22\n }\n ],\n \"costs\": {\n \"annualCost\": 626,\n \"monthlyCost\": 52\n }\n }\n ],\n \"errors\": null\n}"}],"_postman_id":"d9458729-b851-4b99-b8c0-cfe9eef0f6f9"}],"id":"79955670-4be1-4496-9992-d55c12d878c8","description":"Use this endpoint to fetch real-time quotes for products that match your search criteria. Please note that we retain the right to withdraw products from availability at any given time.
\n","_postman_id":"79955670-4be1-4496-9992-d55c12d878c8"},{"name":"Contracts","item":[{"name":"/contracts","id":"c4738c8d-949b-4194-8602-1769ddf964fc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"channel\": \"PARTNER_SHORT_CODE\", // required for reporting use, to match Medusa short code\n \"companyName\": \"Sarah Black Coffee\",\n \"companyRegistrationNumber\": \"12345678\",\n \"startDate\": \"2023-12-01\",\n \"productId\": 1894,\n \"energy\": \"electricity\",\n \"estimatedAnnualUsage\": 40000,\n \"mpxn\": 1591058900229,\n \"commissionPerUnit\": 1,\n \"agentEmail\": \"a@hdn.ai\", // required if documents.contract is empty\n \"contact\": {\n \"title\": \"Miss\",\n \"firstName\": \"Sarah\",\n \"lastName\": \"Black\",\n \"position\": \"Director\",\n \"email\": \"sarah@jellyfish.energy\",\n \"phone\": \"07123456789\"\n },\n \"bank\": {\n \"accountName\": \"Miss Sarah Black\",\n \"accountNumber\": \"12345678\",\n \"sortCode\": \"112233\"\n },\n \"documents\": {\n \"loa\": \"JVBERi0xLjQKJaqrrK0KMSAwIG9iago8PAovVGl0bGUgKEluZGVlZCBSZXN1bWUpCi9BdXRob3IgKEluZGVlZC...\",\n \"contract\": \"JVBERi0xLjQKJaqrrK0KMSAwIG9iago8PAovVGl0bGUgKEluZGVlZCBSZXN1bWUpCi9BdXRob3IgKEluZGVlZC...\" // optional field, if empty we will attempt to send an eSign document automatically\n },\n \"metadata\": {},\n \"test\": true\n}"},"url":"{{VORTEX_ENDPOINT}}/contracts","urlObject":{"path":["contracts"],"host":["{{VORTEX_ENDPOINT}}"],"query":[],"variable":[]}},"response":[{"id":"c1bbe149-7cf0-4417-b4a0-32a80c844835","name":"/contracts","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"channel\": \"PARTNER_SHORT_CODE\", // required for reporting use, to match Medusa short code\n \"companyName\": \"Sarah Black Coffee\",\n \"companyRegistrationNumber\": 12345678,\n \"startDate\": \"2023-12-01\",\n \"productId\": 1894,\n \"energy\": \"electricity\",\n \"estimatedAnnualUsage\": 40000,\n \"mpxn\": 1591058900229,\n \"commissionPerUnit\": 1,\n \"agentEmail\": \"a@hdn.ai\", // required if documents.contract is empty\n \"contact\": {\n \"title\": \"Miss\",\n \"firstName\": \"Sarah\",\n \"lastName\": \"Black\",\n \"position\": \"Director\",\n \"email\": \"sarah@jellyfish.energy\",\n \"phone\": \"07123456789\"\n },\n \"bank\": {\n \"accountName\": \"Miss Sarah Black\",\n \"accountNumber\": \"12345678\",\n \"sortCode\": \"112233\"\n },\n \"documents\": {\n \"loa\": \"JVBERi0xLjQKJaqrrK0KMSAwIG9iago8PAovVGl0bGUgKEluZGVlZCBSZXN1bWUpCi9BdXRob3IgKEluZGVlZC...\",\n \"contract\": \"JVBERi0xLjQKJaqrrK0KMSAwIG9iago8PAovVGl0bGUgKEluZGVlZCBSZXN1bWUpCi9BdXRob3IgKEluZGVlZC...\" // optional field, if empty we will attempt to send an eSign document automatically\n },\n \"metadata\": {},\n \"test\": true\n}","options":{"raw":{"language":"json"}}},"url":"{{VORTEX_ENDPOINT}}/contracts"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"X-RateLimit-Limit","value":"100"},{"key":"X-RateLimit-Remaining","value":"99"},{"key":"Date","value":"Fri, 03 Nov 2023 16:51:06 GMT"},{"key":"X-RateLimit-Reset","value":"1699030274"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"58"},{"key":"ETag","value":"W/\"3a-Y8NM16gFOEg6mmmz8YMwgxBhUXo\""},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"reference\": 476468\n },\n \"errors\": null\n}"}],"_postman_id":"c4738c8d-949b-4194-8602-1769ddf964fc"},{"name":"/contracts/domestic","id":"05ee0317-ef4b-4124-a374-f56789ef304e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"channel\": \"PARTNER_SHORT_CODE\", // required for reporting use\n \"energy\": \"dual\",\n \"productName\": \"Crown\",\n \"electricity\": {\n \"mpan\": \"\",\n \"usage\": 2000\n },\n \"gas\": {\n \"mprn\": \"\",\n \"usage\": 2000\n },\n \"contact\": {\n \"title\": \"Miss\",\n \"firstName\": \"Sarah\",\n \"lastName\": \"Black\",\n \"position\": \"Director\",\n \"email\": \"sarah@jellyfish.energy\",\n \"phone\": \"07123456789\",\n \"dob\": \"03/04/20\",\n \"address\": {\n \"line1\": \"\",\n \"line2\": \"\",\n \"line3\": \"\",\n \"line4\": \"\",\n \"postcode\": \"\"\n }\n },\n \"psr\": [],\n \"bank\": {\n \"accountName\": \"Miss Sarah Black\",\n \"accountNumber\": \"12345678\",\n \"sortCode\": \"112233\"\n },\n \"metadata\": {}\n}"},"url":"{{VORTEX_ENDPOINT}}/contracts","urlObject":{"path":["contracts"],"host":["{{VORTEX_ENDPOINT}}"],"query":[],"variable":[]}},"response":[{"id":"0b6d350e-49f7-4092-875f-72df15d7d114","name":"/contracts","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"channel\": \"PARTNER_SHORT_CODE\", // required for reporting use\n \"energy\": \"dual\",\n \"productName\": \"Crown\",\n \"electricity\": {\n \"mpan\": \"\",\n \"usage\": 2000\n },\n \"gas\": {\n \"mprn\": \"\",\n \"usage\": 2000\n },\n \"contact\": {\n \"title\": \"Miss\",\n \"firstName\": \"Sarah\",\n \"lastName\": \"Black\",\n \"position\": \"Director\",\n \"email\": \"sarah@jellyfish.energy\",\n \"phone\": \"07123456789\",\n \"dob\": \"03/04/20\",\n \"address\": {\n \"line1\": \"\",\n \"line2\": \"\",\n \"line3\": \"\",\n \"line4\": \"\",\n \"postcode\": \"\"\n }\n },\n \"psr\": [],\n \"bank\": {\n \"accountName\": \"Miss Sarah Black\",\n \"accountNumber\": \"12345678\",\n \"sortCode\": \"112233\"\n },\n \"metadata\": {}\n}","options":{"raw":{"language":"json"}}},"url":"{{VORTEX_ENDPOINT}}/contracts"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"X-RateLimit-Limit","value":"100"},{"key":"X-RateLimit-Remaining","value":"99"},{"key":"Date","value":"Fri, 03 Nov 2023 16:51:06 GMT"},{"key":"X-RateLimit-Reset","value":"1699030274"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"58"},{"key":"ETag","value":"W/\"3a-Y8NM16gFOEg6mmmz8YMwgxBhUXo\""},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"reference\": 476468\n },\n \"errors\": null\n}"}],"_postman_id":"05ee0317-ef4b-4124-a374-f56789ef304e"}],"id":"9cd64de4-be63-43a7-a5a0-6f123df0cf78","description":"Use this endpoint to send contracts to Jellyfish. Once the contract is submitted, it will enter a pending approval state until our team reviews and approves it.
\n\n\n","_postman_id":"9cd64de4-be63-43a7-a5a0-6f123df0cf78"},{"name":"Products","item":[{"name":"/products/electric/:id","id":"33e20ed3-a2ef-444c-9918-59e0ffc3230b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{VORTEX_ENDPOINT}}/products/electric/459","urlObject":{"path":["products","electric","459"],"host":["{{VORTEX_ENDPOINT}}"],"query":[],"variable":[]}},"response":[{"id":"917591ef-811a-4cea-ab3e-a42855d39856","name":"/products/electric/:id","originalRequest":{"method":"GET","header":[],"url":"{{VORTEX_ENDPOINT}}/products/electric/459"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"X-RateLimit-Limit","value":"100"},{"key":"X-RateLimit-Remaining","value":"99"},{"key":"Date","value":"Fri, 03 Nov 2023 17:39:44 GMT"},{"key":"X-RateLimit-Reset","value":"1699033190"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"583"},{"key":"ETag","value":"W/\"247-Bo/0BciR36bOjlK77QAko6qo7qA\""},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": 459,\n \"name\": \"Box (v2)\",\n \"description\": \"Variable direct debit 12 month fixed\",\n \"facts\": [\n \"Promotion\",\n \"Rates locked in\",\n \"Government discounts\"\n ],\n \"region\": \"_F\",\n \"meterType\": \"DAY\",\n \"profileClass\": \"3\",\n \"standingCharge\": 70,\n \"allOrDayUnitRate\": 27.8048235,\n \"nightRate\": 0,\n \"eveningWeekendRate\": 0,\n \"minAq\": 1,\n \"maxAq\": 250000,\n \"effectiveFrom\": \"2023-07-04T00:00:00.000Z\",\n \"effectiveTo\": \"2024-01-31T00:00:00.000Z\",\n \"fixed\": true,\n \"term\": 12,\n \"active\": true,\n \"broker\": false,\n \"retention\": false,\n \"online\": false,\n \"riskScoreFloor\": null,\n \"riskScoreCeiling\": null,\n \"retentionRating\": null\n },\n \"errors\": null\n}"}],"_postman_id":"33e20ed3-a2ef-444c-9918-59e0ffc3230b"},{"name":"/products/gas/:id","id":"3c05ce4d-18a8-480a-a133-8cbdcb7be655","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{VORTEX_ENDPOINT}}/products/gas/29","urlObject":{"path":["products","gas","29"],"host":["{{VORTEX_ENDPOINT}}"],"query":[],"variable":[]}},"response":[{"id":"ae855921-da9d-434e-abc8-f8d5b51c122a","name":"/products/gas/:id","originalRequest":{"method":"GET","header":[],"url":"{{VORTEX_ENDPOINT}}/products/gas/29"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"X-RateLimit-Limit","value":"100"},{"key":"X-RateLimit-Remaining","value":"99"},{"key":"Date","value":"Fri, 03 Nov 2023 17:40:41 GMT"},{"key":"X-RateLimit-Reset","value":"1699033250"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"510"},{"key":"ETag","value":"W/\"1fe-rDikRtcuk/sghgPe3EzWWBw2Yks\""},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": 29,\n \"name\": \"Blue (v2)\",\n \"description\": \"Variable direct debit 12 month fixed\",\n \"facts\": [\n \"Rates locked in\",\n \"Government discounts\",\n \"Jellyfish rewards\"\n ],\n \"region\": \"NO\",\n \"standingCharge\": 35,\n \"unitRate\": 8.654256192,\n \"minAq\": 1,\n \"maxAq\": 250000,\n \"effectiveFrom\": \"2023-05-26T00:00:00.000Z\",\n \"effectiveTo\": \"2024-02-26T00:00:00.000Z\",\n \"fixed\": true,\n \"term\": 12,\n \"active\": true,\n \"broker\": false,\n \"retention\": false,\n \"online\": false,\n \"riskScoreFloor\": null,\n \"riskScoreCeiling\": null,\n \"retentionRating\": null\n },\n \"errors\": null\n}"}],"_postman_id":"3c05ce4d-18a8-480a-a133-8cbdcb7be655"}],"id":"61e61366-b115-4211-a893-22d147c861d6","description":"Utilise this endpoint solely for the purpose of fetching product data using its ID.
\n","_postman_id":"61e61366-b115-4211-a893-22d147c861d6"},{"name":"Addresses","item":[{"name":"/addresses/electric/:postcode","id":"57a0aa86-46bf-4d8b-be77-fb89d53c1e46","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{VORTEX_ENDPOINT}}/addresses/electric/NE1 3RQ","urlObject":{"path":["addresses","electric","NE1 3RQ"],"host":["{{VORTEX_ENDPOINT}}"],"query":[],"variable":[]}},"response":[{"id":"79567940-3f0e-457e-bd99-5ab64244d6fc","name":"/addresses/electric/:postcode","originalRequest":{"method":"GET","header":[],"url":"{{VORTEX_ENDPOINT}}/addresses/electric/NE1 3RQ"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"X-RateLimit-Limit","value":"100"},{"key":"X-RateLimit-Remaining","value":"99"},{"key":"Date","value":"Fri, 03 Nov 2023 17:41:00 GMT"},{"key":"X-RateLimit-Reset","value":"1699033270"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1008"},{"key":"ETag","value":"W/\"3f0-VERBF6DIGujE5G4FS/7HgKwNjTw\""},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"mpan\": \"1507721729993\",\n \"line1\": \"CLOSE\",\n \"line2\": null,\n \"line3\": \"NEWCASTLE UPON TYNE\",\n \"line4\": null,\n \"buildingNumber\": \"NEPTUNE HOUSE\",\n \"buildingName\": \"THE RIVERSIDE\",\n \"postcode\": \"NE1 3RQ\",\n \"gsp\": \"_F\",\n \"tradingStatus\": \"T\",\n \"distributorMpid\": \"NEEB\"\n },\n {\n \"mpan\": \"1580001164258\",\n \"line1\": \"EAST QUAYSIDE\",\n \"line2\": null,\n \"line3\": \"NEWCASTLE UPON TYNE\",\n \"line4\": null,\n \"buildingNumber\": \"SUPPLY FOR VISTING BOATS\",\n \"buildingName\": null,\n \"postcode\": \"NE1 3RQ\",\n \"gsp\": \"_F\",\n \"tradingStatus\": \"T\",\n \"distributorMpid\": \"NEEB\"\n },\n {\n \"mpan\": \"1591058900229\",\n \"line1\": \"CLOSE\",\n \"line2\": null,\n \"line3\": \"NEWCASTLE UPON TYNE\",\n \"line4\": null,\n \"buildingNumber\": \"THE OLD CORONERS COURT\",\n \"buildingName\": \"GREEN ENERGY CONSULT LTD\",\n \"postcode\": \"NE1 3RQ\",\n \"gsp\": \"_F\",\n \"tradingStatus\": \"T\",\n \"distributorMpid\": \"NEEB\"\n },\n {\n \"mpan\": \"1599001113831\",\n \"line1\": \"NEWCASTLE UPON TYNE\",\n \"line2\": null,\n \"line3\": null,\n \"line4\": \"MARTHAS BAR\",\n \"buildingNumber\": \"SIDE\",\n \"buildingName\": \"41-43\",\n \"postcode\": \"NE1 3RQ\",\n \"gsp\": \"_F\",\n \"tradingStatus\": \"T\",\n \"distributorMpid\": \"NEEB\"\n }\n ],\n \"errors\": null\n}"}],"_postman_id":"57a0aa86-46bf-4d8b-be77-fb89d53c1e46"},{"name":"/addresses/electric/:mpan","id":"ef939c74-33ad-4c1f-82f1-d86d10a98b0c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{VORTEX_ENDPOINT}}/addresses/electric/1591058900229","urlObject":{"path":["addresses","electric","1591058900229"],"host":["{{VORTEX_ENDPOINT}}"],"query":[],"variable":[]}},"response":[{"id":"f501072e-710e-4414-97f2-cd6005bde151","name":"/addresses/electric/:mpan","originalRequest":{"method":"GET","header":[],"url":"{{VORTEX_ENDPOINT}}/addresses/electric/1591058900229"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"X-RateLimit-Limit","value":"100"},{"key":"X-RateLimit-Remaining","value":"98"},{"key":"Date","value":"Fri, 03 Nov 2023 17:41:08 GMT"},{"key":"X-RateLimit-Reset","value":"1699033270"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1928"},{"key":"ETag","value":"W/\"788-ij6lmyv7p/veeSnILEF5IZRJxYA\""},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"details\": {\n \"mpanCore\": \"1591058900229\",\n \"addressLine_1\": null,\n \"addressLine_2\": \"GREEN ENERGY CONSULT LTD\",\n \"addressLine_3\": \"THE OLD CORONERS COURT\",\n \"addressLine_4\": null,\n \"addressLine_5\": \"CLOSE\",\n \"addressLine_6\": null,\n \"addressLine_7\": null,\n \"addressLine_8\": \"NEWCASTLE UPON TYNE\",\n \"addressLine_9\": null,\n \"postcode\": \"NE1 3RQ\",\n \"tradingStatusEfd\": \"19971001\",\n \"profileClass\": \"03\",\n \"profileClassEfd\": \"20220203\",\n \"meterTimeswitchClass\": \"801\",\n \"meterTimeswitchClassEfd\": \"20220203\",\n \"lineLossFactor\": \"02A\",\n \"lineLossFactorEfd\": \"20210401\",\n \"standardSettlementConfiguration\": \"0393\",\n \"standardSettlementConfigurationEfd\": \"20220203\",\n \"energisationStatus\": \"E\",\n \"tradingStatus\": \"T\",\n \"gspGroupId\": \"_F\",\n \"gspGroupEfd\": \"19970930\",\n \"dataAggregatorMpid\": \"UDMS\",\n \"dataAggregatorEfd\": \"20220203\",\n \"dataCollectorMpid\": \"UDMS\",\n \"dataCollectorEfd\": \"20220203\",\n \"supplierMpid\": \"TRAM\",\n \"supplierEfd\": \"20220203\",\n \"energisationStatusEfd\": \"20220203\",\n \"meterOperatorMpid\": \"AESM\",\n \"meterOperatorEfd\": \"20230317\",\n \"measurementClass\": \"A\",\n \"measurementClassEfd\": \"20220203\",\n \"greenDealInEffect\": \"0\",\n \"smsoMpid\": null,\n \"smsoEfd\": null,\n \"dccServiceFlag\": null,\n \"dccServiceFlagEfd\": null,\n \"ihdStatus\": null,\n \"ihdStatusEfd\": null,\n \"smetsVersion\": null,\n \"distributorMpid\": \"NEEB\",\n \"meteredIndicator\": \"T\",\n \"meteredIndicatorEfd\": \"20180316\",\n \"meteredIndicatorEtd\": null,\n \"consumerType\": null,\n \"domesticConsumerIndicator\": \"F\",\n \"relationshipStatusIndicator\": \"None\",\n \"rmpState\": \"O\",\n \"rmpEfd\": \"19971001\",\n \"energyDirection\": null,\n \"energyDirectionEfd\": null,\n \"energyDirectionEtd\": null,\n \"connectionType\": null,\n \"connectionTypeEfd\": null,\n \"connectionTypeEtd\": null,\n \"cssSupplierMpid\": null,\n \"cssSupplyStartDate\": null,\n \"standardSettlementConfigurationOptions\": [\n \"Single\"\n ]\n },\n \"meters\": [\n {\n \"mpancore\": \"1591058900229\",\n \"meterSerialNumber\": \"217212041\",\n \"meterInstallDate\": \"20170901\",\n \"meterType\": \"RCAMY\",\n \"mapMpid\": \"UFUN\",\n \"mapMpidEfd\": \"20170901\",\n \"installingSupplierMpid\": \"SOUT\",\n \"meterLocation\": null,\n \"registerDigits\": null,\n \"esmeId\": null\n }\n ]\n },\n \"errors\": null\n}"}],"_postman_id":"ef939c74-33ad-4c1f-82f1-d86d10a98b0c"},{"name":"/addresses/gas/:postcode","id":"a0f5e922-58da-4579-be27-6bf9ce18a5ab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{VORTEX_ENDPOINT}}/addresses/gas/NE1 3RQ","urlObject":{"path":["addresses","gas","NE1 3RQ"],"host":["{{VORTEX_ENDPOINT}}"],"query":[],"variable":[]}},"response":[{"id":"ee22e67e-a70f-4c3c-ba6e-ffd3036b4077","name":"/addresses/gas/:postcode","originalRequest":{"method":"GET","header":[],"url":"{{VORTEX_ENDPOINT}}/addresses/gas/NE1 3RQ"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"X-RateLimit-Limit","value":"100"},{"key":"X-RateLimit-Remaining","value":"99"},{"key":"Date","value":"Fri, 03 Nov 2023 17:42:39 GMT"},{"key":"X-RateLimit-Reset","value":"1699033360"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"2349"},{"key":"ETag","value":"W/\"92d-m8W4Lq/b2AtDvZPLskkn5rD8hSk\""},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"addressId\": \"0070189447\",\n \"uprn\": 999006764100,\n \"country\": \"GB\",\n \"county\": \"Tyne And Wear\",\n \"deliveryPointAlias\": \"\",\n \"dependentLocality\": \"\",\n \"dependentStreet\": \"\",\n \"doubDependentLocality\": \"\",\n \"houseName\": \"FORMER OLD CORONERS COURT BUILDING\",\n \"houseNumber\": \"\",\n \"poBoxNumber\": \"\",\n \"postcode\": \"NE1 3RQ\",\n \"street\": \"THE CLOSE\",\n \"subBuildingName\": \"PREMIUM BAR\",\n \"town\": \"NEWCASTLE UPON TYNE\"\n },\n {\n \"addressId\": \"0070189447\",\n \"uprn\": 999006764100,\n \"country\": \"\",\n \"county\": \"\",\n \"deliveryPointAlias\": \"\",\n \"dependentLocality\": \"\",\n \"dependentStreet\": \"\",\n \"doubDependentLocality\": \"\",\n \"houseName\": \"FORMER OLD CORONERS COURT BUILDING\",\n \"houseNumber\": \"\",\n \"poBoxNumber\": \"\",\n \"postcode\": \"NE1 3RQ\",\n \"street\": \"THE CLOSE\",\n \"subBuildingName\": \"PREMIUM BAR\",\n \"town\": \"NEWCASTLE UPON TYNE\"\n },\n {\n \"addressId\": \"0088626375\",\n \"uprn\": 999004527944,\n \"country\": \"GB\",\n \"county\": \"\",\n \"deliveryPointAlias\": \"\",\n \"dependentLocality\": \"\",\n \"dependentStreet\": \"\",\n \"doubDependentLocality\": \"\",\n \"houseName\": \"BEEFEATER\",\n \"houseNumber\": \"35\",\n \"poBoxNumber\": \"\",\n \"postcode\": \"NE1 3RQ\",\n \"street\": \"CLOSE\",\n \"subBuildingName\": \"\",\n \"town\": \"NEWCASTLE UPON TYNE\"\n },\n {\n \"addressId\": \"0088626375\",\n \"uprn\": 999004527944,\n \"country\": \"\",\n \"county\": \"\",\n \"deliveryPointAlias\": \"\",\n \"dependentLocality\": \"\",\n \"dependentStreet\": \"\",\n \"doubDependentLocality\": \"\",\n \"houseName\": \"BEEFEATER;35\",\n \"houseNumber\": \"\",\n \"poBoxNumber\": \"\",\n \"postcode\": \"NE1 3RQ\",\n \"street\": \"CLOSE\",\n \"subBuildingName\": \"\",\n \"town\": \"NEWCASTLE UPON TYNE\"\n },\n {\n \"addressId\": \"0000694582\",\n \"uprn\": 4510079380,\n \"country\": \"GB\",\n \"county\": \"\",\n \"deliveryPointAlias\": \"ULTIMATE LEISURE LTD\",\n \"dependentLocality\": \"\",\n \"dependentStreet\": \"\",\n \"doubDependentLocality\": \"\",\n \"houseName\": \"NEPTUNE HOUSE\",\n \"houseNumber\": \"1\",\n \"poBoxNumber\": \"\",\n \"postcode\": \"NE1 3RQ\",\n \"street\": \"CLOSE\",\n \"subBuildingName\": \"\",\n \"town\": \"NEWCASTLE UPON TYNE\"\n },\n {\n \"addressId\": \"0000694582\",\n \"uprn\": 4510079380,\n \"country\": \"\",\n \"county\": \"\",\n \"deliveryPointAlias\": \"\",\n \"dependentLocality\": \"\",\n \"dependentStreet\": \"\",\n \"doubDependentLocality\": \"\",\n \"houseName\": \"NEPTUNE HOUSE\",\n \"houseNumber\": \"\",\n \"poBoxNumber\": \"\",\n \"postcode\": \"NE1 3RQ\",\n \"street\": \"CLOSE\",\n \"subBuildingName\": \"\",\n \"town\": \"NEWCASTLE UPON TYNE\"\n },\n {\n \"addressId\": \"0000694582\",\n \"uprn\": 4510079380,\n \"country\": \"\",\n \"county\": \"\",\n \"deliveryPointAlias\": \"\",\n \"dependentLocality\": \"\",\n \"dependentStreet\": \"\",\n \"doubDependentLocality\": \"\",\n \"houseName\": \"\",\n \"houseNumber\": \"1\",\n \"poBoxNumber\": \"\",\n \"postcode\": \"NE1 3RQ\",\n \"street\": \"CLOSE\",\n \"subBuildingName\": \"\",\n \"town\": \"NEWCASTLE UPON TYNE\"\n }\n ],\n \"errors\": null\n}"}],"_postman_id":"a0f5e922-58da-4579-be27-6bf9ce18a5ab"},{"name":"/addresses/gas/:mprn","id":"d5d870b5-7b06-413d-b089-f0a11c8e71a9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{VORTEX_ENDPOINT}}/addresses/gas/0070189447","urlObject":{"path":["addresses","gas","0070189447"],"host":["{{VORTEX_ENDPOINT}}"],"query":[],"variable":[]}},"response":[{"id":"ecfbe7e5-79ec-4df6-b2a6-cb4b324c8e72","name":"/addresses/gas/:mprn","originalRequest":{"method":"GET","header":[],"url":"{{VORTEX_ENDPOINT}}/addresses/gas/0070189447"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"X-RateLimit-Limit","value":"100"},{"key":"X-RateLimit-Remaining","value":"99"},{"key":"Date","value":"Fri, 03 Nov 2023 17:42:57 GMT"},{"key":"X-RateLimit-Reset","value":"1699033380"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1919"},{"key":"ETag","value":"W/\"77f-o7y1KybCl/36QiriqHciMp1ZuuY\""},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"addressId\": \"0070189447\",\n \"houseName\": \"FORMER OLD CORONERS COURT BUILDING\",\n \"houseNumber\": \"\",\n \"country\": \"GB\",\n \"county\": \"Tyne And Wear\",\n \"currentSupplierId\": \"TRM\",\n \"currentSupplierRegEffectiveDate\": \"20220129\",\n \"pendingSupplierRegEffectiveDate\": \"\",\n \"deliveryPointAlias\": \"\",\n \"dependentStreet\": \"\",\n \"dmq\": null,\n \"doubleDependentLocality\": \"\",\n \"gasTransportId\": \"GT3\",\n \"ldzId\": \"NO\",\n \"meterCapacity\": \"6\",\n \"meterMechanismCode\": \"CR\",\n \"meterSerialNumber\": \"G4K00089371301\",\n \"mpaq\": 2026,\n \"mprn\": \"9213027309\",\n \"ndmq\": 17,\n \"poBoxNumber\": \"\",\n \"postTown\": \"NEWCASTLE UPON TYNE\",\n \"postcode\": \"NE1 3RQ\",\n \"smartEquipmentTechnicalCode\": \"\",\n \"street\": \"THE CLOSE\",\n \"subBuildingName\": \"PREMIUM BAR\",\n \"icuktsflg\": \"\",\n \"market_sector_code\": \"I\",\n \"meter_point_status\": \"LI\",\n \"installing_supplier_id\": \"\",\n \"meter_installation_date\": \"20131016\",\n \"meter_year_of_manufacture\": \"2013\",\n \"amr_indicator\": \"Y\",\n \"formula_year_supply_meter_point_aq\": \"24070.0000000\",\n \"exit_zone\": \"NO1\",\n \"meter_device_status\": \"LI\",\n \"meter_type\": \"Synthetic\",\n \"meter_number_of_dials\": \"05\",\n \"meter_imperial_indicator\": \"N\",\n \"meter_manufacturer\": \"KROMSCHRODER\",\n \"meter_model\": \"G4\",\n \"meter_units\": \"1\",\n \"meter_location\": \"01\",\n \"correction_factor\": \"1.02264\",\n \"convertor_indicator\": \"N\",\n \"incoming_supplier\": \"\",\n \"previous_supplier_name\": \"Shell Energy UK Limited\",\n \"previous_supplier_short_code\": \"HUD\",\n \"network_name\": \"Northern Gas Networks Limited.\",\n \"current_supplier_name\": \"Switch Business Gas and Power Ltd\",\n \"last_meter_read_date\": \"20230714\",\n \"last_meter_read_type\": \"E\",\n \"last_meter_read_value\": \"20008\",\n \"addressSource\": \"MPL\",\n \"uprn\": 999006764100,\n \"relAddress\": [\n {\n \"primaryName\": \"FORMER OLD CORONERS COURT BUILDING\",\n \"secondaryName\": \"PREMIUM BAR\",\n \"street1\": \"THE CLOSE\",\n \"street2\": \" \",\n \"locality1\": \" \",\n \"locality2\": \" \",\n \"town\": \"NEWCASTLE UPON TYNE\",\n \"postcode\": \"NE1 3RQ\",\n \"logicalStatus\": null,\n \"language\": \"\",\n \"organisation\": \"\",\n \"addressType\": \"\",\n \"confidenceScore\": \"56\",\n \"classification\": \"\",\n \"latitude\": null,\n \"longitude\": null\n }\n ]\n }\n ],\n \"errors\": null\n}"}],"_postman_id":"d5d870b5-7b06-413d-b089-f0a11c8e71a9"}],"id":"4e1f44e9-1556-4df7-848a-6aa3b5e720b4","description":"Leverage this endpoint to obtain up-to-date address and meter information from the industry.
\n","_postman_id":"4e1f44e9-1556-4df7-848a-6aa3b5e720b4"}]}