This documentation aims to provide an introduction to using the ScPCA Portal's API.
For a quick overview of the ScPCA Portal's API available endpoints and responses, please visit the ScPCA Portal Redoc documentation. This shows all available endpoints, accepted query parameters, and the structure of endpoint responses.
For an interactive user interface, please visit the ScPCA Portal Swagger documentation. There, you can submit queries and see real API responses.
Note
We will be releasing language specific clients in the future.
All endpoints can be accessed without using an API Token. However, in order to receive a download url for data, you must create a token to attach to your request. This indicates that you have accepted the ScPCA Portal's Terms of Use.
We have prepared some example scripts for querying projects and samples then downloading their related computed files.
Important
Please review the script before running. You will need to update the email address variable in order to successfully execute the script.