Timeseries API

API change history

Latest version of timeseries data.

Series

Try it

Request

Request URL

Request parameters

  • string
  • (optional)
    string
  • (optional)
    integer

    Format - int32.

  • (optional)
    integer

    Format - int32.

Request body

Responses

200 OK

Success

Representations

{
  "type": "object",
  "properties": {
    "currentPage": {
      "type": "integer",
      "format": "int32",
      "readOnly": true
    },
    "totalPages": {
      "type": "integer",
      "format": "int32",
      "readOnly": true
    },
    "pageSize": {
      "type": "integer",
      "format": "int32",
      "readOnly": true
    },
    "totalCount": {
      "type": "integer",
      "format": "int32",
      "readOnly": true
    },
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "dataset": {
            "type": "string",
            "nullable": true
          },
          "name": {
            "type": "string",
            "nullable": true
          },
          "title": {
            "type": "string",
            "nullable": true
          },
          "dimensions": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string",
                  "nullable": true
                },
                "position": {
                  "type": "integer",
                  "format": "int32"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                },
                "descriptions": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "lang": {
                        "type": "string",
                        "nullable": true
                      },
                      "description": {
                        "type": "string",
                        "nullable": true
                      }
                    },
                    "additionalProperties": false
                  },
                  "nullable": true
                }
              },
              "additionalProperties": false
            },
            "nullable": true
          },
          "metadatas": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string",
                  "nullable": true
                },
                "value": {
                  "type": "string",
                  "nullable": true
                },
                "descriptions": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "lang": {
                        "type": "string",
                        "nullable": true
                      },
                      "description": {
                        "type": "string",
                        "nullable": true
                      }
                    },
                    "additionalProperties": false
                  },
                  "nullable": true
                },
                "values": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "lang": {
                        "type": "string",
                        "nullable": true
                      },
                      "value": {
                        "type": "string",
                        "nullable": true
                      }
                    },
                    "additionalProperties": false
                  },
                  "nullable": true
                }
              },
              "additionalProperties": false
            },
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}
{
  "currentPage": 0,
  "totalPages": 0,
  "pageSize": 0,
  "totalCount": 0,
  "items": [
    {
      "dataset": "string",
      "name": "string",
      "title": "string",
      "dimensions": [
        {
          "name": "string",
          "position": 0,
          "value": "string",
          "descriptions": [
            {
              "lang": "string",
              "description": "string"
            }
          ]
        }
      ],
      "metadatas": [
        {
          "name": "string",
          "value": "string",
          "descriptions": [
            {
              "lang": "string",
              "description": "string"
            }
          ],
          "values": [
            {
              "lang": "string",
              "value": "string"
            }
          ]
        }
      ]
    }
  ]
}
{
  "type": "object",
  "properties": {
    "currentPage": {
      "type": "integer",
      "format": "int32",
      "readOnly": true
    },
    "totalPages": {
      "type": "integer",
      "format": "int32",
      "readOnly": true
    },
    "pageSize": {
      "type": "integer",
      "format": "int32",
      "readOnly": true
    },
    "totalCount": {
      "type": "integer",
      "format": "int32",
      "readOnly": true
    },
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "dataset": {
            "type": "string",
            "nullable": true
          },
          "name": {
            "type": "string",
            "nullable": true
          },
          "title": {
            "type": "string",
            "nullable": true
          },
          "dimensions": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string",
                  "nullable": true
                },
                "position": {
                  "type": "integer",
                  "format": "int32"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                },
                "descriptions": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "lang": {
                        "type": "string",
                        "nullable": true
                      },
                      "description": {
                        "type": "string",
                        "nullable": true
                      }
                    },
                    "additionalProperties": false
                  },
                  "nullable": true
                }
              },
              "additionalProperties": false
            },
            "nullable": true
          },
          "metadatas": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string",
                  "nullable": true
                },
                "value": {
                  "type": "string",
                  "nullable": true
                },
                "descriptions": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "lang": {
                        "type": "string",
                        "nullable": true
                      },
                      "description": {
                        "type": "string",
                        "nullable": true
                      }
                    },
                    "additionalProperties": false
                  },
                  "nullable": true
                },
                "values": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "lang": {
                        "type": "string",
                        "nullable": true
                      },
                      "value": {
                        "type": "string",
                        "nullable": true
                      }
                    },
                    "additionalProperties": false
                  },
                  "nullable": true
                }
              },
              "additionalProperties": false
            },
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}
{
  "currentPage": 0,
  "totalPages": 0,
  "pageSize": 0,
  "totalCount": 0,
  "items": [
    {
      "dataset": "string",
      "name": "string",
      "title": "string",
      "dimensions": [
        {
          "name": "string",
          "position": 0,
          "value": "string",
          "descriptions": [
            {
              "lang": "string",
              "description": "string"
            }
          ]
        }
      ],
      "metadatas": [
        {
          "name": "string",
          "value": "string",
          "descriptions": [
            {
              "lang": "string",
              "description": "string"
            }
          ],
          "values": [
            {
              "lang": "string",
              "value": "string"
            }
          ]
        }
      ]
    }
  ]
}
{
  "type": "object",
  "properties": {
    "currentPage": {
      "type": "integer",
      "format": "int32",
      "readOnly": true
    },
    "totalPages": {
      "type": "integer",
      "format": "int32",
      "readOnly": true
    },
    "pageSize": {
      "type": "integer",
      "format": "int32",
      "readOnly": true
    },
    "totalCount": {
      "type": "integer",
      "format": "int32",
      "readOnly": true
    },
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "dataset": {
            "type": "string",
            "nullable": true
          },
          "name": {
            "type": "string",
            "nullable": true
          },
          "title": {
            "type": "string",
            "nullable": true
          },
          "dimensions": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string",
                  "nullable": true
                },
                "position": {
                  "type": "integer",
                  "format": "int32"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                },
                "descriptions": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "lang": {
                        "type": "string",
                        "nullable": true
                      },
                      "description": {
                        "type": "string",
                        "nullable": true
                      }
                    },
                    "additionalProperties": false
                  },
                  "nullable": true
                }
              },
              "additionalProperties": false
            },
            "nullable": true
          },
          "metadatas": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string",
                  "nullable": true
                },
                "value": {
                  "type": "string",
                  "nullable": true
                },
                "descriptions": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "lang": {
                        "type": "string",
                        "nullable": true
                      },
                      "description": {
                        "type": "string",
                        "nullable": true
                      }
                    },
                    "additionalProperties": false
                  },
                  "nullable": true
                },
                "values": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "lang": {
                        "type": "string",
                        "nullable": true
                      },
                      "value": {
                        "type": "string",
                        "nullable": true
                      }
                    },
                    "additionalProperties": false
                  },
                  "nullable": true
                }
              },
              "additionalProperties": false
            },
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Code samples

@ECHO OFF

curl -v -X GET "https://api.boffsaopendata.fi/v4/series/{dataset}?seriesName={string}&pageNumber=1&pageSize=20"

--data-ascii "{body}" 

using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);


            // Request parameters
            queryString["seriesName"] = "{string}";
            queryString["pageNumber"] = "1";
            queryString["pageSize"] = "20";
            var uri = "https://api.boffsaopendata.fi/v4/series/{dataset}?" + queryString;

            var response = await client.GetAsync(uri);
        }
    }
}	
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://api.boffsaopendata.fi/v4/series/{dataset}");

            builder.setParameter("seriesName", "{string}");
            builder.setParameter("pageNumber", "1");
            builder.setParameter("pageSize", "20");

            URI uri = builder.build();
            HttpGet request = new HttpGet(uri);


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}


<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
            "seriesName": "{string}",
            "pageNumber": "1",
            "pageSize": "20",
        };
      
        $.ajax({
            url: "https://api.boffsaopendata.fi/v4/series/{dataset}?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
            },
            type: "GET",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>

#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://api.boffsaopendata.fi/v4/series/{dataset}";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"seriesName={string}",
                         @"pageNumber=1",
                         @"pageSize=20",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"GET"];
    // Request headers
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}

<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://api.boffsaopendata.fi/v4/series/{dataset}');
$url = $request->getUrl();

$headers = array(
    // Request headers
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'seriesName' => '{string}',
    'pageNumber' => '1',
    'pageSize' => '20',
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_GET);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>
########### Python 2.7 #############
import httplib, urllib, base64

headers = {
}

params = urllib.urlencode({
    # Request parameters
    'seriesName': '{string}',
    'pageNumber': '1',
    'pageSize': '20',
})

try:
    conn = httplib.HTTPSConnection('api.boffsaopendata.fi')
    conn.request("GET", "/v4/series/{dataset}?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
}

params = urllib.parse.urlencode({
    # Request parameters
    'seriesName': '{string}',
    'pageNumber': '1',
    'pageSize': '20',
})

try:
    conn = http.client.HTTPSConnection('api.boffsaopendata.fi')
    conn.request("GET", "/v4/series/{dataset}?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################
require 'net/http'

uri = URI('https://api.boffsaopendata.fi/v4/series/{dataset}')

query = URI.encode_www_form({
    # Request parameters
    'seriesName' => '{string}',
    'pageNumber' => '1',
    'pageSize' => '20'
})
if query.length > 0
  if uri.query && uri.query.length > 0
    uri.query += '&' + query
  else
    uri.query = query
  end
end

request = Net::HTTP::Get.new(uri.request_uri)
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body