updated docs in prep for prod release

porters-xyz · Aug 23, 2024 · dc32ab8 · dc32ab8
1 parent df0c296
commit dc32ab8
Show file tree

Hide file tree

Showing 5 changed files with 13 additions and 9 deletions.
diff --git a/docs/pages/APIs/TKN/get_contract_address.mdx b/docs/pages/APIs/TKN/get_contract_address.mdx
@@ -1,5 +1,5 @@
 # Get Contract Address
-`GET /token/:portersAppId/contract-address/:ticker`
+`GET https://porters.xyz/api/tkn/v1/token/:portersAppId/contract-address/:ticker`
 
 ## Description
 Fetches the Ethereum contract address associated with the specified ENS name.
@@ -41,7 +41,7 @@ Fetches the Ethereum contract address associated with the specified ENS name.
 
 ## Request
 
-`GET /token/myAppId/contract-address/usdc`
+`GET https://porters.xyz/api/tkn/v1/token/myAppId/contract-address/usdc`
 
 ## Response
 

diff --git a/docs/pages/APIs/TKN/get_contract_metadata.mdx b/docs/pages/APIs/TKN/get_contract_metadata.mdx
@@ -1,5 +1,5 @@
 # Get Contract Metadata
-`GET /token/:portersAppId/:ticker/metadata`
+`GET https://porters.xyz/api/tkn/v1/token/:portersAppId/:ticker/metadata`
 
 ## Description
 Fetches metadata for a specific token based on the ticker symbol. The metadata includes details like contract address, token name, description, associated URLs, and addresses on various blockchains.
@@ -71,7 +71,7 @@ Fetches metadata for a specific token based on the ticker symbol. The metadata i
 
 ## Request
 
-`GET /token/myAppId/usdt/metadata`
+`GET https://porters.xyz/api/tkn/v1/token/myAppId/usdt/metadata`
 
 ## Response
 

diff --git a/docs/pages/APIs/TKN/get_token_balance.mdx b/docs/pages/APIs/TKN/get_token_balance.mdx
@@ -1,5 +1,5 @@
 # Get Token Balance
-`GET /token/:portersAppId/:ticker/balance`
+`GET https://porters.xyz/api/tkn/v1/token/:portersAppId/:ticker/balance`
 
 ## Description
 Fetches the balance of a specific token for a given network and user account.
@@ -64,7 +64,7 @@ Fetches the balance of a specific token for a given network and user account.
 
 ## Request
 
-`GET /token/myAppId/usdc/balance?network=eth&address=0x1234...abcd`
+`GET https://porters.xyz/api/tkn/v1/token/myAppId/usdc/balance?network=eth&address=0x1234...abcd`
 
 ## Response
 

diff --git a/docs/pages/APIs/TKN/get_token_price_data.mdx b/docs/pages/APIs/TKN/get_token_price_data.mdx
@@ -1,5 +1,5 @@
 # Get Token Price Data
-`GET /token/:portersAppId/:ticker/price`
+`GET https://porters.xyz/api/tkn/v1/token/:portersAppId/:ticker/price`
 
 ## Description
 Fetches the current price of a specific token against Wrapped Ether (WETH) on Uniswap V3, using the 0.3% fee tier.
@@ -58,7 +58,7 @@ Fetches the current price of a specific token against Wrapped Ether (WETH) on Un
 
 ## Request
 
-`GET /token/myAppId/usdc/price`
+`GET https://porters.xyz/api/tkn/v1/token/myAppId/usdc/price`
 
 ## Response
 

diff --git a/docs/pages/APIs/TKN/intro.mdx b/docs/pages/APIs/TKN/intro.mdx
@@ -8,4 +8,8 @@ For more information visit [https://tkn.xyz/](https://tkn.xyz/).
 
 Use of this API requires a Porters App to be set up in the Porters backend. The App Id can then be passed as the `portersAppId` parameter.
 
-Since this serice calls multiple chains, it is advisable not to set up any rules that limit chain usage on the App Id that will be used for this API.
+Since this serice calls multiple chains, it is advisable not to set up any rules that limit chain usage on the App Id that will be used for this API.
+
+# Base URI
+
+The base url for this api is `https://porters.xyz/api/tkn/v1`