Introduction to the FPbase API
Documentation for the FPbase API (in development)
GraphQL API
As of June 2019, FPbase is moving to a GraphQL-based API. GraphQL is a modern query language that gives clients the power to ask for exactly what (fields) they need and nothing more, and makes it easier to evolve APIs over time.
If you visit the entrypoint in a browser, you will be met with the GraphiQL IDE for exploring the FPbase schema. Use the documentation explorer on the right to see what queries are available, and test out various queries in the pane on the left. For instance: get the name and sequence of every protein in the database
You may POST queries to the entrypoint to retrieve data in JSON format.
REST API
FPbase has a REST API for retrieving data in JSON or CSV format. It is very basic and still in development (unstable). Until we know there are people who would like to use it, there are a lot of other things that also need attention. So let us know if you'd like to use it!
NOTE: FPbase is moving away from the REST API, and all development will use the GraphQL API mentioned above.
These docs are incomplete and potentially wrong... In the meantime, there is (slightly) better information at this page:
If you use or would like to use the API for programmatic retrieval of data from FPbase, we'd love to help out. Please get in touch and tell us about your project.
Last modified 2yr ago
Copy link