Page History
...
The primary and up to date documentation is available in the Swagger UI.
The Swagger OpenAPI specification can be loaded from https://api.finna.fi/v1?swagger.
Example queries
...
Search for records using the search term "sibelius": | |
Search CDs using the search term "sibelius": | https://api.finna.fi/v1/search?lookfor=sibelius&filter[]=format:"1/Sound/CD/" |
Search online images using the search term "sibelius" | https://api.finna.fi/v1/search?lookfor=sibelius&filter[]=online_boolean:"1"&filter[]=format:"0/Image/"&field[]=title&field[]=images |
Search online images using the search term "sibelius", faceted by organization | |
Search for records from years 1870-1890 | https://api.finna.fi/v1/search?lookfor=&filter[]=search_daterange_mv:"[1870%20TO%201890]" |
Formats of all records | https://api.finna.fi/v1/search?lookfor=&facet[]=format Set limit to 0 if you don't need records: https://api.finna.fi/v1/search?lookfor=&facet[]=format&limit=0 |
All online images | https://api.finna.fi/v1/search?lookfor=&filter[]=online_boolean:"1"&filter[]=format:"0/Image/" |
All records with the allowed use "Modifications allowed, also commercial use" | https://api.finna.fi/v1/search?lookfor=&filter[]=usage_rights_str_mv:usage_B |
All organizations, names in swedish | https://api.finna.fi/v1/search?lookfor=&facet[]=building&lng=sv |
Records with "sibelius" as author | |
Retrieve a single record by ID | |
Retrieve two records by ID | https://api.finna.fi/v1/record?id[]=fennica.123&id[]=fennica.124 |
To return possible field values for a facet field you can perform a query without a search term and filters. | https://api.finna.fi/v1/search?lookfor=&facet[]=format&prettyPrint=1&limit=0 |
A query may be targeted to a specific (non-facet) index field by including the field in the search term. Note: put facet fields in the filter-parameter. For example: ?lookfor=format:0/Book/ (not supported) ?lookfor=&filter[]=format:0/Book/ (use this instead) | |
NOT & AND filters | |
The search term may also include a more complex query, for example a target (non-facet) field or a logical operator. See also 'type' parameter of Search action. Search using search terms "sibelius" and "festival" | https://api.finna.fi/v1/search?lookfor=sibelius+AND+festival |
...
Parameter | Type | Description | Notes | |||
---|---|---|---|---|---|---|
facet | Array | Facets to be returned | Results for non-hierarchical facets (other than format, building, sector_str_mv, category_str_mv) consist of the first 30 values sorted by count in decreasing order. | |||
page | Number | Result page | 1-n (default 1). N.B. The API returns a maximum of 100 000 records. E.g. with limit=20 maximum page=5000. If it's necessary to handle larger sets of records, it's possible to limit the set handled at once e.g. with the last_indexed field. | |||
limit | Number | Number of results | 0-100 (default 20). limit=0 is useful when you only need the number of results or the results of faceting. | |||
lng | String | Language version |
|
...
Info |
---|
Similar records (mainly books) from different sources are combined (deduplicated) during the search and only the record with the highest priority is shown in the search results. Filter the results using building to restrict returned records to specific sources. The record field of dedupIds of a deduplicated record contains the IDs of similar records, for eaxmple: { The IDs can be used to return a specific version of a record (see Record action). Faceting results are affected by all similar records that have been combined in the search results to a single (deduplicated) result. For example, the values of all similar records are shown in the building facet. If needed, use facetFilter-parameter to restrict returned facet results. |
...