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:19] – 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 799: | Line 941: | ||
| Check for the **quotes** field. If it is there and contains some items in the list, we could generate some quotes for your quote query. As you can see from the above result, we could generate 1 quote for the quote query. A "Best price" quote. | Check for the **quotes** field. If it is there and contains some items in the list, we could generate some quotes for your quote query. As you can see from the above result, we could generate 1 quote for the quote query. A "Best price" quote. | ||
| + | |||
| + | |||
| + | ====== Quote API ====== | ||
| + | |||
| + | In order to get the detailed data of an individual quote, you can call the detail API endpoint of a quote, for example for the quote with ID //9//: | ||
| + | |||
| + | < | ||
| + | http https:// | ||
| + | </ | ||
| + | |||
| + | == Example request: === | ||
| + | < | ||
| + | GET / | ||
| + | Accept: */* | ||
| + | Accept-Encoding: | ||
| + | Authorization: | ||
| + | </ | ||
| + | |||
| + | == Example response: === | ||
| + | < | ||
| + | HTTP/1.1 200 OK | ||
| + | Allow: GET, HEAD, OPTIONS | ||
| + | Content-Encoding: | ||
| + | Content-Type: | ||
| + | |||
| + | { | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | { | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | }, | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | }, | ||
| + | { | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | }, | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | } | ||
| + | ], | ||
| + | " | ||
| + | " | ||
| + | { | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | }, | ||
| + | { | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | }, | ||
| + | { | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | }, | ||
| + | { | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | }, | ||
| + | { | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | } | ||
| + | ], | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | }, | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | }, | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | } | ||
| + | </ | ||
| + | |||
| + | == Fields: === | ||
| + | * **additional_document_notes**: | ||
| + | * **avg_product_price**: | ||
| + | * **avg_product_price_currency**: | ||
| + | * **coverage_percent**: | ||
| + | * **created_at**: | ||
| + | * **id**: The ID of the Instant Quote. | ||
| + | * **items**: list of product level data | ||
| + | * **amount**: Quoted amount (mg) | ||
| + | * **compound**: | ||
| + | * **product_price**: | ||
| + | * **product_price_currency**: | ||
| + | * **purity_percent**: | ||
| + | * **payment_due_days**: | ||
| + | * **price_items**: | ||
| + | * **product_discount_price**: | ||
| + | * **product_discount_price_currency**: | ||
| + | * **products_price**: | ||
| + | * **products_price_currency**: | ||
| + | * **query**: The quote query fields | ||
| + | * **reference_id_full**: | ||
| + | * **reformatting_price**: | ||
| + | * **reformatting_price_currency**: | ||
| + | * **selection_criteria**: | ||
| + | * **selection_criteria_display**: | ||
| + | * **shipping_price**: | ||
| + | * **shipping_price_currency**: | ||
| + | * **state**: State code of the quote. | ||
| + | * **state_display**: | ||
| + | * **total_discount_price**: | ||
| + | * **total_discount_price_currency**: | ||
| + | * **total_price**: | ||
| + | * **total_price_currency**: | ||
| + | * **valid_until**: | ||
| + | | ||
| + | ==== Download quote as PDF ==== | ||
| + | |||
| + | You can download a quote as a PDF file. Please note that the PDF file generation can take some time, the more item it contains the more time it will take to generate the file. | ||
| + | |||
| + | The HTTP response contains a // | ||
| + | |||
| + | < | ||
| + | http https:// | ||
| + | </ | ||
| + | |||
| + | ==== Download quote as Excel (.xlsx) file ==== | ||
| + | |||
| + | You can download a quote as an Excel file. Please note that the file generation can take some time, the more item it contains the more time it will take to generate the file. | ||
| + | |||
| + | The HTTP response contains a // | ||
| + | |||
| + | < | ||
| + | http https:// | ||
| + | </ | ||
| + | |||
ultimate-api.1595254741.txt.gz · Last modified: by flack