NESO Data Portal data contract | PatchOps Knowledge

Provenance

PublisherNESO Data Portal

API basehttps://api.neso.energy/api/3/action

Freshness & coverage

FreshnessFreshness not declared

GeographicNot declared

TemporalNot declared

AuthenticationNo credentials required

Methods (3)

listPackages

read

List or search NESO CKAN data packages.

Input schema

{
  "type": "object",
  "properties": {
    "endpoint": {
      "type": "string"
    },
    "search": {
      "type": "string"
    },
    "rows": {
      "type": "number"
    },
    "start": {
      "type": "number"
    },
    "query": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    }
  },
  "additionalProperties": false
}

packageShow

unknown

Get a NESO CKAN package metadata and resources.

Required paramsid or endpoint

Input schema

{
  "type": "object",
  "properties": {
    "endpoint": {
      "type": "string"
    },
    "id": {
      "type": "string"
    },
    "query": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    }
  },
  "additionalProperties": false,
  "allOf": [
    {
      "anyOf": [
        {
          "required": [
            "id"
          ]
        },
        {
          "required": [
            "endpoint"
          ]
        }
      ]
    }
  ]
}

datastoreSearch

read

Query rows from a NESO CKAN datastore resource.

Required paramsresourceId or sql or endpoint

Input schema

{
  "type": "object",
  "properties": {
    "endpoint": {
      "type": "string"
    },
    "resourceId": {
      "type": "string"
    },
    "sql": {
      "type": "string"
    },
    "limit": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "fullText": {
      "type": "string"
    },
    "filters": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    },
    "fields": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "sort": {
      "type": "string"
    },
    "query": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    }
  },
  "additionalProperties": false,
  "allOf": [
    {
      "anyOf": [
        {
          "required": [
            "resourceId"
          ]
        },
        {
          "required": [
            "sql"
          ]
        },
        {
          "required": [
            "endpoint"
          ]
        }
      ]
    }
  ]
}