navan
/
classyfire_api
mirror of https://bitbucket.org/wishartlab/classyfire_api
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
classyfire_api/README.md

1.4 KiB
Raw Blame History

ClassyFire is a resource that allows you to automatically classify any chemical compound based on its structure. This is the repository for the ClassyFire API allows you to send requests to and pull information from the ClassyFire web server.

What is this repository for?

How do I get set up?

  • Summary of set up
  • Configuration
  • Dependencies
  • Database configuration
  • How to run tests
  • Deployment instructions

Contribution guidelines

  • Writing tests
  • Code review
  • Other guidelines

Endpoints

Entities

/entities GET

You can retrieve a chemical compound's classification in the JSON or XML format. The compound's information is accessed via the InChIkey as show in the following examples. In this example, the entity has the InChIKey=LABTWGUMFABVFG-ONEGZZNKSA-N.

curl -H "Accept: application/json" -H "Content-Type: application/json" -X GET http://localhost:3000/entities/LABTWGUMFABVFG-ONEGZZNKSA-N.json

curl -H "Accept: application/json" -H "Content-Type: application/json" -X GET http://localhost:3000/entities/LABTWGUMFABVFG-ONEGZZNKSA-N.json

Directory Structure

  • lib

Who do I talk to?

  • Repo owner or admin
  • Other community or team contact