FPbase Help
  • FPbase Help
  • Searching the Database
    • Home & Navbar Search
    • Advanced Protein Search
  • Browsing the Database
    • Interactive Chart
    • Protein Table
    • Organisms
    • References Table
    • Lineage Trees
  • Contributing
    • Creating an account
    • Submit a New Protein
    • Update Existing Protein
    • Submit a Spectrum
    • Fixing Gaps and Inconsistencies
  • Tools
    • Spectra Viewer
    • Microscope Pages
      • Creating a microscope page
      • Brightness & Efficiency calculations
    • FRET Calculator
    • Comparison Tool
  • Protein Collections & Favorites
  • Database Organization
    • Database Schema
    • Improving the Database Schema
  • Glossary of Terms
  • FAQs
  • REST API
    • Introduction to the FPbase API
    • Get Protein Information
    • Get Spectra Information
  • The fpseq package
    • What is fpseq?
Powered by GitBook
On this page
  • GraphQL API
  • REST API

Was this helpful?

  1. REST API

Introduction to the FPbase API

Documentation for the FPbase API (in development)

PreviousFAQsNextGet Protein Information

Last updated 5 years ago

Was this helpful?

GraphQL API

As of June 2019, FPbase is moving to a GraphQL-based API. 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.

The new entrypoint is:

If you , you will be met with the 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:

You may POST queries to the entrypoint to retrieve data in JSON format.

For more information on how to query in GraphQL, see the .

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 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 and tell us about your project.

GraphQL
https://www.fpbase.org/graphql/
visit the entrypoint in a browser
GraphiQL IDE
get the name and sequence of every protein in the database
official documentation
let us know
https://www.fpbase.org/api/
get in touch