Katso myös:

Finnan avoin rajapinta (API documentation in Finnish)

History

29.1.2016 First version
5.2.2016 Added information regarding the handling of component parts
17.3.2016 Fixed erroneous prefix for image URLs in the description for field 'images'. 
22.6.2016 Updated Examples of Use
26.9.2016 Added support for CORS
17.1.2017 Added a mention of the Swagger specification and UI
17.1.2017 The API has new fields subjectsExtended and imagesExtended. See the Swagger UI for more information.

General

The API provides a way to perform searches to the material provided by the organizations (Finnish libraries, archives and museums) participating in Finna.fi. For example the metadata of Fennica - the Finnish National Bibliography and Viola - the Finnish National Discography are included in the API. The Library Network Services unit of the National Library is responsible for the maintenance and development of the interface. Inquiries and feedback on the API:  finna-posti AT helsinki.fi

The queries are formatted in the following way:

https://api.finna.fi/v1/<action>?<parameters>

By default the results are returned in JSON  format. JSONP format is used if the request includes a callback parameter:

https://api.finna.fi/v1/<action>?callback=process

CORS is also supported, and all origin URLs are allowed.

Terms of Use

See API Terms of Use and Recommendations.

Primary Documentation in Swagger

The primary and up to date documentation is available in the Swagger UI.

The Swagger specification can be loaded from https://api.finna.fi/v1?swagger.

Actions

N.B. The documentation below is considered deprecated. While it is still valid, it does not include features added since June 2016. Please refer to the Swagger UI for up to date documentation.

https://api.finna.fi/v1/search?<parameters>

Perform a search.

ParameterTypeDescriptionAllowed values
lookforStringSearch term 
facetArrayFacets to be returned

List of index fields (column Core Fields) that may be used in faceting (Facet Field = Yes).

  • 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. 
  • The result item consists of the following fields:
    • value: facet value that may be used in the filter-parameter.

    • translated: translated display string

    • count: number of records

    • isApplied: 1 if if the facet is in used in the filter-parameter of the query

    • href: (relative) link for toggling (AND) filtering using the facet on or off (depending on whether the facet is active in the filter-parameter of the current query). For other operators, see 'filter' -field.

    • children Children facet items. Defined only for hierarchical facets.

"facets": {
"format": [
{
"value": "0\/MusicalScore\/",
"translated": "Musical score",
"count": 96,
"isApplied": false,
"href": "?lookfor=notbok&amp;type=AllFields&amp;limit=2&amp;filter%5B%5D=building%3A%220%2FVaski%2F%22&amp;filter%5B%5D=format%3A%220%2FMusicalScore%2F%22"
},
facetFilterArray

List of facet value filters

  • facetFilter[]=<facet>:"<regular expression>"
     
  • Allows filtering the returned facet items using regular expressions targeted to the value-field of the facet.
  • Note: the filtered facet needs to be present among the list of returned facets (facet-parameter).
    Examples:
    • Only University of Jyväskylä main level among building building-facet
    • University of Jyväskylä building-facet root level values:
      • facetFilter[]=building:"0/JYU"
    • University of Jyväskylä building-facet values (all levels):
      • facetFilter[]=building:"\d/JYU"
    • Format-facet root level items:
      • facetFilter[]=format:"^0/"
    • e-books and CDs from format-facet:
      • facetFilter[]=format:"(1/Book/eBook/|1/Sound/CD)"
  • The result will include the matched facet items and their possible parent items.
    For example when filtering e-books (facetFilter[]=format:"1/Book/eBook/") from format-facet values, the result will include also the root-level item Book (0/Book):
"facets": {
    "format": [
        {
            "value": "0\/Book\/",
            "translated": "Book",
            "count": 4893,
            "href": "?lookfor=sibelius&amp;type=AllFields&amp;filter%5B%5D=format%3A%220%2FBook%2F%22",
            "children": [
                {
                    "value": "1\/Book\/eBook\/",
                    "translated": "e-book",
                    "count": 237,
                    "href": "?lookfor=sibelius&amp;type=AllFields&amp;filter%5B%5D=format%3A%221%2FBook%2FeBook%2F%22"
                }
            ]
        }
    ]
}
filterArraySearch filters
  • <facet>="<value>"
  • List of facet fields (column Core Fields) that may be used in filtering (Facet Field=Yes).
    • Examples:
      • format: Content type (book, image, physical object...)
      • building: Organization that provides the material
      • online_boolean: Online available material
      • usage_rights_str_mv: Usage rights code
      • search_daterange_mv: date range
     
  • To return possible field values for a facet field you can perform a query without a search term and filters. For example to list all values for the format-field:
    • https://api.finna.fi/v1/search?lookfor=&facet[]=format&prettyPrint=1&limit=0
  • AND-filtering is used by default. OR or NOT filtering can be used by prepending the field with '~' (OR) or '-' (NOT). 
    Examples:
    • No books: 
      • filter[]=-format:"0:/Book"
    • Books or CDs: 
      • filter[]=~format:"0/Book/"&filter[]=~format:"1/Sound/CD/"
         

See type-field for using non-facet fields in filtering.

typeStringSearch type
  • AllFields (basic search, default)
  • Title

  • Author

  • Subject

  • year

  • JournalTitle

  • CallNumber (shelf location for library material).

  • publisher

  • Series

  • toc (Table of Contents)

  • ISN (Journal ISN-number)

  • Classification
    • For example:
      • Classification="ykl+35.6"

List of index fields that are used in different search types (column Search).

A query may be targeted to a specific (non-facet) index field by including the field in the search term.
For example to target the query to the field publication_place_txt_mv

?lookfor=publication_place_txt_mv:pomarkku&field[]=id&field[]=publication_place_str_mv&field[]=placesOfPublication&field[]=publicationInfo&prettyPrint=1

Note: put facet fields in the filter-parameter. For example:

?lookfor=format:0/Book/ (not supported)

?lookfor=&filter[]=format:0/Book/ (use this instead)

sortStringSearch result order
  • Relevance (relevance, default)
  • title
  • author
    • Main author is used when the record has multiple authors.
  • last_indexed desc (last indexed)
  • main_date_str desc (newest first)
  • main_date_str asc (oldest first)
  • callnumber (shelf location of library material)
    • When the record has multiple call numbers the first one is used in sorting.
pageNumberResult page1-n (default 1).
limitNumberNumber of results

0-100 (default 20). limit=0 is useful when you only need the number of results or the results of faceting.

lngStringLanguage version
  • fi (finnish, default)
  • sv (swedish)
  • en-gb (english)

    Language version only affects building and format facets and institutions record field.

fieldArrayRecord fields to be returned

See the list of supported record fields below. If not defined, the record fields marked with bold in the list are returned. If empty, no records are returned.

callbackStringJSONP callback-functionOptional, not in use by default.
prettyPrintNumberPretty printed JSON result0, 1 (default 0).

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:

{
"resultCount": 42,
"records": [
{
"id": "fennica.1003041",
"title": "Puhdistus",
"dedupIds": [
"fennica.1003041",
"jykdok.1256458",
"keski.2341400",
"vaari.1688117",
"vaski.2846838"
]
},
 

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.

More information on the deduplication algorithm

Record

https://api.finna.fi/v1/record?<parameters>

Retrieve record fields.

ParameterTypeDescriptionSupported values
idString|ArrayRecord ID or IDs

id record field

  • For example jykdok.922403
fieldArrayRecord fields.

 See the list of supported record fields below. If not defined, the bolded record fields from the list are returned. If empty, no records are returned.

callbackStringJSONP callback-functionOptional, not in use by default.
prettyPrintNumberPretty printed JSON result0, 1 (default 0).

Supported Record Fields

The following record fields can be used in the field parameter.

Record field content is dependent on the quality of the metadata. Most record fields are not unified acrossa records and therefore, for example, author names may be presented in different ways. Fields may also contain untranslated content.

If a requested field is missing from the response, it is not defined for the record.

FieldTypeDesciption
accessRestrictions

Array

Access restrictions, if known.

"accessRestrictions": [
    "University of Turku local network, remote access with Univ. of Turku username",
    "Turun yliopiston verkossa, et\u00e4k\u00e4ytt\u00f6 TY:n tunnuksilla"
]

"accessRestrictions": [

    "ELEKTRA-lisenssi"
]

"accessRestrictions": [

    "K11"
]
alternativeTitlesArray

Alternative titles.

"alternativeTitles": [
    "Miehet mustissa",
    "MIB"
]
authorsArray

Authors.

  • main: main author
  • corporate: corporate author
  • secondary: other authors
"authors": {
    "main": "Bowie, David",
    "secondary": [
        "Spiders from Mars"
    ]
}
"authors": {
    "main": "Ozric Tentacles",
    "corporate": "Ozric Tentacles,"
}
awardsArray

Awards.

"awards": [
    "Tieto-Finlandia-palkinto 2013."
]
bibliographicLevelString

Publication type, for example 'Monograph', 'MonographPart' (part of a monograph), 'Serial' (serial publication), 'SerialPart' (part of a serial publication) and 'Unknown'.

"bibliographicLevel": "Monograph"
buildingsArray

Location (hierarchical). Includes the following fields:

  • value: location code, used in faceting
  • translated: translated display string
"buildings": [
    {
        "value": "0\/TAIY\/",
        "translated": "Taideyliopisto"
    },
    {
        "value": "1\/TAIY\/tea\/",
        "translated": "Teatterikorkeakoulun kirjasto"
    },
    {
        "value": "2\/TAIY\/tea\/1\/",
        "translated": "Lainattavat"
    }
]
callNumbersArray

Library material shelf locations.

"callNumbers": [
    "84.5",
    "KAUHU"
]
childRecordCountNumber

Number of child records. Requesting this information can increase the query time considerably.

"childRecordCount": 0
classificationsArray

Library material classification codes.

"classifications": {
"udk": [
"001.81",
"001.818",
],
"ykl": [
"16.7",
"38.3",
]
}
cleanIsbnString

ISBN-number (processed). See also isbns.

"cleanIsbn": "1402087179"
cleanIssnString

ISSN-number (processed). See also issns.

"cleanIssn": "0065-2164"
collectionsArray

Collections. Used for example in museum material.

"collections": [
    "Riuttalan talonpoikaismuseo"
]
containerIssueString

Issue number of container publication.

"containerIssue": "4"
containerReferenceString

Reference to container publication.

"containerReference": "s. 191-201"
containerStartPageString

Start page number in container publication.

"containerStartPage": "191"
containerTitleString

Title of container publication.

"containerTitle": "Finland : an introduction"
containerVolumeString

Volume of container publication.

"containerVolume": "25"
corporateAuthorString

Corporate author

"corporateAuthor": "Valtiontalouden tarkastusvirasto."
dedupIdsArray

IDs of similar records from other sources.

"dedupIds": [
    "alma.678448",
    "oula.894534",
    "tamcat.399614"
]
dissertationNoteString

Dissertation note

"dissertationNote": "Pro gradu -ty\u00f6 : Tampereen yliopisto, historiatieteen laitos, yleinen historia."
editionString

Edition.

"edition": "10. osin uud. laitos"
"edition": "Pidennetty versio"
embeddedComponentPartsArray

Component parts that belong to the record. Used for example in sound recordings. Requesting this information can increase the query time considerably.

"embeddedComponentParts": [
    {
        "id": "viola.305175",
        "title": "Juppihippipunkkari",
        "authors": [
            "Koistinen, Petteri, s\u00e4velt\u00e4j\u00e4",
            "Alanko, Ilkka, sanoittaja",
            "Nelj\u00e4 Ruusua, esitt\u00e4j\u00e4"
        ],
        "otherAuthors": [
            "Koistinen, Petteri, s\u00e4velt\u00e4j\u00e4",
            "Alanko, Ilkka, sanoittaja",
            "Nelj\u00e4 Ruusua, esitt\u00e4j\u00e4"
        ]
    },
    {
        "id": "viola.305176",

...

eventsArray

Events pertaining to the record, such as creation, use, discovery, design and exhibition. Used in museum material.

"events": {
    "valmistus": [
        {
            "type": "valmistus",
            "date": "800 - 1050, viikinkiaika, rautakausi",
            "materials": [
                "metalli",
                "hopea"
            ]
        }
    ],
    "n\u00e4yttely": [
        {
            "type": "n\u00e4yttely",
            "name": "Raision museo -ja kulttuurikeskus Harkon arkeologinen n\u00e4yttely",
            "description": "26.5.2004 - 31.12.2006"
        }
    ]
}
formatsArray

Record formats (hierarchical).

  • value: format code (used in faceting)
  • translated: translated display string

For example: e-book (1/Book/eBook/) is a child of Book (0/Book/). The whole format hierarchy is returned starting from the root level.

"formats": [
    {
        "value": "0\/Book\/",
        "translated": "Kirja"
    },
    {
        "value": "1\/Book\/eBook\/",
        "translated": "E-kirja"
    }
]
fullRecordStringOriginal metadata of the record (MARC, EAD, LIDO, DC, QDC).
generalNotesArray

General notes.

"generalNotes": [
    "Ainoastaan verkkolehden vuoden viimeinen numero ilmestyy painettuna.",
    "Ei ilmestynyt lainkaan painettuna 2005."
]
genresArray

Genres. For thematic or stylistic information, see subjects.

"genres": [
    "Electronic books",
    "Conference proceedings"
]
"genres": [
    "DVD-levyt"
]
"genres": [
    "kirja-arvostelut"
]
hierarchyParentIdArray

Parent record ID. Used for example in archive (EAD) material.

"hierarchyParentId": [
    "narc.VAKKA-192941.KA_VAKKA-62641.KA"
]
hierarchyParentTitleArray

Title of the parent record. Used for example in archive (EAD) material.

"hierarchyParentTitle": [
    "Aa Diaarit"
]
"hierarchyParentTitle": [
    "The rise and fall of Ziggy Stardust and the spiders from Mars"
]
hierarchyTopIdArray

Hierarchy top level record ID. Used for example in archive (EAD) material.

"hierarchyTopId": [
    "narc.VAKKA-192941.KA"
]
hierarchyTopTitleArray

Hierarchy top level record title. Used for example in archive (EAD) material.

"hierarchyTopTitle": [
    "Viipurin provinssikanslian arkisto"
]
humanReadablePublicationDatesArray

Publication dates in human readable format.

"humanReadablePublicationDates": [
    "1983-2006."
]
idString

Finna record identifier (unique).

"id": "alma.757000"
identifierString

String

 

Record identifier (not unique).

In museum material, it contains an inventory number:

"identifierString": "201190a20"

In databases, an identifier string:

"identifierString": "FSD"
imageRightsArray

Terms of use for record images:

  • copyright: Copyright license in brief

  • link: Link to license

  • description: Optional description.

"imageRights": {
    "copyright": "CC BY 4.0",
    "link": "http:\/\/creativecommons.org\/licenses\/by\/4.0\/deed.fi",
        "description": [
            "Finna-palvelussa julkaistuja Helsingin kaupunginmuseon kuvia voi k\u00e4ytt\u00e4\u00e4 vapaasti, my\u00f6s kaupallisessa k\u00e4yt\u00f6ss\u00e4.
             Kuvaa ei saa muunnella ilman lupaa ja kuvan yhteydess\u00e4 on mainittava kuvaaja(jos tiedossa) ja Helsingin kaupunginmuseo.
             Finnassa n\u00e4ytett\u00e4v\u00e4t kuvat lisensoidaan Nime\u00e4 4.0 Kansainv\u00e4linen (CC BY 4.0) -lisenssill\u00e4.
             Palvelussa n\u00e4ytett\u00e4v\u00e4t kuvat eiv\u00e4t ole painolaatuisia. Jos tarvitset painolaatuisen kuvan tai sinulla on muuta kysytt\u00e4v\u00e4\u00e4,
             ota yhteytt\u00e4 Helsingin kaupunginmuseon kuva-arkistoon: http:\/\/www.helsinginkaupunginmuseo.fi\/kuva-arkisto"
        ]
}
imagesArray

Record image URLs.

"images": [
    "\/Cover\/Show?id=hkm.HKMS000005%3Akm002w3s&fullres=1&index=0"
]

Prepend the URL with https://api.finna.fi when retrieving the image, for example:

https://api.finna.fi/Cover/Show?id=hkm.HKMS000005%3Akm002w3s&fullres=1&index=0

For books the URL will return a transparent .gif-image (10x10 pixels) when no book cover is found.

institutionsArray

Organization. See also buildings.

  • value: organization code
  • translated: translated display string
"institutions": [
    {
        "value": "LUC",
        "translated": "Lapin korkeakoulukirjasto"
    }
]
isbnsArray

ISBN-numbers. See also cleanIsbn.

"isbns": [
    "951-0-31435-8 (sid.)",
    "978-951-0-31435-7 (sid.)"
]
isCollectionBoolean

Is the record a archive collection?

"isCollection": true
isPartOfArchiveSeriesBoolean

Is the record part of a archive series?

"isPartOfArchiveSeries": true
issnsArray

ISSN-numbers. See also cleanIssn.

"issns": [
    "1913-4711"
]
languagesArray

Languages. See also originalLanguages.

"languages": [
    "fin",
    "swe"
]
lccnString

Library of Congress Control Number

"lccn": "2010252176"
manufacturerString

Manufacturer.

"manufacturer": "([Myllykoski] : Myllykosken kirjap.)"
measurementsArray

Physical measurements.

"measurements": [
    "Pituus: 42 cm",
    "Leveys: helma 22 cm; rinta 34 cm; olka+hiha 14,5+32,5 cm",
    "Lis\u00e4mitta: Koko 110"
]
nonPresenterAuthorsArray

Authors without presenters. See also presenters.

  • name: name
  • role: role
"nonPresenterAuthors": [
    {
        "name": "Doyle, Arthur Conan",
    },
    {
        "name": "Attwood, David",
        "role": "ohj."
    }
]
onlineUrlsArray

URLs (library material).

  • url: URL
  • text: (untranslated) display string
  • source: record source (organization)
    • value: organization code
    • translated: translated display string
"onlineUrls": [
    {
        "url": "http:\/\/eca.europa.eu\/portal\/page\/portal\/publications\/Journal",
        "text": "Elektroninen julkaisu (PDF)",
        "source": {
            "value": "selma",
            "translated": "Eduskunnan kirjasto - Selma"
        }
    }
]
openUrlString

OpenURL (library material).

originalLanguagesArray

Original languages. See also languages.

"originalLanguages": [
    "jpn"
]
otherLinksArray

The record's relations to other records. Used in MARC records.

"otherLinks": [
    {
        "heading": "Arvosteltu teos",
        "title": "Viimeiset runonlaulajat",
        "author": "Martti Haavio"
    }
]
physicalDescriptionsArray

Physical description of the material.

"physicalDescriptions": [
    "0,01 hyllmeter",
    "1 arkivenheter"
]
physicalLocationsArray

Physical locations of archive material.

"physicalLocations": [
    "Historiska och litteraturhistoriska arkivet",
    "Helsingfors, Nationalbiblioteket"
]
placesOfPublication

Array

Place of publication.

"placesOfPublication": [
    "New York, NY  :"
]
playingTimesArray

Playing times. Used for example in sound recordings.

"playingTimes": [
    "00:06:42"
]
presenters 

Presenters (see also nonPresenterAuthors).

  • presenters (Array)
    • name: name
    • role: role
  • details (Array): Details. Presenter names may also be included here (depending on the metadata).
"presenters": {
    "presenters": [
        {
            "name": "Carola",
            "role": "esitt."
        },
        {
            "name": "Sarmanto, Heikki",
            "role": "esitt."
        },
        {
            "name": "Heikki Sarmanto Trio",
            "role": "esitt."
        }
    ],
    "details": [
        "Carola (voc), Heikki Sarmanto Trio: Heikki Sarmanto (p), Tapani Tamminen (b), Reino Laine (dr), Esa Pethman (fl, ts)"
    ]
}
productionCreditsArray

Production credits. Used for example in sound recordings.

"productionCredits": [
    "Miikka Huttunen (\u00e4\u00e4nitt\u00e4j\u00e4, miksaaja), Jukkis Uotila (tuottaja), Klaus Suonsaari (tuottaja), Svante Forsb\u00e4ck (masteroija)."
]
projectedPublicationDateString

Estimated date of publication.

"projectedPublicationDate": "12\/2015"
publicationDatesArray

Date of publication.

"publicationDates": [
    "1972"
]
publicationEndDateString

Last date of publication. Used for example in periodicals and movies.

"publicationEndDate": "2003"

An actively published periodical may be indicated with the year 9999:

"publicationEndDate": "9999"
publicationFrequencyArray

Publication frequency.

"publicationFrequency": [
    "Kerran kuukaudessa."
]
publicationInfoArray

Publication info (may also include the place of publication).

"publicationInfo": [
    "Dortmund"
]
publishers

Array

 

Publishers.

"publishers": [
    "Published by E. & F.N. Spon for the Royal Institute of British Architects"
]
previousTitles / newerTitles Previous and newer titles. May also be included in the field recordLinks.
ratingArray

Rating by Finna users. Used in the following formats 0/Book/, 0/Journal/, 0/Sound/ and 0/Video/.

  • average: average, 0-5.

  • count: number of ratings

"rating": {
    "average": 2.5,
    "count": 3
}
rawDataArray

All index data for the record, excluding fullRecord.

recordLinksArray

Links (relations) between records.

  • value
  • link
    • type: link (relation) type, for example title or ISSN-number
    • value: value of linked record
    • exclude
  • translated: translated display string of link type
"recordLinks": [
    {
        "value": "Baskervillen koira",
        "link": {
            "type": "isn",
            "value": "978-951-1-22851-6",
            "exclude": "arto.1567282"
        },
        "translated": "Muu suhde"
    }
]
"recordLinks": [
    {
        "value": "Julkisuuden salaisuudet : pakinoita ja satiireja journalismin ja julkisuuden kiehtovasta maailmasta",
        "link": {
            "type": "title",
            "value": "Julkisuuden salaisuudet : pakinoita ja satiireja journalismin ja julkisuuden kiehtovasta maailmasta"
        },
        "translated": "Muu suhde"
    }
]
recordPageStringRelative link to record page on Finna. Prepend the URL with https://www.finna.fi
sectorsArray

Sector (library, museum or archive).

  • value: sector code
  • translated: translated display name
"sectors": [
    {
        "value": "0/mus/",
        "translated": "Museo"
    }
]
seriesArray

Series information.

  • name: name
  • additional
  • number: ordinal number in series
  • issn: ISSN-number
"series": [
    {
        "name": "Ursan julkaisuja",
        "additional": "0357-7937;",
        "number": "28",
        "issn": "0357-7937"
    }
]
"series": [
    {
        "name": "Laatukirjasto"
    }
]
sfxObjectIdString

SFX-object ID

"sfxObjectId": "1000000000310928"
shortTitleString

Short title. See also title and subTitle.

"shortTitle": "Parhaat ruokasienet"
source

Array

Source (organization)

  • value: organization code
  • translated: translated display string
"source": [
    {
        "value": "keski",
        "translated": "Keski-kirjastot"
    }
]
subjectsArray

Subjects/Topics.

The array consists of a array of topics possibly followed by arrays of subtopics.

"subjects": [
    [
        "Holmes, Sherlock,",
        "fikt."
    ],
    [
        "elokuvat",
        "Iso-Britannia",
        "2000-2009"
    ],
    [
        "j\u00e4nnityselokuvat"
    ],
    [
        "rikoselokuvat"
    ]
]
subTitleString

Subtitle. See also title ja shortTitle.

"subTitle": "sieniopas"
summaryArray

Summary.

"summary": [
    "Provides essential ideas of the new science of nanotechnology and mathematics. Covers contemporary topics in the areas of the environment, food safety, medicine and healthcare, consumer goods, agriculture, homeland security, and energy supply."
]
systemDetailsArray

Required equipment for consuming the material.

"systemDetails": [
    "Internet-yhteys; www-selain."
]
titleString

Title. See also shortTitle and subTitle.

"title": "Parhaat ruokasienet : sieniopas"
titleSectionString

Section related to the title, if it is part of a series. See also series.

"titleSection": "3."
titleStatementString

Additional information related to the title. May also contain information on authors.

"titleStatement": "directed by Ridley Scott ; screenplay by Hampton Fancher and  David Peoples"
tocArray

Table of contents. May also contain other information.

"toc": [
    "1 CD-\u00e4\u00e4nilevy + esiteliite",
    "Kappale Midnight in a perfect world sis. selke\u00e4n s\u00e4mplen Pekka Pohjolan kappaleesta Sekoilu seestyy",
    "Best foot forward. Building steam with a grain of salt. The number song. Changeling. What does your soul look like (part 4). Stem\/Long stem. Mutual slump. Organ donor. Why hip hop sucks in '96. Midnight in a perfect world. Napalm brain\/Scatter brain. What does your soul look like (part 1 - Blue sky revisit)",
    "DJ Shadow",
    "englanti"
]
uniformTitlesArray

Uniform title. Used in library material.

"uniformTitles": [
    "On the origin of species"
]
unitIdString

Archive material ID. See also id.

"unitId": "Aa:6"
urlsArray

Related external resources.

  • url: URL
  • desc: description (translated when possible)
"urls": [
    {
        "url": "http:\/\/www.makupalat.fi\/",
        "desc": "Tietokannan k\u00e4ytt\u00f6liittym\u00e4"
    },
    {
        "url": "http:\/\/www.makupalat.fi\/fi-FI\/Info\/",
        "desc": "Tietokantaopas"
    }
]
yearString

Year (for example year of publication, manufacture). Also used in main_date_str facet.

"year": "1761"

Example queries

  
Search for records using the search term "sibelius":
https://api.finna.fi/v1/search?lookfor=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/"
Search online images using the search term "sibelius", faceted by organization
https://api.finna.fi/v1/search?lookfor=sibelius&filter[]=online_boolean:"1"&filter[]=format:"0/Image/"&facet[]=building
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
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
https://api.finna.fi/v1/search?lookfor=sibelius&type=Author
Retrieve a single record by ID
https://api.finna.fi/v1/record?id=fennica.123
Retrieve two records by ID
https://api.finna.fi/v1/record?id[]=fennica.123&id[]=fennica.124

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

Handling of Component Parts

Some MARC records found in Finna contain embedded component parts. These include articles in a journal and pieces of music in a music CD. In the Finna UI these are displayed in the Contents/Pieces tab of the record view for the host record, and the metadata used for this list is in host record's MARC field 979. In the API the 979 fields have been compacted to a single field, which contains a repeated subfield for each component part ID. Metadata for the component parts can be fetched as necessary with the record action of the API by using the record IDs found in the subfields a of field 979.

Here is an example record containing component parts: https://api.finna.fi/v1/record?id=viola.49914&field[]=fullRecord

Examples of Use

Additional Information

Finna search instuctions.

The API also supports Finna advanced search syntax using the same parameters as seen on the advanced search results page, for example:

https://api.finna.fi/v1/search?sort=relevance&bool0%5B%5D=AND&lookfor0%5B%5D=sibelius&type0%5B%5D=AllFields&lookfor0%5B%5D=festival&type0%5B%5D=AllFields&lookfor0%5B%5D=&type0%5B%5D=AllFields&join=AND&filter%5B%5D=~language%3A"fin"&limit=20
  • No labels
Write a comment…