api
Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
| api [2020/04/22 10:01] – flack | api [2021/03/24 13:41] – sanmark | ||
|---|---|---|---|
| Line 2: | Line 2: | ||
| Examples are demonstrated with [[https:// | Examples are demonstrated with [[https:// | ||
| + | |||
| + | Only the most important request/ | ||
| ====== Response status codes ====== | ====== Response status codes ====== | ||
| Line 385: | Line 387: | ||
| " | " | ||
| { | { | ||
| - | " | + | " |
| - | " | + | " |
| - | " | + | " |
| + | " | ||
| + | " | ||
| + | " | ||
| " | " | ||
| - | }, | + | }, |
| { | { | ||
| - | " | + | " |
| - | " | + | " |
| - | " | + | " |
| + | " | ||
| + | " | ||
| + | " | ||
| " | " | ||
| - | }, | + | }, |
| { | { | ||
| - | " | + | " |
| - | " | + | " |
| - | "smiles": " | + | " |
| - | " | + | " |
| - | }, | + | "query": " |
| + | " | ||
| + | " | ||
| + | }, | ||
| { | { | ||
| - | " | + | " |
| - | " | + | " |
| - | " | + | " |
| + | " | ||
| + | " | ||
| + | " | ||
| " | " | ||
| } | } | ||
| Line 411: | Line 425: | ||
| } | } | ||
| </ | </ | ||
| + | |||
| + | Please note that in case the queries are InChIKeys, **matching_level** and **matching_level_display** will always be **null** in the response. | ||
| ===== Multiple queries exact search with availability ===== | ===== Multiple queries exact search with availability ===== | ||
| Line 451: | Line 467: | ||
| { | { | ||
| " | " | ||
| - | " | + | " |
| - | " | + | " |
| " | " | ||
| - | }, | + | }, |
| - | " | + | " |
| - | " | + | " |
| - | " | + | " |
| + | " | ||
| + | " | ||
| + | " | ||
| " | " | ||
| - | }, | + | }, |
| { | { | ||
| " | " | ||
| - | " | + | " |
| - | " | + | " |
| " | " | ||
| - | }, | + | }, |
| - | " | + | " |
| - | " | + | " |
| - | " | + | " |
| + | " | ||
| + | " | ||
| + | " | ||
| " | " | ||
| - | }, | + | }, |
| { | { | ||
| " | " | ||
| - | " | + | " |
| - | " | + | " |
| " | " | ||
| - | }, | + | }, |
| - | " | + | " |
| - | " | + | " |
| - | "smiles": " | + | " |
| - | " | + | " |
| - | }, | + | "query": " |
| + | " | ||
| + | " | ||
| + | }, | ||
| { | { | ||
| " | " | ||
| - | " | + | " |
| - | " | + | " |
| " | " | ||
| - | }, | + | }, |
| - | " | + | " |
| - | " | + | " |
| - | " | + | " |
| + | " | ||
| + | " | ||
| + | " | ||
| " | " | ||
| } | } | ||
| ] | ] | ||
| - | } | + | } |
| + | </ | ||
| + | |||
| + | Please note that in case the queries are InChIKeys, **matching_level** and **matching_level_display** will always be **null** in the response. | ||
| + | |||
| + | |||
| + | ===== Similarity search ===== | ||
| + | Similarity search currently accepts the following input identifiers: | ||
| + | |||
| + | == Endpoint: == | ||
| + | < | ||
| + | |||
| + | == Example API request: == | ||
| + | < | ||
| + | echo ' | ||
| + | </ | ||
| + | |||
| + | or | ||
| + | |||
| + | < | ||
| + | echo ' | ||
| + | </ | ||
| + | |||
| + | == Request: == | ||
| + | < | ||
| + | POST / | ||
| + | Accept: application/ | ||
| + | Accept-Encoding: | ||
| + | Authorization: | ||
| + | Content-Type: | ||
| + | |||
| + | { | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | } | ||
| + | </ | ||
| + | |||
| + | == Response: == | ||
| + | < | ||
| + | HTTP/1.1 200 OK | ||
| + | Allow: POST, OPTIONS | ||
| + | Content-Encoding: | ||
| + | Content-Type: | ||
| + | |||
| + | { | ||
| + | " | ||
| + | { | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | }, | ||
| + | { | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | }, | ||
| + | { | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | } | ||
| + | ] | ||
| + | } | ||
| + | </ | ||
| + | |||
| + | The **threshold** field accepts values between 0.7 and 1.0, the default is 0.9. | ||
| + | |||
| + | The **limit** field accepts values between 1 and 1000, the default is 100. | ||
| + | |||
| + | |||
| + | ===== Substructure search ===== | ||
| + | Substructure search currently accepts the following input identifiers: | ||
| + | |||
| + | == Endpoint: == | ||
| + | < | ||
| + | |||
| + | == Example API request: == | ||
| + | < | ||
| + | echo ' | ||
| + | </ | ||
| + | |||
| + | == Request: == | ||
| + | < | ||
| + | POST / | ||
| + | Accept: application/ | ||
| + | Accept-Encoding: | ||
| + | Authorization: | ||
| + | Content-Type: | ||
| + | |||
| + | { | ||
| + | " | ||
| + | " | ||
| + | } | ||
| + | </ | ||
| + | |||
| + | == Response: == | ||
| + | < | ||
| + | HTTP/1.1 200 OK | ||
| + | Allow: POST, OPTIONS | ||
| + | Content-Encoding: | ||
| + | Content-Type: | ||
| + | |||
| + | { | ||
| + | " | ||
| + | { | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | }, | ||
| + | { | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | }, | ||
| + | { | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | }, | ||
| + | { | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | }, | ||
| + | { | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | } | ||
| + | ] | ||
| + | } | ||
| </ | </ | ||
| + | The **limit** field accepts values between 1 and 1000, the default is 100. | ||
| Line 646: | Line 809: | ||
| * **target_volume**: | * **target_volume**: | ||
| * **target_cc**: | * **target_cc**: | ||
| - | * **extra_amount**: | + | * **extra_amount**: |
| + | * **min_extra_amount**: | ||
| * **customer_email**: | * **customer_email**: | ||
| * **delivery_time**: | * **delivery_time**: | ||
api.txt · Last modified: 2023/06/03 07:19 by flack