OpenAPI reference

Receiver Tariff

GET/tariffs/{country_code}/{party_id}/{tariff_id}

Retrieve a Tariff as stored in the receiver's system.

API: OCPI 2.2.1 (eMSP) · Module: Tariffs (eMSP)
Base path: /tariffs · Base URL: https://ocpi-api.gridos.co/ocpi/emsp/2.2.1

Overview

GET /tariffs/{country_code}/{party_id}/{tariff_id}

Absolute URL: https://ocpi-api.gridos.co/ocpi/emsp/2.2.1/tariffs/{country_code}/{party_id}/{tariff_id}

Retrieve a Tariff as stored in the receiver's system.

Requires authentication. Use Authorization: Token <token>. See OCPI credentials.

How to call

Quick Shell sample (set OCPI_TOKEN when auth is required). Full Python and TypeScript under Examples.

1curl -sS -X GET 'https://ocpi-api.gridos.co/ocpi/emsp/2.2.1/tariffs/NL/ABC/TARIFF1' \
2  -H "Authorization: Token $OCPI_TOKEN"

Request

Path parameters

Name	Type	Required	Description
`country_code`	`string`	Yes	ISO-3166 alpha-2 country code (uppercase).
`party_id`	`string`	Yes	CPO/eMSP party ID (ISO-15118, 3 uppercase alphanumerics).
`tariff_id`	`string`	Yes	Tariff.id of the Tariff object.

Responses

Status	Description	Schema
`200`	Successful Response	`TariffResponse`
`401`	Unauthorized	`—`
`404`	Not Found	`—`
`422`	Validation Error	`HTTPValidationError`

`200` — successful response

application/json

Schema: TariffResponse

Field	Type	Required	Description
`status_code`	`integer`	No	Default: `1000`
`status_message`	`string`	No	—
`timestamp`	`string (date-time)`	No	—
`data`	`TariffOut`	No	`TariffOut`

Response example

1{
2  "status_code": 1000,
3  "status_message": "Success",
4  "timestamp": "2024-01-15T10:00:00Z",
5  "data": {
6    "country_code": "NL",
7    "currency": "EUR",
8    "elements": [
9      {
10        "price_components": [
11          {
12            "price": 0.2,
13            "step_size": 1,
14            "type": "ENERGY",
15            "vat": 21
16          }
17        ]
18      }
19    ],
20    "end_date_time": "2024-12-31T23:59:59Z",
21    "energy_mix": {
22      "energy_sources": [
23        {
24          "percentage": 100,
25          "source": "SOLAR"
26        }
27      ],
28      "is_green_energy": true
29    },
30    "id": "TARIFF-001",
31    "last_updated": "2024-01-15T10:00:00Z",
32    "max_price": {
33      "excl_vat": 50,
34      "incl_vat": 60.5
35    },
36    "min_price": {
37      "excl_vat": 0.5,
38      "incl_vat": 0.605
39    },
40    "party_id": "CPO",
41    "start_date_time": "2024-01-01T00:00:00Z",
42    "tariff_alt_text": [
43      {
44        "language": "en",
45        "text": "Standard tariff €0.20/kWh"
46      }
47    ],
48    "tariff_alt_url": "https://example.com/tariffs/TARIFF-001",
49    "type": "REGULAR"
50  }
51}

`401` — unauthorized

application/json

Response example

1{
2  "status_code": 2001,
3  "status_message": "Unauthorized",
4  "timestamp": "2025-01-01T00:00:00Z"
5}

`404` — not found

application/json

Response example

1{
2  "status_code": 2001,
3  "status_message": "Tariff not found",
4  "timestamp": "2025-01-01T00:00:00Z"
5}

`422` — validation error

application/json

Schema: HTTPValidationError

Field	Type	Required	Description
`detail`	`ValidationError[]`	No	`Detail`

Response example

1{
2  "detail": [
3    {
4      "loc": [],
5      "msg": "string",
6      "type": "string",
7      "input": {
8        "_type": "Input"
9      },
10      "ctx": {
11        "_type": "Context"
12      }
13    }
14  ]
15}

Examples

Shell, Python, and TypeScript (set OCPI_TOKEN when auth is required).

1curl -sS -X GET 'https://ocpi-api.gridos.co/ocpi/emsp/2.2.1/tariffs/NL/ABC/TARIFF1' \
2  -H "Authorization: Token $OCPI_TOKEN"

OpenAPI reference

Receiver Tariff

GET/tariffs/{country_code}/{party_id}/{tariff_id}

Retrieve a Tariff as stored in the receiver's system.

API: OCPI 2.2.1 (eMSP) · Module: Tariffs (eMSP)
Base path: /tariffs · Base URL: https://ocpi-api.gridos.co/ocpi/emsp/2.2.1

Overview

GET /tariffs/{country_code}/{party_id}/{tariff_id}

Absolute URL: https://ocpi-api.gridos.co/ocpi/emsp/2.2.1/tariffs/{country_code}/{party_id}/{tariff_id}

Retrieve a Tariff as stored in the receiver's system.

Requires authentication. Use Authorization: Token <token>. See OCPI credentials.

How to call

Quick Shell sample (set OCPI_TOKEN when auth is required). Full Python and TypeScript under Examples.

1curl -sS -X GET 'https://ocpi-api.gridos.co/ocpi/emsp/2.2.1/tariffs/NL/ABC/TARIFF1' \
2  -H "Authorization: Token $OCPI_TOKEN"

Request

Path parameters

Name	Type	Required	Description
`country_code`	`string`	Yes	ISO-3166 alpha-2 country code (uppercase).
`party_id`	`string`	Yes	CPO/eMSP party ID (ISO-15118, 3 uppercase alphanumerics).
`tariff_id`	`string`	Yes	Tariff.id of the Tariff object.

Responses

Status	Description	Schema
`200`	Successful Response	`TariffResponse`
`401`	Unauthorized	`—`
`404`	Not Found	`—`
`422`	Validation Error	`HTTPValidationError`

`200` — successful response

application/json

Schema: TariffResponse

Field	Type	Required	Description
`status_code`	`integer`	No	Default: `1000`
`status_message`	`string`	No	—
`timestamp`	`string (date-time)`	No	—
`data`	`TariffOut`	No	`TariffOut`

Response example

1{
2  "status_code": 1000,
3  "status_message": "Success",
4  "timestamp": "2024-01-15T10:00:00Z",
5  "data": {
6    "country_code": "NL",
7    "currency": "EUR",
8    "elements": [
9      {
10        "price_components": [
11          {
12            "price": 0.2,
13            "step_size": 1,
14            "type": "ENERGY",
15            "vat": 21
16          }
17        ]
18      }
19    ],
20    "end_date_time": "2024-12-31T23:59:59Z",
21    "energy_mix": {
22      "energy_sources": [
23        {
24          "percentage": 100,
25          "source": "SOLAR"
26        }
27      ],
28      "is_green_energy": true
29    },
30    "id": "TARIFF-001",
31    "last_updated": "2024-01-15T10:00:00Z",
32    "max_price": {
33      "excl_vat": 50,
34      "incl_vat": 60.5
35    },
36    "min_price": {
37      "excl_vat": 0.5,
38      "incl_vat": 0.605
39    },
40    "party_id": "CPO",
41    "start_date_time": "2024-01-01T00:00:00Z",
42    "tariff_alt_text": [
43      {
44        "language": "en",
45        "text": "Standard tariff €0.20/kWh"
46      }
47    ],
48    "tariff_alt_url": "https://example.com/tariffs/TARIFF-001",
49    "type": "REGULAR"
50  }
51}

`401` — unauthorized

application/json

Response example

1{
2  "status_code": 2001,
3  "status_message": "Unauthorized",
4  "timestamp": "2025-01-01T00:00:00Z"
5}

`404` — not found

application/json

Response example

1{
2  "status_code": 2001,
3  "status_message": "Tariff not found",
4  "timestamp": "2025-01-01T00:00:00Z"
5}

`422` — validation error

application/json

Schema: HTTPValidationError

Field	Type	Required	Description
`detail`	`ValidationError[]`	No	`Detail`

Response example

1{
2  "detail": [
3    {
4      "loc": [],
5      "msg": "string",
6      "type": "string",
7      "input": {
8        "_type": "Input"
9      },
10      "ctx": {
11        "_type": "Context"
12      }
13    }
14  ]
15}

Examples

Shell, Python, and TypeScript (set OCPI_TOKEN when auth is required).

1curl -sS -X GET 'https://ocpi-api.gridos.co/ocpi/emsp/2.2.1/tariffs/NL/ABC/TARIFF1' \
2  -H "Authorization: Token $OCPI_TOKEN"

Receiver Tariff

Overview

How to call

Request

Path parameters

Responses

`200` — successful response

`401` — unauthorized

`404` — not found

`422` — validation error

Examples

Is this helpful?

AI Tools

On this page

Receiver Tariff

Overview

How to call

Request

Path parameters

Responses

`200` — successful response

`401` — unauthorized

`404` — not found

`422` — validation error

Examples

Is this helpful?

AI Tools

On this page