Skip to content

Commit

Permalink
includes services table & endpoints [readme]
Browse files Browse the repository at this point in the history
  • Loading branch information
AlexandrosGounis committed Dec 5, 2023
1 parent c928743 commit 746a4a3
Showing 1 changed file with 13 additions and 3 deletions.
16 changes: 13 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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` |


0 comments on commit 746a4a3

Please sign in to comment.