Python

import os
from datetime import datetime
from gcore import Gcore

client = Gcore(
    api_key=os.environ.get("GCORE_API_KEY"),  # This is the default and can be omitted
)
cost_report_aggregated = client.cloud.cost_reports.get_aggregated(
    time_from=datetime.fromisoformat("2023-01-01T00:00:00"),
    time_to=datetime.fromisoformat("2023-02-01T00:00:00"),
)
print(cost_report_aggregated.count)

package main

import (
	"context"
	"fmt"
	"time"

	"github.com/G-Core/gcore-go"
	"github.com/G-Core/gcore-go/cloud"
	"github.com/G-Core/gcore-go/option"
)

func main() {
	client := gcore.NewClient(
		option.WithAPIKey("My API Key"),
	)
	costReportAggregated, err := client.Cloud.CostReports.GetAggregated(context.TODO(), cloud.CostReportGetAggregatedParams{
		TimeFrom: time.Now(),
		TimeTo:   time.Now(),
	})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", costReportAggregated.Count)
}

curl --request POST \
  --url https://api.gcore.com/cloud/v1/cost_report/totals \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "projects": [
    16,
    17,
    18,
    19,
    20
  ],
  "regions": [
    18,
    76
  ],
  "response_format": "json",
  "schema_filter": {
    "field": "flavor",
    "type": "instance",
    "values": [
      "g1-standard-1-2"
    ]
  },
  "tags": {
    "condition_type": "OR",
    "conditions": [
      {
        "key": "os_version",
        "strict": true,
        "value": "22.04"
      },
      {
        "key": "os_version",
        "strict": true,
        "value": "23.04"
      }
    ]
  },
  "time_from": "2024-08-01T00:00:00",
  "time_to": "2024-09-01T00:00:00",
  "types": [
    "egress_traffic",
    "instance"
  ]
}
'

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    projects: [16, 17, 18, 19, 20],
    regions: [18, 76],
    response_format: 'json',
    schema_filter: {field: 'flavor', type: 'instance', values: ['g1-standard-1-2']},
    tags: {
      condition_type: 'OR',
      conditions: [
        {key: 'os_version', strict: true, value: '22.04'},
        {key: 'os_version', strict: true, value: '23.04'}
      ]
    },
    time_from: '2024-08-01T00:00:00',
    time_to: '2024-09-01T00:00:00',
    types: ['egress_traffic', 'instance']
  })
};

fetch('https://api.gcore.com/cloud/v1/cost_report/totals', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.gcore.com/cloud/v1/cost_report/totals",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'projects' => [
        16,
        17,
        18,
        19,
        20
    ],
    'regions' => [
        18,
        76
    ],
    'response_format' => 'json',
    'schema_filter' => [
        'field' => 'flavor',
        'type' => 'instance',
        'values' => [
                'g1-standard-1-2'
        ]
    ],
    'tags' => [
        'condition_type' => 'OR',
        'conditions' => [
                [
                                'key' => 'os_version',
                                'strict' => true,
                                'value' => '22.04'
                ],
                [
                                'key' => 'os_version',
                                'strict' => true,
                                'value' => '23.04'
                ]
        ]
    ],
    'time_from' => '2024-08-01T00:00:00',
    'time_to' => '2024-09-01T00:00:00',
    'types' => [
        'egress_traffic',
        'instance'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.post("https://api.gcore.com/cloud/v1/cost_report/totals")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"projects\": [\n    16,\n    17,\n    18,\n    19,\n    20\n  ],\n  \"regions\": [\n    18,\n    76\n  ],\n  \"response_format\": \"json\",\n  \"schema_filter\": {\n    \"field\": \"flavor\",\n    \"type\": \"instance\",\n    \"values\": [\n      \"g1-standard-1-2\"\n    ]\n  },\n  \"tags\": {\n    \"condition_type\": \"OR\",\n    \"conditions\": [\n      {\n        \"key\": \"os_version\",\n        \"strict\": true,\n        \"value\": \"22.04\"\n      },\n      {\n        \"key\": \"os_version\",\n        \"strict\": true,\n        \"value\": \"23.04\"\n      }\n    ]\n  },\n  \"time_from\": \"2024-08-01T00:00:00\",\n  \"time_to\": \"2024-09-01T00:00:00\",\n  \"types\": [\n    \"egress_traffic\",\n    \"instance\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.gcore.com/cloud/v1/cost_report/totals")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"projects\": [\n    16,\n    17,\n    18,\n    19,\n    20\n  ],\n  \"regions\": [\n    18,\n    76\n  ],\n  \"response_format\": \"json\",\n  \"schema_filter\": {\n    \"field\": \"flavor\",\n    \"type\": \"instance\",\n    \"values\": [\n      \"g1-standard-1-2\"\n    ]\n  },\n  \"tags\": {\n    \"condition_type\": \"OR\",\n    \"conditions\": [\n      {\n        \"key\": \"os_version\",\n        \"strict\": true,\n        \"value\": \"22.04\"\n      },\n      {\n        \"key\": \"os_version\",\n        \"strict\": true,\n        \"value\": \"23.04\"\n      }\n    ]\n  },\n  \"time_from\": \"2024-08-01T00:00:00\",\n  \"time_to\": \"2024-09-01T00:00:00\",\n  \"types\": [\n    \"egress_traffic\",\n    \"instance\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "count": 1,
  "results": [
    {
      "billing_feature_name": "AI Infrastructure: bm3-ai-1xlarge-h100-80-8 (2 x Intel Xeon 8480+, 2TB RAM, 8x3.84 TB NVMe, 8x Nvidia H100, IB 3.2 Tbit/s, 2x100Gbit/s Ethernet)  Luxembourg-2 - PAYG",
      "billing_metric_name": "bm3-ai-1xlarge-h100-80-8_min",
      "billing_value": 1000,
      "billing_value_unit": "minutes",
      "cost": 1000,
      "currency": "EUR",
      "err": null,
      "flavor": "bm3-ai-1xlarge-h100-80-8",
      "region": 76,
      "region_id": 76,
      "type": "<string>"
    }
  ]
}

Cost Reports

Get cost report totals (pay-as-you-go only)

Get cost report totals (aggregated costs) for a given period. Requested period should not exceed 31 days.

Note: This report assumes there are no active commit features in the billing plan. If there are active commit features (pre-paid resources) in your plan, use /v1/reservation_cost_report/totals, as the results from this report will not be accurate.

Data from the past hour may not reflect the full set of statistics. For the most complete and accurate results, we recommend accessing the data at least one hour after the relevant time period. Updates are generally available within a 24-hour window, though timing can vary. Scheduled maintenance or other exceptions may occasionally cause delays beyond 24 hours.

POST

cloud

cost_report

totals

Python

import os
from datetime import datetime
from gcore import Gcore

client = Gcore(
    api_key=os.environ.get("GCORE_API_KEY"),  # This is the default and can be omitted
)
cost_report_aggregated = client.cloud.cost_reports.get_aggregated(
    time_from=datetime.fromisoformat("2023-01-01T00:00:00"),
    time_to=datetime.fromisoformat("2023-02-01T00:00:00"),
)
print(cost_report_aggregated.count)

package main

import (
	"context"
	"fmt"
	"time"

	"github.com/G-Core/gcore-go"
	"github.com/G-Core/gcore-go/cloud"
	"github.com/G-Core/gcore-go/option"
)

func main() {
	client := gcore.NewClient(
		option.WithAPIKey("My API Key"),
	)
	costReportAggregated, err := client.Cloud.CostReports.GetAggregated(context.TODO(), cloud.CostReportGetAggregatedParams{
		TimeFrom: time.Now(),
		TimeTo:   time.Now(),
	})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", costReportAggregated.Count)
}

curl --request POST \
  --url https://api.gcore.com/cloud/v1/cost_report/totals \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "projects": [
    16,
    17,
    18,
    19,
    20
  ],
  "regions": [
    18,
    76
  ],
  "response_format": "json",
  "schema_filter": {
    "field": "flavor",
    "type": "instance",
    "values": [
      "g1-standard-1-2"
    ]
  },
  "tags": {
    "condition_type": "OR",
    "conditions": [
      {
        "key": "os_version",
        "strict": true,
        "value": "22.04"
      },
      {
        "key": "os_version",
        "strict": true,
        "value": "23.04"
      }
    ]
  },
  "time_from": "2024-08-01T00:00:00",
  "time_to": "2024-09-01T00:00:00",
  "types": [
    "egress_traffic",
    "instance"
  ]
}
'

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    projects: [16, 17, 18, 19, 20],
    regions: [18, 76],
    response_format: 'json',
    schema_filter: {field: 'flavor', type: 'instance', values: ['g1-standard-1-2']},
    tags: {
      condition_type: 'OR',
      conditions: [
        {key: 'os_version', strict: true, value: '22.04'},
        {key: 'os_version', strict: true, value: '23.04'}
      ]
    },
    time_from: '2024-08-01T00:00:00',
    time_to: '2024-09-01T00:00:00',
    types: ['egress_traffic', 'instance']
  })
};

fetch('https://api.gcore.com/cloud/v1/cost_report/totals', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.gcore.com/cloud/v1/cost_report/totals",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'projects' => [
        16,
        17,
        18,
        19,
        20
    ],
    'regions' => [
        18,
        76
    ],
    'response_format' => 'json',
    'schema_filter' => [
        'field' => 'flavor',
        'type' => 'instance',
        'values' => [
                'g1-standard-1-2'
        ]
    ],
    'tags' => [
        'condition_type' => 'OR',
        'conditions' => [
                [
                                'key' => 'os_version',
                                'strict' => true,
                                'value' => '22.04'
                ],
                [
                                'key' => 'os_version',
                                'strict' => true,
                                'value' => '23.04'
                ]
        ]
    ],
    'time_from' => '2024-08-01T00:00:00',
    'time_to' => '2024-09-01T00:00:00',
    'types' => [
        'egress_traffic',
        'instance'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.post("https://api.gcore.com/cloud/v1/cost_report/totals")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"projects\": [\n    16,\n    17,\n    18,\n    19,\n    20\n  ],\n  \"regions\": [\n    18,\n    76\n  ],\n  \"response_format\": \"json\",\n  \"schema_filter\": {\n    \"field\": \"flavor\",\n    \"type\": \"instance\",\n    \"values\": [\n      \"g1-standard-1-2\"\n    ]\n  },\n  \"tags\": {\n    \"condition_type\": \"OR\",\n    \"conditions\": [\n      {\n        \"key\": \"os_version\",\n        \"strict\": true,\n        \"value\": \"22.04\"\n      },\n      {\n        \"key\": \"os_version\",\n        \"strict\": true,\n        \"value\": \"23.04\"\n      }\n    ]\n  },\n  \"time_from\": \"2024-08-01T00:00:00\",\n  \"time_to\": \"2024-09-01T00:00:00\",\n  \"types\": [\n    \"egress_traffic\",\n    \"instance\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.gcore.com/cloud/v1/cost_report/totals")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"projects\": [\n    16,\n    17,\n    18,\n    19,\n    20\n  ],\n  \"regions\": [\n    18,\n    76\n  ],\n  \"response_format\": \"json\",\n  \"schema_filter\": {\n    \"field\": \"flavor\",\n    \"type\": \"instance\",\n    \"values\": [\n      \"g1-standard-1-2\"\n    ]\n  },\n  \"tags\": {\n    \"condition_type\": \"OR\",\n    \"conditions\": [\n      {\n        \"key\": \"os_version\",\n        \"strict\": true,\n        \"value\": \"22.04\"\n      },\n      {\n        \"key\": \"os_version\",\n        \"strict\": true,\n        \"value\": \"23.04\"\n      }\n    ]\n  },\n  \"time_from\": \"2024-08-01T00:00:00\",\n  \"time_to\": \"2024-09-01T00:00:00\",\n  \"types\": [\n    \"egress_traffic\",\n    \"instance\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "count": 1,
  "results": [
    {
      "billing_feature_name": "AI Infrastructure: bm3-ai-1xlarge-h100-80-8 (2 x Intel Xeon 8480+, 2TB RAM, 8x3.84 TB NVMe, 8x Nvidia H100, IB 3.2 Tbit/s, 2x100Gbit/s Ethernet)  Luxembourg-2 - PAYG",
      "billing_metric_name": "bm3-ai-1xlarge-h100-80-8_min",
      "billing_value": 1000,
      "billing_value_unit": "minutes",
      "cost": 1000,
      "currency": "EUR",
      "err": null,
      "flavor": "bm3-ai-1xlarge-h100-80-8",
      "region": 76,
      "region_id": 76,
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234_abcdef

Body

application/json

time_from

string<date-time>

required

The start date of the report period (ISO 8601). The report starts from the beginning of this day in UTC.

Example:

"2023-01-01T00:00:00Z"

time_to

string<date-time>

required

The end date of the report period (ISO 8601). The report ends just before the beginning of this day in UTC.

Example:

"2023-02-01T00:00:00Z"

enable_last_day

boolean

default:false

Expenses for the last specified day are taken into account. As the default, False.

Example:

false

projects

integer[]

List of project IDs

Example:

[16, 17, 18, 19, 20]

regions

integer[]

List of region IDs.

Example:

[1, 2, 3]

response_format

enum<string>

default:json

Format of the response (csv or json).

Available options:

csv_totals,

json

Examples:

"csv_totals"

"json"

rounding

boolean

default:true

Round cost values to 5 decimal places. When false, returns full precision.

schema_filter

SchemaFilterSnapshotSerializer · object

Extended filter for field filtering.

SchemaFilterSnapshotSerializer
SchemaFilterInstanceSerializer
SchemaFilterAiClusterSerializer
SchemaFilterAiVirtualClusterSerializer
SchemaFilterBasicVmSerializer
SchemaFilterBaremetalSerializer
SchemaFilterVolumeSerializer
SchemaFilterFileShareSerializer
SchemaFilterImageSerializer
SchemaFilterFloatingIpSerializer
SchemaFilterEgressTrafficSerializer
SchemaFilterLoadBalancerSerializer
SchemaFilterExternalIpSerializer
SchemaFilterBackupSerializer
SchemaFilterLogIndexSerializer
SchemaFilterFunctionsSerializer
SchemaFilterFunctionsCallsSerializer
SchemaFilterFunctionsTrafficSerializer
SchemaFilterContainersSerializer
SchemaFilterInferenceSerializer
SchemaFilterDBAASPostgreSQLVolumeSerializer
SchemaFilterDBAASPostgreSQLPublicNetworkSerializer
SchemaFilterDBAASPostgreSQLCPUSerializer
SchemaFilterDBAASPostgreSQLMemorySerializer
SchemaFilterDBAASPostgreSQLPoolerSerializer

Show child attributes

Example:

{
  "field": "flavor",
  "type": "instance",
  "values": ["g1-standard-1-2"]
}

Response

200 - application/json

count

integer

required

Count of returned totals

Required range: x >= 0

Example:

1

price_status

enum<string>

required

Price status for the UI, type: string

Available options:

error,

hide,

show

results

(TotalAiClusterWithCostSerializer · object | TotalAiVirtualClusterWithCostSerializer · object | TotalBaremetalWithCostSerializer · object | TotalBasicVmWithCostSerializer · object | TotalBackupWithCostSerializer · object | TotalContainerWithCostSerializer · object | TotalEgressTrafficWithCostSerializer · object | TotalExternalIpWithCostSerializer · object | TotalFileShareWithCostSerializer · object | TotalFloatingIpWithCostSerializer · object | TotalFunctionsWithCostSerializer · object | TotalFunctionCallsWithCostSerializer · object | TotalFunctionEgressTrafficWithCostSerializer · object | TotalImagesWithCostSerializer · object | TotalInferenceWithCostSerializer · object | TotalInstanceWithCostSerializer · object | TotalLoadBalancerWithCostSerializer · object | TotalLogIndexWithCostSerializer · object | TotalSnapshotWithCostSerializer · object | TotalVolumeWithCostSerializer · object | TotalDBAASPostgreSQLPoolerWithCostSerializer · object | TotalDBAASPostgreSQLMemoryWithCostSerializer · object | TotalDBAASPostgreSQLPublicNetworkWithCostSerializer · object | TotalDBAASPostgreSQLCPUWithCostSerializer · object | TotalDBAASPostgreSQLVolumeWithCostSerializer · object)[]

required

TotalAiClusterWithCostSerializer
TotalAiVirtualClusterWithCostSerializer
TotalBaremetalWithCostSerializer
TotalBasicVmWithCostSerializer
TotalBackupWithCostSerializer
TotalContainerWithCostSerializer
TotalEgressTrafficWithCostSerializer
TotalExternalIpWithCostSerializer
TotalFileShareWithCostSerializer
TotalFloatingIpWithCostSerializer
TotalFunctionsWithCostSerializer
TotalFunctionCallsWithCostSerializer
TotalFunctionEgressTrafficWithCostSerializer
TotalImagesWithCostSerializer
TotalInferenceWithCostSerializer
TotalInstanceWithCostSerializer
TotalLoadBalancerWithCostSerializer
TotalLogIndexWithCostSerializer
TotalSnapshotWithCostSerializer
TotalVolumeWithCostSerializer
TotalDBAASPostgreSQLPoolerWithCostSerializer
TotalDBAASPostgreSQLMemoryWithCostSerializer
TotalDBAASPostgreSQLPublicNetworkWithCostSerializer
TotalDBAASPostgreSQLCPUWithCostSerializer
TotalDBAASPostgreSQLVolumeWithCostSerializer

Show child attributes

Get cost report resources (pay-as-you-go only)Get monthly cost report totals (commits and pay-as-you-go)

⌘I