diff --git a/README.md b/README.md index a58e049..a8925c1 100644 --- a/README.md +++ b/README.md @@ -21,8 +21,18 @@ push to /staging → updates staging.services.kukai.app 2. Navigate to the `storage` folder, modify the `.json` file 3. Test locally with `yarn dev` (i.e. `localhost:8787/v1/version`) - - - +--- +## Api services +*Production endpoint*: https://services.kukai.app/ + +*Staging endpoint*: https://staging.services.kukai.app/ + +| Service | Purpose | Endpoint | +| ------------- | ------------- | ------------- | +| **Discover** | Info regarding NFT projects (for kukai.app & iOS) | `/v1/discover` | +| **Explore** | Info regarding the Explore page (kukai.app & iOS) | `/v1/explore` | +| **Metadata** | Tzkt wrapper for `/tokens/balances`, it augments tzkt's responses with custom metadata for specific contracts/tokens | `/v1/metadata` | +| **Version** | Info regarding suggested/required mobile versions (iOS & Android) | `/v1/version` | +| **Proxy** | A typical api proxy primarily used for ip anonymity | `/v1/proxy` |