OP Branches API (0.2)

Download OpenAPI specification:Download

Support: api@op.fi


OP Branches API provides your customers with up-to-date information on the closest OP bank branches.

Data is available in two languages, Finnish (fi) and Swedish (sv). Localized properties are objects that use language as key. If value is not available on either language, the other is used as a fallback.

Sandbox

Testing Branches API in the sandbox environment is free of charge. Start by creating a developer app.

Production access

You can apply for production access while creating a new application. Branches API is free of charge in the production environment.

OP Branch Offices

Find OP branch offices as JSON or GeoJSON

OP branch office search. Supports filtering by bounding box, free-text query and sorting results by nearest first. Note: Using "Accept: application/geo+json" -header results in GeoJSON FeatureCollection (BranchFeatureCollection).

Authorizations:
apiKey
query Parameters
bbox
string^(-?\d{1,3}(?:\.\d+)?)(?:\s*,\s*|\s+)(-?\d{1,...
Example: bbox=24.83830051723635,60.1428615054654,25.046869090234395,60.221390546251655

Bounding Box filter by coordinates of southwest and northeast point: sw-long, sw-lat, ne-long, ne-lat.

location
string^(-?\d{1,3}(?:\.\d+)?)(?:\s*,\s*|\s+)(-?\d{1,...
Example: location=24.93837910000002,60.16985569999999

Coordinates of location used for sorting the results from the nearest to the furthest: long, lat

latlong
string^(-?\d{1,3}(?:\.\d+)?)(?:\s*,\s*|\s+)(-?\d{1,...
Example: latlong=60.16985569999999,24.93837910000002

Alternative, "latitude,longitude" -format for location parameter, i.e. coordinates used for sorting the results from the nearest to the furthest: lat, long

query
string
Example: query=pääkonttori

Free-text search terms.

limit
number <int32>
Example: limit=5

Limit result size to n first (e.g. 5 closest when used with location/latlong parameter)

lang
string
Default: "fi"
Enum: "fi" "sv"

When result is GeoJSON use preferred language

header Parameters
x-session-id
string

Session identifier for in-memory data

x-request-id
string

Unique ID for the request

Accept-Language
string
Default: fi
Enum: "fi" "sv"

When result is GeoJSON use preferred language

Responses

Request samples

curl -X GET https://sandbox.apis.op.fi/branches/v1/branches \
-H 'x-session-id: string' \
-H 'x-request-id: string' \
-H 'Accept-Language: fi' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' 

Response samples

Content type
{
  • "payload": [
    ]
}

Find OP branch offices as JSON

OP branch office search. Supports filtering by bounding box, free-text query and sorting results by nearest first. Results in JSON format.

Authorizations:
apiKey
query Parameters
bbox
string^(-?\d{1,3}(?:\.\d+)?)(?:\s*,\s*|\s+)(-?\d{1,...
Example: bbox=24.83830051723635,60.1428615054654,25.046869090234395,60.221390546251655

Bounding Box filter by coordinates of southwest and northeast point: sw-long, sw-lat, ne-long, ne-lat.

location
string^(-?\d{1,3}(?:\.\d+)?)(?:\s*,\s*|\s+)(-?\d{1,...
Example: location=24.93837910000002,60.16985569999999

Coordinates of location used for sorting the results from the nearest to the furthest: long, lat

latlong
string^(-?\d{1,3}(?:\.\d+)?)(?:\s*,\s*|\s+)(-?\d{1,...
Example: latlong=60.16985569999999,24.93837910000002

Alternative, "latitude,longitude" -format for location parameter, i.e. coordinates used for sorting the results from the nearest to the furthest: lat, long

query
string
Example: query=pääkonttori

Free-text search terms.

limit
number <int32>
Example: limit=5

Limit result size to n first (e.g. 5 closest when used with location/latlong parameter)

header Parameters
x-session-id
string

Session identifier for in-memory data

x-request-id
string

Unique ID for the request

Responses

Request samples

curl -X GET https://sandbox.apis.op.fi/branches/v1/branches.json \
-H 'x-session-id: string' \
-H 'x-request-id: string' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' 

Response samples

Content type
application/json
{
  • "payload": [
    ]
}

Find OP branch offices as GeoJSON

OP branch office search. Supports filtering by bounding box, free-text query and sorting results by nearest first. Results in GeoJSON FeatureCollection object.

Authorizations:
apiKey
query Parameters
bbox
string^(-?\d{1,3}(?:\.\d+)?)(?:\s*,\s*|\s+)(-?\d{1,...
Example: bbox=24.83830051723635,60.1428615054654,25.046869090234395,60.221390546251655

Bounding Box filter by coordinates of southwest and northeast point: sw-long, sw-lat, ne-long, ne-lat.

location
string^(-?\d{1,3}(?:\.\d+)?)(?:\s*,\s*|\s+)(-?\d{1,...
Example: location=24.93837910000002,60.16985569999999

Coordinates of location used for sorting the results from the nearest to the furthest: long, lat

latlong
string^(-?\d{1,3}(?:\.\d+)?)(?:\s*,\s*|\s+)(-?\d{1,...
Example: latlong=60.16985569999999,24.93837910000002

Alternative, "latitude,longitude" -format for location parameter, i.e. coordinates used for sorting the results from the nearest to the furthest: lat, long

query
string
Example: query=pääkonttori

Free-text search terms.

limit
number <int32>
Example: limit=5

Limit result size to n first (e.g. 5 closest when used with location/latlong parameter)

lang
string
Default: "fi"
Enum: "fi" "sv"

Preferred language

header Parameters
x-session-id
string

Session identifier for in-memory data

x-request-id
string

Unique ID for the request

Accept-Language
string
Default: fi
Enum: "fi" "sv"

Preferred language

Responses

Request samples

curl -X GET https://sandbox.apis.op.fi/branches/v1/branches.geojson \
-H 'x-session-id: string' \
-H 'x-request-id: string' \
-H 'Accept-Language: fi' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' 

Response samples

Content type
application/geo+json
{
  • "type": "FeatureCollection",
  • "features": {
    }
}