ultimate-api
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
ultimate-api [2020/07/20 14:58] – [Quote API] flack | ultimate-api [2021/05/25 14:27] (current) – [Compounds export] flack | ||
---|---|---|---|
Line 225: | Line 225: | ||
</ | </ | ||
- | In case of similarity searches the **tan** value contains the similarity value. | + | In case of similarity searches the **tan** value the response |
+ | |||
+ | In case of similarity searches you can control the minimum similarity with the **sim_threshold** param. Its default | ||
+ | < | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | } | ||
+ | </ | ||
Line 304: | Line 316: | ||
" | " | ||
} | } | ||
+ | </ | ||
+ | |||
+ | |||
+ | ====== Compounds API ====== | ||
+ | |||
+ | ===== Compound details ===== | ||
+ | |||
+ | For example for the compound identified by the InChIKey **PKGBDLPHSYFAFJ-UHFFFAOYSA-N** you can get the detail response the following way: | ||
+ | |||
+ | == Example API request: == | ||
+ | < | ||
+ | |||
+ | == Request: == | ||
+ | < | ||
+ | GET / | ||
+ | </ | ||
+ | |||
+ | == Response: == | ||
+ | < | ||
+ | HTTP/1.1 200 OK Content-Type: | ||
+ | |||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | }, | ||
+ | " | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | ===== Compounds export ===== | ||
+ | |||
+ | If you have a set of identifiers you can export the corresponding compounds into SMILES or SDF files. | ||
+ | |||
+ | The HTTP response contains a // | ||
+ | |||
+ | The maximum number of compounds you can export with a single API call is 1000. | ||
+ | |||
+ | Invalid identifiers will be excluded from the response. | ||
+ | |||
+ | ==== SDF file ==== | ||
+ | |||
+ | == Example API request: == | ||
+ | < | ||
+ | echo ' | ||
+ | </ | ||
+ | |||
+ | == Request: == | ||
+ | < | ||
+ | POST / | ||
+ | Content-Type: | ||
+ | |||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | ], | ||
+ | " | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | |||
+ | == Response: == | ||
+ | < | ||
+ | HTTP/1.1 200 OK | ||
+ | Content-Type: | ||
+ | Content-Disposition: | ||
+ | </ | ||
+ | |||
+ | |||
+ | |||
+ | ==== SMILES file ==== | ||
+ | |||
+ | == Example API request: == | ||
+ | < | ||
+ | echo ' | ||
+ | </ | ||
+ | |||
+ | == Request: == | ||
+ | < | ||
+ | POST / | ||
+ | Content-Type: | ||
+ | |||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | ], | ||
+ | " | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | |||
+ | == Response: == | ||
+ | < | ||
+ | HTTP/1.1 200 OK | ||
+ | Content-Type: | ||
+ | Content-Disposition: | ||
</ | </ | ||
Line 321: | Line 463: | ||
== Example API request: == | == Example API request: == | ||
< | < | ||
- | echo ' | + | echo ' |
</ | </ | ||
Line 941: | Line 1083: | ||
* **avg_product_price_currency**: | * **avg_product_price_currency**: | ||
* **coverage_percent**: | * **coverage_percent**: | ||
- | * **created**: The creation datetime of the quote. | + | * **created_at**: The creation datetime of the quote. |
* **id**: The ID of the Instant Quote. | * **id**: The ID of the Instant Quote. | ||
* **items**: list of product level data | * **items**: list of product level data | ||
Line 965: | Line 1107: | ||
* **state**: State code of the quote. | * **state**: State code of the quote. | ||
* **state_display**: | * **state_display**: | ||
- | * **total_cost**: Total cost (USD) | + | * **total_discount_price**: Total discount |
- | * **total_cost_without_discount**: | + | * **total_discount_price_currency**: Currency of total discount price |
- | * **total_discount_price**: Total discount price (USD) | + | |
* **total_price**: | * **total_price**: | ||
* **total_price_currency**: | * **total_price_currency**: |
ultimate-api.1595257125.txt.gz · Last modified: 2020/07/20 14:58 by flack