MISO SDK for Python

Enhance your site with high conversion magic with Miso's power.

Home | Docs | API Reference | Recipes

Installation

The miso-sdk is on PYPI, you can install miso-sdk with the package manager of your choice:

With pip:

$ pip install miso-sdk

With poetry:

$ poetry add miso-sdk

With pdm:

$ pdm add miso-sdk

Quick Start

To use the SDK client:

import json
from miso.sdk import ApiClient

api_key = 'YOUR-API-KEY-HERE'

api_client = ApiClient(api_key)
resp = api_client.search.search(q = "love", user_id = "MY-ID")
print(json.dumps(resp, indent=2))

will print something similar to:

{
  "took": 15,
  "miso_id": "fd3aae82-8068-11ed-89d8-967a8675a919",
  "products": [
    {
      "product_id": "588527603"
    },
    {
      "product_id": "193225388"
    },
    {
      "product_id": "771495105"
    },
    {
      "product_id": "572340793",
    },
    {
      "product_id": "563687627"
    }
  ],
  "total": 65577,
  "start": 0,
  "spellcheck": {
    "spelling_errors": false,
    "auto_spelling_correction": false,
    "original_query": "love",
    "original_query_with_markups": "love",
    "corrected_query": "love",
    "corrected_query_with_markups": "love"
  },
  "product_existence": {},
  "partially_matched_products": null,
  "facet_counts": {
    "facet_fields": {}
  },
  "custom_assets": []
}

For detailed usage, please refer to Miso API Document.

License

This library is distributed under the MIT license.