Frequently asked questions
- Where can I find technical documentation on how to use the Swedish National Archives' public APIs?
- May I use the APIs for commercial purposes, for example to develop an app or website that I charge for?
- Some images that I can see in the online search service cannot be retrieved via the IIIF API. Why is that?
- I have developed a web service that uses the public APIs. Do I have to state that the Swedish National Archives' public APIs are used in the service?
- I have developed a website that displays images of archival documents retrieved via the Swedish National Archives' APIs. What information should I display alongside each image?
- How do I download all the images in a scanned archival file (volume) to my computer?
- Can I access census records (folkräkningar) via the Swedish National Archives' public APIs?
- Do I need an API key or any other authentication?
- Are there any limits on how many requests I may make?
Where can I find technical documentation on how to use the Swedish National Archives' public APIs?
You can find the documentation on GitHub .
May I use the APIs for commercial purposes, for example to develop an app or website that I charge for?
Yes. The APIs are fully public and open, and may also be used for commercial purposes.
Some images that I can see in the image viewer in the online search service cannot be retrieved via the IIIF API. Why is that?
For images to be made available through the IIIF API, three conditions must be met. The scanned archival material must be free from restrictions concerning personal data and confidentiality. The images and the archival material must be marked with an open licence, such as the Public Domain Mark (PDM), CC BY or CC0. And the scanned material must be more than 110 years old.
If you request an image that does not meet these requirements via the IIIF API, you will receive a 403 Forbidden response. This can happen even if you are able to view the image in the online search service’s image viewer.
Work is under way to label scanned images with the correct licences, and the goal is to make as much image material as possible available through the API.
Read more about access to image material in the section on rights in the IIIF documentation on GitHub .
I have developed a web service that uses the public APIs. Do I have to state that the Swedish National Archives' public APIs are used in the service?
No, you don't have to. Bet we appreciate it if you do, for example with the following sentence somewhere on your service:
This service uses data and images from the Swedish National Archives' open APIs.
Preferably with a link to the Swedish National Archives .
You are also welcome to let us know that you use our APIs. This helps us show how open data from the Swedish National Archives is being used.
I have developed a website that displays images of archival documents retrieved via the Swedish National Archives' APIs. What information should I display alongside each image?
Alongside each image, you should state the image’s licence and include a source reference to the correct archival document. Both values can be found in the image’s IIIF manifest, under “Rights” and “Source reference”.
How do I download all the images in a scanned archival file (volume) to my computer?
In the online search service’s image viewer, you can download one image (page) at a time. To download all the images (pages) in an archival file (volume) at once, you can use the IIIF API together with a ready-made script.
You can find the script for downloading all images in a volume on GitHub .
Can I access census records (folkräkningar) via the Swedish National Archives' public APIs?
No, census records are not available in the API. You can access census records in the online search service’s database Folkräkningar (Sveriges befolkning).
To order data extracts of census records, or of other datasets that are not available in the API, please use the order form Other inquiries .
Academic researchers can get access to some census records via the national research infrastructure Swedpop .
Do I need an API key or any other authentication?
No. The Swedish National Archives' public APIs are open and do not require an API key, registration or login.
Are there any limits on how many requests I may make?
We ask you to follow these guidelines when using the APIs
If a service puts so much load on the APIs that it affects other users, we may need to restrict its access.