diff --git a/.gitignore b/.gitignore index d73faa9dd..076ad03cd 100644 --- a/.gitignore +++ b/.gitignore @@ -3,4 +3,5 @@ node_modules .next bun.lockb openapi -public/.DS_Store \ No newline at end of file +.DS_Store +**/.DS_Store \ No newline at end of file diff --git a/content/docs/ordinals/api/brc20/get-brc20-activity.mdx b/content/docs/ordinals/api/brc20/get-brc20-activity.mdx index 96d441e6b..28d016cb7 100644 --- a/content/docs/ordinals/api/brc20/get-brc20-activity.mdx +++ b/content/docs/ordinals/api/brc20/get-brc20-activity.mdx @@ -5,7 +5,7 @@ toc: false --- import { Root, API, APIExample } from "@/components/layout" -import { Property } from "fumadocs-ui/components/api" +import { APIInfo, Property } from "fumadocs-ui/components/api" import { Tabs, Tab } from "fumadocs-ui/components/tabs" import { Accordion, Accordions } from "fumadocs-ui/components/accordion" @@ -13,14 +13,7 @@ import { Accordion, Accordions } from "fumadocs-ui/components/accordion" -
- -

-
- GET -
-

{`/ordinals/v1/brc-20/activity`}

-

+ Retrieves BRC-20 activity filtered by ticker, address, operation, or at a specific block height. @@ -70,7 +63,7 @@ Results per page | :---------- | :--------------- | | `200` | Default response | -
+ diff --git a/content/docs/ordinals/api/brc20/get-brc20-balances.mdx b/content/docs/ordinals/api/brc20/get-brc20-balances.mdx index fae82a609..a117bbe41 100644 --- a/content/docs/ordinals/api/brc20/get-brc20-balances.mdx +++ b/content/docs/ordinals/api/brc20/get-brc20-balances.mdx @@ -5,7 +5,7 @@ toc: false --- import { Root, API, APIExample } from "@/components/layout" -import { Property } from "fumadocs-ui/components/api" +import { APIInfo, Property } from "fumadocs-ui/components/api" import { Tabs, Tab } from "fumadocs-ui/components/tabs" import { Accordion, Accordions } from "fumadocs-ui/components/accordion" @@ -13,14 +13,7 @@ import { Accordion, Accordions } from "fumadocs-ui/components/accordion" -
- -

-
- GET -
-

{`/ordinals/v1/brc-20/balances/{address}`}

-

+ Retrieves BRC-20 token balances for a Bitcoin address. @@ -68,7 +61,7 @@ Bitcoin address | :---------- | :--------------- | | `200` | Default response | -
+ diff --git a/content/docs/ordinals/api/brc20/get-brc20-token-details.mdx b/content/docs/ordinals/api/brc20/get-brc20-token-details.mdx index 78c1b873c..6a58cf388 100644 --- a/content/docs/ordinals/api/brc20/get-brc20-token-details.mdx +++ b/content/docs/ordinals/api/brc20/get-brc20-token-details.mdx @@ -5,7 +5,7 @@ toc: false --- import { Root, API, APIExample } from "@/components/layout" -import { Property } from "fumadocs-ui/components/api" +import { APIInfo, Property } from "fumadocs-ui/components/api" import { Tabs, Tab } from "fumadocs-ui/components/tabs" import { Accordion, Accordions } from "fumadocs-ui/components/accordion" @@ -13,14 +13,7 @@ import { Accordion, Accordions } from "fumadocs-ui/components/accordion" -
- -

-
- GET -
-

{`/ordinals/v1/brc-20/tokens/{ticker}`}

-

+ Retrieves information for a BRC-20 token, including supply and holders. @@ -35,7 +28,7 @@ Retrieves information for a BRC-20 token, including supply and holders. | `200` | Default response | | `404` | Default response | -
+ diff --git a/content/docs/ordinals/api/brc20/get-brc20-token-holders.mdx b/content/docs/ordinals/api/brc20/get-brc20-token-holders.mdx index 822609df5..8464db650 100644 --- a/content/docs/ordinals/api/brc20/get-brc20-token-holders.mdx +++ b/content/docs/ordinals/api/brc20/get-brc20-token-holders.mdx @@ -5,7 +5,7 @@ toc: false --- import { Root, API, APIExample } from "@/components/layout" -import { Property } from "fumadocs-ui/components/api" +import { APIInfo, Property } from "fumadocs-ui/components/api" import { Tabs, Tab } from "fumadocs-ui/components/tabs" import { Accordion, Accordions } from "fumadocs-ui/components/accordion" @@ -13,14 +13,7 @@ import { Accordion, Accordions } from "fumadocs-ui/components/accordion" -
- -

-
- GET -
-

{`/ordinals/v1/brc-20/tokens/{ticker}/holders`}

-

+ Retrieves a list of holders and their balances for a specified BRC-20 token. @@ -55,7 +48,7 @@ Results per page | `200` | Default response | | `404` | Default response | -
+ diff --git a/content/docs/ordinals/api/brc20/get-brc20-tokens.mdx b/content/docs/ordinals/api/brc20/get-brc20-tokens.mdx index 3cd83b594..f6b9d1390 100644 --- a/content/docs/ordinals/api/brc20/get-brc20-tokens.mdx +++ b/content/docs/ordinals/api/brc20/get-brc20-tokens.mdx @@ -5,7 +5,7 @@ toc: false --- import { Root, API, APIExample } from "@/components/layout" -import { Property } from "fumadocs-ui/components/api" +import { APIInfo, Property } from "fumadocs-ui/components/api" import { Tabs, Tab } from "fumadocs-ui/components/tabs" import { Accordion, Accordions } from "fumadocs-ui/components/accordion" @@ -13,14 +13,7 @@ import { Accordion, Accordions } from "fumadocs-ui/components/accordion" -
- -

-
- GET -
-

{`/ordinals/v1/brc-20/tokens`}

-

+ Retrieves information for BRC-20 tokens. @@ -58,7 +51,7 @@ Results per page | :---------- | :--------------- | | `200` | Default response | -
+ diff --git a/content/docs/ordinals/api/info/status.mdx b/content/docs/ordinals/api/info/status.mdx index b44ea0449..03fa7b3e6 100644 --- a/content/docs/ordinals/api/info/status.mdx +++ b/content/docs/ordinals/api/info/status.mdx @@ -13,14 +13,7 @@ import { Accordion, Accordions } from "fumadocs-ui/components/accordion" -
- -

-
- GET -
-

{`/ordinals/v1/`}

-

+ Displays the status of the Ordinals API. @@ -28,7 +21,7 @@ Displays the status of the Ordinals API. | :---------- | :--------------- | | `200` | Default response | -
+ diff --git a/content/docs/ordinals/api/inscriptions/get-inscription-content.mdx b/content/docs/ordinals/api/inscriptions/get-inscription-content.mdx index 0e4e0947f..7297a739a 100644 --- a/content/docs/ordinals/api/inscriptions/get-inscription-content.mdx +++ b/content/docs/ordinals/api/inscriptions/get-inscription-content.mdx @@ -5,7 +5,7 @@ toc: false --- import { Root, API, APIExample } from "@/components/layout" -import { Property } from "fumadocs-ui/components/api" +import { APIInfo, Property } from "fumadocs-ui/components/api" import { Tabs, Tab } from "fumadocs-ui/components/tabs" import { Accordion, Accordions } from "fumadocs-ui/components/accordion" @@ -13,14 +13,7 @@ import { Accordion, Accordions } from "fumadocs-ui/components/accordion" -
- -

-
- GET -
-

{`/ordinals/v1/inscriptions/{id}/content`}

-

+ Retrieves the content of a single inscription. @@ -37,7 +30,7 @@ Inscription unique identifier (number or ID) | `200` | Default response | | `404` | Default response | -
+ diff --git a/content/docs/ordinals/api/inscriptions/get-inscription-transfers.mdx b/content/docs/ordinals/api/inscriptions/get-inscription-transfers.mdx index db6ce11df..e65d3b5df 100644 --- a/content/docs/ordinals/api/inscriptions/get-inscription-transfers.mdx +++ b/content/docs/ordinals/api/inscriptions/get-inscription-transfers.mdx @@ -5,7 +5,7 @@ toc: false --- import { Root, API, APIExample } from "@/components/layout" -import { Property } from "fumadocs-ui/components/api" +import { APIInfo, Property } from "fumadocs-ui/components/api" import { Tabs, Tab } from "fumadocs-ui/components/tabs" import { Accordion, Accordions } from "fumadocs-ui/components/accordion" @@ -13,14 +13,7 @@ import { Accordion, Accordions } from "fumadocs-ui/components/accordion" -
- -

-
- GET -
-

{`/ordinals/v1/inscriptions/{id}/transfers`}

-

+ Retrieves all transfers for a single inscription. @@ -57,7 +50,7 @@ Inscription unique identifier (number or ID) | `200` | Default response | | `404` | Default response | -
+ diff --git a/content/docs/ordinals/api/inscriptions/get-inscription.mdx b/content/docs/ordinals/api/inscriptions/get-inscription.mdx index 00f6b45d6..8e968dd53 100644 --- a/content/docs/ordinals/api/inscriptions/get-inscription.mdx +++ b/content/docs/ordinals/api/inscriptions/get-inscription.mdx @@ -5,7 +5,7 @@ toc: false --- import { Root, API, APIExample } from "@/components/layout" -import { Property } from "fumadocs-ui/components/api" +import { APIInfo, Property } from "fumadocs-ui/components/api" import { Tabs, Tab } from "fumadocs-ui/components/tabs" import { Accordion, Accordions } from "fumadocs-ui/components/accordion" @@ -13,14 +13,7 @@ import { Accordion, Accordions } from "fumadocs-ui/components/accordion" -
- -

-
- GET -
-

{`/ordinals/v1/inscriptions/{id}`}

-

+ Retrieves a single inscription. @@ -37,7 +30,7 @@ Inscription unique identifier (number or ID) | `200` | Default response | | `404` | Default response | -
+ diff --git a/content/docs/ordinals/api/inscriptions/get-inscriptions.mdx b/content/docs/ordinals/api/inscriptions/get-inscriptions.mdx index e719210f0..ef687b8fd 100644 --- a/content/docs/ordinals/api/inscriptions/get-inscriptions.mdx +++ b/content/docs/ordinals/api/inscriptions/get-inscriptions.mdx @@ -5,7 +5,7 @@ toc: false --- import { Root, API, APIExample } from "@/components/layout" -import { Property } from "fumadocs-ui/components/api" +import { APIInfo, Property } from "fumadocs-ui/components/api" import { Tabs, Tab } from "fumadocs-ui/components/tabs" import { Accordion, Accordions } from "fumadocs-ui/components/accordion" @@ -13,14 +13,7 @@ import { Accordion, Accordions } from "fumadocs-ui/components/accordion" -
- -

-
- GET -
-

{`/ordinals/v1/inscriptions`}

-

+ Retrieves a list of inscriptions with options to filter and sort results. @@ -195,7 +188,7 @@ Results order | `200` | Default response | | `404` | Default response | -
+ diff --git a/content/docs/ordinals/api/inscriptions/get-transfers-per-block.mdx b/content/docs/ordinals/api/inscriptions/get-transfers-per-block.mdx index 3360fe7c6..7b7ea3867 100644 --- a/content/docs/ordinals/api/inscriptions/get-transfers-per-block.mdx +++ b/content/docs/ordinals/api/inscriptions/get-transfers-per-block.mdx @@ -5,7 +5,7 @@ toc: false --- import { Root, API, APIExample } from "@/components/layout" -import { Property } from "fumadocs-ui/components/api" +import { APIInfo, Property } from "fumadocs-ui/components/api" import { Tabs, Tab } from "fumadocs-ui/components/tabs" import { Accordion, Accordions } from "fumadocs-ui/components/accordion" @@ -13,14 +13,7 @@ import { Accordion, Accordions } from "fumadocs-ui/components/accordion" -
- -

-
- GET -
-

{`/ordinals/v1/inscriptions/transfers`}

-

+ Retrieves a list of inscription transfers that ocurred at a specific Bitcoin block. @@ -55,7 +48,7 @@ Results per page | `200` | Default response | | `404` | Default response | -
+ diff --git a/content/docs/ordinals/api/satoshis/get-satoshi-inscriptions.mdx b/content/docs/ordinals/api/satoshis/get-satoshi-inscriptions.mdx index 0098371b7..8f1323149 100644 --- a/content/docs/ordinals/api/satoshis/get-satoshi-inscriptions.mdx +++ b/content/docs/ordinals/api/satoshis/get-satoshi-inscriptions.mdx @@ -5,7 +5,7 @@ toc: false --- import { Root, API, APIExample } from "@/components/layout" -import { Property } from "fumadocs-ui/components/api" +import { APIInfo, Property } from "fumadocs-ui/components/api" import { Tabs, Tab } from "fumadocs-ui/components/tabs" import { Accordion, Accordions } from "fumadocs-ui/components/accordion" @@ -13,14 +13,7 @@ import { Accordion, Accordions } from "fumadocs-ui/components/accordion" -
- -

-
- GET -
-

{`/ordinals/v1/sats/{ordinal}/inscriptions`}

-

+ Retrieves all inscriptions associated with a single satoshi. @@ -59,7 +52,7 @@ Ordinal number that uniquely identifies a satoshi | `200` | Default response | | `400` | Default response | -
+ diff --git a/content/docs/ordinals/api/satoshis/get-satoshi.mdx b/content/docs/ordinals/api/satoshis/get-satoshi.mdx index e2a636b95..2a0c1602d 100644 --- a/content/docs/ordinals/api/satoshis/get-satoshi.mdx +++ b/content/docs/ordinals/api/satoshis/get-satoshi.mdx @@ -5,7 +5,7 @@ toc: false --- import { Root, API, APIExample } from "@/components/layout" -import { Property } from "fumadocs-ui/components/api" +import { APIInfo, Property } from "fumadocs-ui/components/api" import { Tabs, Tab } from "fumadocs-ui/components/tabs" import { Accordion, Accordions } from "fumadocs-ui/components/accordion" @@ -13,14 +13,7 @@ import { Accordion, Accordions } from "fumadocs-ui/components/accordion" -
- -

-
- GET -
-

{`/ordinals/v1/sats/{ordinal}`}

-

+ Retrieves ordinal information for a single satoshi. @@ -39,7 +32,7 @@ Ordinal number that uniquely identifies a satoshi | `200` | Default response | | `400` | Default response | -
+ diff --git a/content/docs/ordinals/api/statistics/get-stats-inscription-count.mdx b/content/docs/ordinals/api/statistics/get-stats-inscription-count.mdx index 3fc824283..f280c677d 100644 --- a/content/docs/ordinals/api/statistics/get-stats-inscription-count.mdx +++ b/content/docs/ordinals/api/statistics/get-stats-inscription-count.mdx @@ -5,7 +5,7 @@ toc: false --- import { Root, API, APIExample } from "@/components/layout" -import { Property } from "fumadocs-ui/components/api" +import { APIInfo, Property } from "fumadocs-ui/components/api" import { Tabs, Tab } from "fumadocs-ui/components/tabs" import { Accordion, Accordions } from "fumadocs-ui/components/accordion" @@ -13,14 +13,7 @@ import { Accordion, Accordions } from "fumadocs-ui/components/accordion" -
- -

-
- GET -
-

{`/ordinals/v1/stats/inscriptions`}

-

+ Retrieves statistics on the number of inscriptions revealed per block. @@ -47,7 +40,7 @@ Bitcoin block height | `200` | Default response | | `404` | Default response | -
+ diff --git a/content/docs/stacks/api/accounts/assets.mdx b/content/docs/stacks/api/accounts/assets.mdx index a8dda3be7..06cc45d89 100644 --- a/content/docs/stacks/api/accounts/assets.mdx +++ b/content/docs/stacks/api/accounts/assets.mdx @@ -5,7 +5,7 @@ toc: false --- import { Root, API, APIExample } from '@/components/layout'; -import { Property } from 'fumadocs-ui/components/api' +import { APIInfo, Property } from 'fumadocs-ui/components/api' import { Badge } from '@/components/ui/badge'; import { Tabs, Tab } from 'fumadocs-ui/components/tabs' import { Tabs as UITabs, TabsContent, TabsList, TabsTrigger } from '@/components/ui/tabs'; @@ -17,14 +17,7 @@ import { InlineCode } from '@/components/inline-code'; -
- -

-
- GET -
-

{`/extended/v1/address/{principal}/assets`}

-

+ Retrieves a list of all asset events associated with an account or a contract identifier. This includes transfers and mints. @@ -78,7 +71,7 @@ Returned data representing the state at that point in time, rather than the curr | :----------- | :----------- | | `200` | Success | -
+ diff --git a/content/docs/stacks/api/accounts/balances.mdx b/content/docs/stacks/api/accounts/balances.mdx index 8d0f20d36..cdadbeef0 100644 --- a/content/docs/stacks/api/accounts/balances.mdx +++ b/content/docs/stacks/api/accounts/balances.mdx @@ -5,7 +5,7 @@ toc: false --- import { Root, API, APIExample } from '@/components/layout'; -import { Property } from 'fumadocs-ui/components/api' +import { APIInfo, Property } from 'fumadocs-ui/components/api' import { Badge } from '@/components/ui/badge'; import { Tabs, Tab } from 'fumadocs-ui/components/tabs' import { Tabs as UITabs, TabsContent, TabsList, TabsTrigger } from '@/components/ui/tabs'; @@ -17,14 +17,7 @@ import { InlineCode } from '@/components/inline-code'; -
- -

-
- GET -
-

{`/extended/v1/address/{principal}/balances`}

-

+ Retrieves total account balance information for a given address or contract identifier. This includes the balances of STX tokens, fungible tokens and non-fungible tokens. @@ -62,7 +55,7 @@ Returned data representing the state up until that point in time, rather than th |:------------|:--------------| | `200` | Success | -
+ diff --git a/content/docs/stacks/api/accounts/inbound-stx-transfers.mdx b/content/docs/stacks/api/accounts/inbound-stx-transfers.mdx index ea738be03..b13b3e8b6 100644 --- a/content/docs/stacks/api/accounts/inbound-stx-transfers.mdx +++ b/content/docs/stacks/api/accounts/inbound-stx-transfers.mdx @@ -5,7 +5,7 @@ toc: false --- import { Root, API, APIExample } from '@/components/layout'; -import { Property } from 'fumadocs-ui/components/api' +import { APIInfo, Property } from 'fumadocs-ui/components/api' import { Badge } from '@/components/ui/badge'; import { Tabs, Tab } from 'fumadocs-ui/components/tabs' import { Tabs as UITabs, TabsContent, TabsList, TabsTrigger } from '@/components/ui/tabs'; @@ -17,14 +17,7 @@ import { InlineCode } from '@/components/inline-code'; -
- -

-
- GET -
-

{`/extended/v1/address/{principal}/stx_inbound`}

-

+ Retrieves a list of STX transfers with memos to the given principal. @@ -84,7 +77,7 @@ Returned data representing the state up until that point in time, rather than th | :----------- | :----------- | | `200` | Success | -
+ diff --git a/content/docs/stacks/api/accounts/info.mdx b/content/docs/stacks/api/accounts/info.mdx index 14c45c64b..f0591f74d 100644 --- a/content/docs/stacks/api/accounts/info.mdx +++ b/content/docs/stacks/api/accounts/info.mdx @@ -5,7 +5,7 @@ toc: false --- import { Root, API, APIExample } from '@/components/layout'; -import { Property } from 'fumadocs-ui/components/api' +import { APIInfo, Property } from 'fumadocs-ui/components/api' import { Badge } from '@/components/ui/badge'; import { Tabs, Tab } from 'fumadocs-ui/components/tabs' import { Tabs as UITabs, TabsContent, TabsList, TabsTrigger } from '@/components/ui/tabs'; @@ -17,14 +17,7 @@ import { InlineCode } from '@/components/inline-code'; -
- -

-
- GET -
-

{`/extended/v1/address/{principal}`}

-

+ Retrieves the account data for a given account or contract identifier, where the balance is the hex encoding of a unsigned 128-bit integer (big-endian), the nonce is an unsigned 64-bit integer, and the proofs are provided as hex strings. @@ -59,7 +52,7 @@ The Stacks chain tip to query from | :----------- | :----------- | | `200` | Success | -
+ diff --git a/content/docs/stacks/api/accounts/latest-nonce.mdx b/content/docs/stacks/api/accounts/latest-nonce.mdx index 28bd1cdfe..b49acadc7 100644 --- a/content/docs/stacks/api/accounts/latest-nonce.mdx +++ b/content/docs/stacks/api/accounts/latest-nonce.mdx @@ -5,7 +5,7 @@ toc: false --- import { Root, API, APIExample } from '@/components/layout'; -import { Property } from 'fumadocs-ui/components/api' +import { APIInfo, Property } from 'fumadocs-ui/components/api' import { Badge } from '@/components/ui/badge'; import { Tabs, Tab } from 'fumadocs-ui/components/tabs' import { Tabs as UITabs, TabsContent, TabsList, TabsTrigger } from '@/components/ui/tabs'; @@ -15,16 +15,7 @@ import { InlineCode } from '@/components/inline-code'; - - -
- -

-
- GET -
-

{`/extended/v1/address/{principal}/nonces`}

-

+ Retrieves the latest nonce values used by an account by inspecting the mempool and anchored transactions. @@ -60,7 +51,7 @@ Optionally get the nonce at a given block hash. Note: use either of the query pa | :----------- | :----------- | | `200` | Success | -
+ @@ -131,6 +122,4 @@ export interface AddressNonces { - - diff --git a/content/docs/stacks/api/accounts/nft-events.mdx b/content/docs/stacks/api/accounts/nft-events.mdx index 8c307fc4e..f831524a2 100644 --- a/content/docs/stacks/api/accounts/nft-events.mdx +++ b/content/docs/stacks/api/accounts/nft-events.mdx @@ -5,8 +5,7 @@ toc: false --- import { Root, API, APIExample } from '@/components/layout'; -import { APIInfo } from "fumadocs-ui/components/api" -import { Property } from 'fumadocs-ui/components/api' +import { APIInfo, Property } from 'fumadocs-ui/components/api' import { Badge } from '@/components/ui/badge'; import { Tabs, Tab } from 'fumadocs-ui/components/tabs' import { Tabs as UITabs, TabsContent, TabsList, TabsTrigger } from '@/components/ui/tabs'; @@ -18,14 +17,7 @@ import { InlineCode } from '@/components/inline-code'; -
- -

-
- GET -
-

{`/extended/v1/address/{principal}/nft_events`}

-

+ **NOTE:** This endpoint is deprecated in favor of [Get nft holdings](/stacks/api/non-fungible-tokens/holdings). @@ -79,7 +71,7 @@ Returned data representing the state up until that point in time, rather than th | :----------- | :----------- | | `200` | Success | -
+ diff --git a/content/docs/stacks/api/accounts/stx-balances.mdx b/content/docs/stacks/api/accounts/stx-balances.mdx index c43217997..dca58fdea 100644 --- a/content/docs/stacks/api/accounts/stx-balances.mdx +++ b/content/docs/stacks/api/accounts/stx-balances.mdx @@ -5,7 +5,7 @@ toc: false --- import { Root, API, APIExample } from '@/components/layout'; -import { Property } from 'fumadocs-ui/components/api' +import { APIInfo, Property } from 'fumadocs-ui/components/api' import { Tabs, Tab } from 'fumadocs-ui/components/tabs' import { Accordion, Accordions } from 'fumadocs-ui/components/accordion'; @@ -13,14 +13,7 @@ import { Accordion, Accordions } from 'fumadocs-ui/components/accordion'; -
- -

-
- GET -
-

{`/extended/v1/address/{principal}/stx`}

-

+ Retrieves STX token balance for a given address or contract identifier. @@ -58,7 +51,7 @@ Returned data representing the state up until that point in time, rather than th |:------------|:--------------| | `200` | Success | -
+ diff --git a/content/docs/stacks/api/accounts/transaction-with-transfers.mdx b/content/docs/stacks/api/accounts/transaction-with-transfers.mdx index 11afedd47..e1f48d062 100644 --- a/content/docs/stacks/api/accounts/transaction-with-transfers.mdx +++ b/content/docs/stacks/api/accounts/transaction-with-transfers.mdx @@ -5,7 +5,7 @@ toc: false --- import { Root, API, APIExample } from '@/components/layout'; -import { Property } from 'fumadocs-ui/components/api' +import { APIInfo, Property } from 'fumadocs-ui/components/api' import { Badge } from '@/components/ui/badge'; import { Tabs, Tab } from 'fumadocs-ui/components/tabs' import { Tabs as UITabs, TabsContent, TabsList, TabsTrigger } from '@/components/ui/tabs'; @@ -17,14 +17,7 @@ import { InlineCode } from '@/components/inline-code'; -
- -

-
- GET -
-

{`/extended/v1/address/{principal}/{tx_id}/with_transfers`}

-

+ **NOTE:** This endpoint has been deprecated and may be removed in future versions of the API. @@ -53,7 +46,7 @@ Transaction id | `200` | Success | | `404` | Not found | -
+ diff --git a/content/docs/stacks/api/accounts/transactions-with-transfers.mdx b/content/docs/stacks/api/accounts/transactions-with-transfers.mdx index 3806a9aa7..30ad254af 100644 --- a/content/docs/stacks/api/accounts/transactions-with-transfers.mdx +++ b/content/docs/stacks/api/accounts/transactions-with-transfers.mdx @@ -5,7 +5,7 @@ toc: false --- import { Root, API, APIExample } from '@/components/layout'; -import { Property } from 'fumadocs-ui/components/api' +import { APIInfo, Property } from 'fumadocs-ui/components/api' import { Badge } from '@/components/ui/badge'; import { Tabs, Tab } from 'fumadocs-ui/components/tabs' import { Tabs as UITabs, TabsContent, TabsList, TabsTrigger } from '@/components/ui/tabs'; @@ -17,14 +17,7 @@ import { InlineCode } from '@/components/inline-code'; -
- -

-
- GET -
-

{`/extended/v1/address/{principal}/transactions_with_transfers`}

-

+ **NOTE:** This endpoint has been deprecated and may be removed in future versions of the API. @@ -88,7 +81,7 @@ Returned data representing the state up until that point in time, rather than th | :----------- | :----------- | | `200` | Success | -
+ diff --git a/content/docs/stacks/api/accounts/transactions.mdx b/content/docs/stacks/api/accounts/transactions.mdx index 03af31c83..3fef05d62 100644 --- a/content/docs/stacks/api/accounts/transactions.mdx +++ b/content/docs/stacks/api/accounts/transactions.mdx @@ -5,7 +5,7 @@ toc: false --- import { Root, API, APIExample } from '@/components/layout'; -import { Property } from 'fumadocs-ui/components/api' +import { APIInfo, Property } from 'fumadocs-ui/components/api' import { Badge } from '@/components/ui/badge'; import { Tabs, Tab } from 'fumadocs-ui/components/tabs' import { Tabs as UITabs, TabsContent, TabsList, TabsTrigger } from '@/components/ui/tabs'; @@ -17,14 +17,7 @@ import { InlineCode } from '@/components/inline-code'; -
- -

-
- GET -
-

{`/extended/v1/address/{principal}/transactions`}

-

+ **NOTE:** This endpoint has been deprecated and may be removed in future versions of the API. @@ -90,7 +83,7 @@ returned data representing the state up until that point in time, rather than th |:------------|:--------------| | `200` | Success | -
+ diff --git a/content/docs/stacks/api/blocks/block-by-burn-block-hash.mdx b/content/docs/stacks/api/blocks/block-by-burn-block-hash.mdx index 1de2ea36b..a6c18ed0e 100644 --- a/content/docs/stacks/api/blocks/block-by-burn-block-hash.mdx +++ b/content/docs/stacks/api/blocks/block-by-burn-block-hash.mdx @@ -5,8 +5,7 @@ toc: false --- import { Root, API, APIExample } from '@/components/layout'; -import { APIInfo } from "fumadocs-ui/components/api" -import { Property } from 'fumadocs-ui/components/api' +import { APIInfo, Property } from 'fumadocs-ui/components/api' import { Badge } from '@/components/ui/badge'; import { Tabs, Tab } from 'fumadocs-ui/components/tabs' import { Tabs as UITabs, TabsContent, TabsList, TabsTrigger } from '@/components/ui/tabs'; @@ -18,14 +17,7 @@ import { InlineCode } from '@/components/inline-code'; -
- -

-
- GET -
-

{`/extended/v1/block/by_burn_block_hash/{burn_block_hash}`}

-

+ **NOTE:** This endpoint is deprecated in favor of [Get blocks by burn block](/stacks/api/blocks/get-blocks-by-burn-block). @@ -36,7 +28,7 @@ Retrieves block details of a specific block for a given burnchain block hash | `200` | Block | | `404` | Cannot find block with given height | -
+ diff --git a/content/docs/stacks/api/blocks/block-by-burn-block-height.mdx b/content/docs/stacks/api/blocks/block-by-burn-block-height.mdx index 8847a5606..e44ca9c4a 100644 --- a/content/docs/stacks/api/blocks/block-by-burn-block-height.mdx +++ b/content/docs/stacks/api/blocks/block-by-burn-block-height.mdx @@ -5,8 +5,7 @@ toc: false --- import { Root, API, APIExample } from '@/components/layout'; -import { APIInfo } from "fumadocs-ui/components/api" -import { Property } from 'fumadocs-ui/components/api' +import { APIInfo, Property } from 'fumadocs-ui/components/api' import { Badge } from '@/components/ui/badge'; import { Tabs, Tab } from 'fumadocs-ui/components/tabs' import { Tabs as UITabs, TabsContent, TabsList, TabsTrigger } from '@/components/ui/tabs'; @@ -18,14 +17,7 @@ import { InlineCode } from '@/components/inline-code'; -
- -

-
- GET -
-

{`/extended/v1/block/by_burn_block_height/{burn_block_height}`}

-

+ **NOTE:** This endpoint is deprecated in favor of [Get blocks by burn block](/stacks/api/blocks/get-blocks-by-burn-block). @@ -36,7 +28,7 @@ Retrieves block details of a specific block for a given burn chain height | `200` | Block | | `404` | Cannot find block with given height | -
+ diff --git a/content/docs/stacks/api/blocks/block-by-hash.mdx b/content/docs/stacks/api/blocks/block-by-hash.mdx index ce855852f..0169b2057 100644 --- a/content/docs/stacks/api/blocks/block-by-hash.mdx +++ b/content/docs/stacks/api/blocks/block-by-hash.mdx @@ -5,8 +5,7 @@ toc: false --- import { Root, API, APIExample } from '@/components/layout'; -import { APIInfo } from "fumadocs-ui/components/api" -import { Property } from 'fumadocs-ui/components/api' +import { APIInfo, Property } from 'fumadocs-ui/components/api' import { Badge } from '@/components/ui/badge'; import { Tabs, Tab } from 'fumadocs-ui/components/tabs' import { Tabs as UITabs, TabsContent, TabsList, TabsTrigger } from '@/components/ui/tabs'; @@ -18,14 +17,7 @@ import { InlineCode } from '@/components/inline-code'; -
- -

-
- GET -
-

{`/extended/v1/block/{hash}`}

-

+ **NOTE:** This endpoint is deprecated in favor of [Get block](/stacks/api/blocks/get-block). @@ -36,7 +28,7 @@ Retrieves block details of a specific block for a given chain height. You can us | `200` | Block | | `404` | Cannot find block with given ID | -
+ diff --git a/content/docs/stacks/api/blocks/block-by-height.mdx b/content/docs/stacks/api/blocks/block-by-height.mdx index d8b9b4185..d5b2686a2 100644 --- a/content/docs/stacks/api/blocks/block-by-height.mdx +++ b/content/docs/stacks/api/blocks/block-by-height.mdx @@ -5,8 +5,7 @@ toc: false --- import { Root, API, APIExample } from '@/components/layout'; -import { APIInfo } from "fumadocs-ui/components/api" -import { Property } from 'fumadocs-ui/components/api' +import { APIInfo, Property } from 'fumadocs-ui/components/api' import { Badge } from '@/components/ui/badge'; import { Tabs, Tab } from 'fumadocs-ui/components/tabs' import { Tabs as UITabs, TabsContent, TabsList, TabsTrigger } from '@/components/ui/tabs'; @@ -18,14 +17,7 @@ import { InlineCode } from '@/components/inline-code'; -
- -

-
- GET -
-

{`/extended/v1/block/by_height/{height}`}

-

+ **NOTE:** This endpoint is deprecated in favor of [Get block](/stacks/api/blocks/get-block). @@ -36,7 +28,7 @@ Retrieves block details of a specific block at a given block height | `200` | Block | | `404` | Cannot find block with given height | -
+ diff --git a/content/docs/stacks/api/blocks/get-block.mdx b/content/docs/stacks/api/blocks/get-block.mdx index f03b336c8..62fbea43e 100644 --- a/content/docs/stacks/api/blocks/get-block.mdx +++ b/content/docs/stacks/api/blocks/get-block.mdx @@ -5,8 +5,7 @@ toc: false --- import { Root, API, APIExample } from '@/components/layout'; -import { APIInfo } from "fumadocs-ui/components/api" -import { Property } from 'fumadocs-ui/components/api' +import { APIInfo, Property } from 'fumadocs-ui/components/api' import { Badge } from '@/components/ui/badge'; import { Tabs, Tab } from 'fumadocs-ui/components/tabs' import { Tabs as UITabs, TabsContent, TabsList, TabsTrigger } from '@/components/ui/tabs'; @@ -18,14 +17,7 @@ import { InlineCode } from '@/components/inline-code'; -
- -

-
- GET -
-

{`/extended/v2/blocks/{height_or_hash}`}

-

+ Retrieves a single block @@ -41,7 +33,7 @@ Filter by block height, hash, index block hash or the constant `latest` to filte | :----------- | :----------- | | `200` | Block | -
+ diff --git a/content/docs/stacks/api/blocks/get-blocks-by-burn-block.mdx b/content/docs/stacks/api/blocks/get-blocks-by-burn-block.mdx index c4ffdf1f8..6a452cd05 100644 --- a/content/docs/stacks/api/blocks/get-blocks-by-burn-block.mdx +++ b/content/docs/stacks/api/blocks/get-blocks-by-burn-block.mdx @@ -5,8 +5,7 @@ toc: false --- import { Root, API, APIExample } from '@/components/layout'; -import { APIInfo } from "fumadocs-ui/components/api" -import { Property } from 'fumadocs-ui/components/api' +import { APIInfo, Property } from 'fumadocs-ui/components/api' import { Badge } from '@/components/ui/badge'; import { Tabs, Tab } from 'fumadocs-ui/components/tabs' import { Tabs as UITabs, TabsContent, TabsList, TabsTrigger } from '@/components/ui/tabs'; @@ -18,14 +17,7 @@ import { InlineCode } from '@/components/inline-code'; -
- -

-
- GET -
-

{`/extended/v2/burn-blocks/{height_or_hash}/blocks`}

-

+ Retrieves a list of blocks confirmed by a specific burn block. @@ -59,7 +51,7 @@ Index of first burn block to fetch | :----------- | :----------- | | `200` | List of blocks | -
+ diff --git a/content/docs/stacks/api/blocks/get-blocks.mdx b/content/docs/stacks/api/blocks/get-blocks.mdx index 705ec06f1..fde232bf3 100644 --- a/content/docs/stacks/api/blocks/get-blocks.mdx +++ b/content/docs/stacks/api/blocks/get-blocks.mdx @@ -5,8 +5,7 @@ toc: false --- import { Root, API, APIExample } from '@/components/layout'; -import { APIInfo } from "fumadocs-ui/components/api" -import { Property } from 'fumadocs-ui/components/api' +import { APIInfo, Property } from 'fumadocs-ui/components/api' import { Badge } from '@/components/ui/badge'; import { Tabs, Tab } from 'fumadocs-ui/components/tabs' import { Tabs as UITabs, TabsContent, TabsList, TabsTrigger } from '@/components/ui/tabs'; @@ -18,14 +17,7 @@ import { InlineCode } from '@/components/inline-code'; -
- -

-
- GET -
-

{`/extended/v2/blocks`}

-

+ Retrieves a list of recently mined blocks. If you need to actively monitor new blocks, we highly recommend using the [`@stacks/blockchain-api-client`](/stacks/api/client) library for real-time updates. @@ -51,7 +43,7 @@ Index of first burn block to fetch | :----------- | :----------- | | `200` | List of blocks | -
+ diff --git a/content/docs/stacks/api/blocks/recent-blocks.mdx b/content/docs/stacks/api/blocks/recent-blocks.mdx index 99409d042..52ccd9e9c 100644 --- a/content/docs/stacks/api/blocks/recent-blocks.mdx +++ b/content/docs/stacks/api/blocks/recent-blocks.mdx @@ -5,8 +5,7 @@ toc: false --- import { Root, API, APIExample } from '@/components/layout'; -import { APIInfo } from "fumadocs-ui/components/api" -import { Property } from 'fumadocs-ui/components/api' +import { APIInfo, Property } from 'fumadocs-ui/components/api' import { Badge } from '@/components/ui/badge'; import { Tabs, Tab } from 'fumadocs-ui/components/tabs' import { Tabs as UITabs, TabsContent, TabsList, TabsTrigger } from '@/components/ui/tabs'; @@ -18,14 +17,7 @@ import { InlineCode } from '@/components/inline-code'; -
- -

-
- GET -
-

{`/extended/v1/block`}

-

+ **NOTE:** This endpoint is deprecated in favor of [Get blocks](/stacks/api/blocks/get-blocks). @@ -55,7 +47,7 @@ Index of first block to fetch | :----------- | :----------- | | `200` | List of blocks | -
+ diff --git a/content/docs/stacks/api/burn-blocks/get-burn-block.mdx b/content/docs/stacks/api/burn-blocks/get-burn-block.mdx index 5b2f7a4b9..f9bda2c53 100644 --- a/content/docs/stacks/api/burn-blocks/get-burn-block.mdx +++ b/content/docs/stacks/api/burn-blocks/get-burn-block.mdx @@ -5,8 +5,7 @@ toc: false --- import { Root, API, APIExample } from '@/components/layout'; -import { APIInfo } from "fumadocs-ui/components/api" -import { Property } from 'fumadocs-ui/components/api' +import { APIInfo, Property } from 'fumadocs-ui/components/api' import { Badge } from '@/components/ui/badge'; import { Tabs, Tab } from 'fumadocs-ui/components/tabs' import { Tabs as UITabs, TabsContent, TabsList, TabsTrigger } from '@/components/ui/tabs'; @@ -18,14 +17,7 @@ import { InlineCode } from '@/components/inline-code'; -
- -

-
- GET -
-

{`/extended/v2/burn-blocks/{height_or_hash}`}

-

+ Retrieves a single burn block. @@ -41,7 +33,7 @@ Filter by burn block height, hash, or the constant `latest` to filter for the mo | :----------- | :----------- | | `200` | Burn block | -
+ diff --git a/content/docs/stacks/api/burn-blocks/get-burn-blocks.mdx b/content/docs/stacks/api/burn-blocks/get-burn-blocks.mdx index b76caa43d..a4fc8347f 100644 --- a/content/docs/stacks/api/burn-blocks/get-burn-blocks.mdx +++ b/content/docs/stacks/api/burn-blocks/get-burn-blocks.mdx @@ -5,8 +5,7 @@ toc: false --- import { Root, API, APIExample } from '@/components/layout'; -import { APIInfo } from "fumadocs-ui/components/api" -import { Property } from 'fumadocs-ui/components/api' +import { APIInfo, Property } from 'fumadocs-ui/components/api' import { Badge } from '@/components/ui/badge'; import { Tabs, Tab } from 'fumadocs-ui/components/tabs' import { Tabs as UITabs, TabsContent, TabsList, TabsTrigger } from '@/components/ui/tabs'; @@ -18,14 +17,7 @@ import { InlineCode } from '@/components/inline-code'; -
- -

-
- GET -
-

{`/extended/v2/burn-blocks`}

-

+ Retrieves a list of recent burn blocks. @@ -53,7 +45,7 @@ Index of first burn block to fetch | :----------- | :----------- | | `200` | List of burn blocks | -
+ diff --git a/content/docs/stacks/api/faucets/btc.mdx b/content/docs/stacks/api/faucets/btc.mdx index 8a5086393..225f4370f 100644 --- a/content/docs/stacks/api/faucets/btc.mdx +++ b/content/docs/stacks/api/faucets/btc.mdx @@ -5,7 +5,7 @@ toc: false --- import { Root, API, APIExample } from '@/components/layout'; -import { Property } from 'fumadocs-ui/components/api' +import { APIInfo, Property } from 'fumadocs-ui/components/api' import { Tabs, Tab } from 'fumadocs-ui/components/tabs' import { Accordion, Accordions } from 'fumadocs-ui/components/accordion'; @@ -13,14 +13,7 @@ import { Accordion, Accordions } from 'fumadocs-ui/components/accordion'; -
- -

-
- POST -
-

{`/extended/v1/faucets/btc`}

-

+ Add 1 BTC token to the specified testnet BTC address. @@ -42,7 +35,7 @@ BTC testnet address | `403` | BTC Faucet not fully configured | | `500` | Faucet call failed | -
+ diff --git a/content/docs/stacks/api/faucets/stx.mdx b/content/docs/stacks/api/faucets/stx.mdx index 43bfe0671..a16434b1f 100644 --- a/content/docs/stacks/api/faucets/stx.mdx +++ b/content/docs/stacks/api/faucets/stx.mdx @@ -5,7 +5,7 @@ toc: false --- import { Root, API, APIExample } from '@/components/layout'; -import { Property } from 'fumadocs-ui/components/api' +import { APIInfo, Property } from 'fumadocs-ui/components/api' import { Tabs, Tab } from 'fumadocs-ui/components/tabs' import { Accordion, Accordions } from 'fumadocs-ui/components/accordion'; @@ -13,14 +13,7 @@ import { Accordion, Accordions } from 'fumadocs-ui/components/accordion'; -
- -

-
- POST -
-

{`/extended/v1/faucets/stx`}

-

+ Add 500 STX tokens to the specified testnet address. Testnet STX addresses begin with `ST`. If the `stacking` parameter is set to `true`, the faucet will add the required number of tokens for individual stacking to the @@ -58,7 +51,7 @@ Request the amount of STX tokens needed for individual address stacking | `200` | Success | | `500` | Faucet call failed| -
+ diff --git a/content/docs/stacks/api/fees/estimate.mdx b/content/docs/stacks/api/fees/estimate.mdx index dd6b915b0..efb53013f 100644 --- a/content/docs/stacks/api/fees/estimate.mdx +++ b/content/docs/stacks/api/fees/estimate.mdx @@ -5,8 +5,7 @@ toc: false --- import { Root, API, APIExample } from '@/components/layout'; -import { APIInfo } from "fumadocs-ui/components/api" -import { Property } from 'fumadocs-ui/components/api' +import { APIInfo, Property } from 'fumadocs-ui/components/api' import { Badge } from '@/components/ui/badge'; import { Tabs, Tab } from 'fumadocs-ui/components/tabs' import { Tabs as UITabs, TabsContent, TabsList, TabsTrigger } from '@/components/ui/tabs'; @@ -18,14 +17,7 @@ import { InlineCode } from '@/components/inline-code'; -
- -

-
- POST -
-

{`/v2/fees/transaction`}

-

+ Get an estimated fee for a supplied transaction. This estimates the execution cost of the transaction, the current @@ -92,8 +84,6 @@ this fee amount by: ### Request body (optional) - - @@ -103,14 +93,13 @@ this fee amount by: - | Status code | Description | | :--------- | :---------- | | `200` | Estimated fees for the transaction | -
+ diff --git a/content/docs/stacks/api/fees/transfer-estimate.mdx b/content/docs/stacks/api/fees/transfer-estimate.mdx index ffb86198b..c5a79e190 100644 --- a/content/docs/stacks/api/fees/transfer-estimate.mdx +++ b/content/docs/stacks/api/fees/transfer-estimate.mdx @@ -5,8 +5,7 @@ toc: false --- import { Root, API, APIExample } from '@/components/layout'; -import { APIInfo } from "fumadocs-ui/components/api" -import { Property } from 'fumadocs-ui/components/api' +import { APIInfo, Property } from 'fumadocs-ui/components/api' import { Badge } from '@/components/ui/badge'; import { Tabs, Tab } from 'fumadocs-ui/components/tabs' import { Tabs as UITabs, TabsContent, TabsList, TabsTrigger } from '@/components/ui/tabs'; @@ -18,14 +17,7 @@ import { InlineCode } from '@/components/inline-code'; -
- -

-
- GET -
-

{`/v2/fees/transfer`}

-

+ Retrieves an estimated fee rate for STX transfer transactions. This a a fee rate / byte, and is returned as a JSON integer @@ -33,7 +25,7 @@ Retrieves an estimated fee rate for STX transfer transactions. This a a fee rate | :--------- | :---------- | | `200` | Success | -
+ diff --git a/content/docs/stacks/api/info/circulating-stx-supply-in-plain-text.mdx b/content/docs/stacks/api/info/circulating-stx-supply-in-plain-text.mdx index 60298994b..3b05f0225 100644 --- a/content/docs/stacks/api/info/circulating-stx-supply-in-plain-text.mdx +++ b/content/docs/stacks/api/info/circulating-stx-supply-in-plain-text.mdx @@ -5,6 +5,7 @@ toc: false --- import { Root, API, APIExample } from '@/components/layout'; +import { APIInfo } from 'fumadocs-ui/components/api' import { Property } from 'fumadocs-ui/components/api' import { Tabs, Tab } from 'fumadocs-ui/components/tabs' import { Accordion, Accordions } from 'fumadocs-ui/components/accordion'; @@ -13,22 +14,15 @@ import { Accordion, Accordions } from 'fumadocs-ui/components/accordion'; -
- -

-
- GET -
-

{`/extended/v1/stx_supply/circulating/plain`}

-

+ Retrieves the STX tokens currently in circulation that have been unlocked as plain text. | Status code | Description | |:------------|:------------| -| `200` | success | +| `200` | Success | -
+ diff --git a/content/docs/stacks/api/info/core-api.mdx b/content/docs/stacks/api/info/core-api.mdx index d048f7a54..a62bb374a 100644 --- a/content/docs/stacks/api/info/core-api.mdx +++ b/content/docs/stacks/api/info/core-api.mdx @@ -5,7 +5,7 @@ toc: false --- import { Root, API, APIExample } from '@/components/layout'; -import { Property } from 'fumadocs-ui/components/api' +import { APIInfo, Property } from 'fumadocs-ui/components/api' import { Tabs, Tab } from 'fumadocs-ui/components/tabs' import { Accordion, Accordions } from 'fumadocs-ui/components/accordion'; @@ -13,26 +13,15 @@ import { Accordion, Accordions } from 'fumadocs-ui/components/accordion'; -
- -

-
- GET -
-

{`/extended/v2/info`}

-

+ Retrieves information about the Core API including the server version -### Parameters - -No parameters. - | Status code | Description | | :---------- | :---------- | | `200` | Success | -
+ diff --git a/content/docs/stacks/api/info/legacy-total-and-unlocked-stx-supply.mdx b/content/docs/stacks/api/info/legacy-total-and-unlocked-stx-supply.mdx index f761b4d2d..22bb8760a 100644 --- a/content/docs/stacks/api/info/legacy-total-and-unlocked-stx-supply.mdx +++ b/content/docs/stacks/api/info/legacy-total-and-unlocked-stx-supply.mdx @@ -5,7 +5,7 @@ toc: false --- import { Root, API, APIExample } from '@/components/layout'; -import { Property } from 'fumadocs-ui/components/api' +import { APIInfo, Property } from 'fumadocs-ui/components/api' import { Tabs, Tab } from 'fumadocs-ui/components/tabs' import { Accordion, Accordions } from 'fumadocs-ui/components/accordion'; @@ -13,20 +13,12 @@ import { Accordion, Accordions } from 'fumadocs-ui/components/accordion'; -
- -

-
- GET -
-

{`/extended/v1/stx_supply/legacy_format`}

-

+ Retrieves total supply of STX tokens including those currently in circulation that have been unlocked. **Note:** this uses the estimated future total supply for the year 2050. - ### Query parameters @@ -41,7 +33,7 @@ Supply details are queried from a specified block height. If the block height is |:------------|:------------| | `200` | Success | -
+ diff --git a/content/docs/stacks/api/info/network-block-time.mdx b/content/docs/stacks/api/info/network-block-time.mdx index 83ffe63c9..f497c8304 100644 --- a/content/docs/stacks/api/info/network-block-time.mdx +++ b/content/docs/stacks/api/info/network-block-time.mdx @@ -5,7 +5,7 @@ toc: false --- import { Root, API, APIExample } from '@/components/layout'; -import { Property } from 'fumadocs-ui/components/api' +import { APIInfo, Property } from 'fumadocs-ui/components/api' import { Tabs, Tab } from 'fumadocs-ui/components/tabs' import { Accordion, Accordions } from 'fumadocs-ui/components/accordion'; @@ -13,14 +13,7 @@ import { Accordion, Accordions } from 'fumadocs-ui/components/accordion'; -
- -

-
- GET -
-

{`/extended/v1/info/network_block_times`}

-

+ Retrieves the target block times for mainnet and testnet. The block time is hardcoded and will change throughout the implementation phases of testnet. @@ -32,7 +25,7 @@ No parameters. |:------------|:------------| | `200` | Success | -
+ diff --git a/content/docs/stacks/api/info/network-given-block-time.mdx b/content/docs/stacks/api/info/network-given-block-time.mdx index b83f97531..255ce26b8 100644 --- a/content/docs/stacks/api/info/network-given-block-time.mdx +++ b/content/docs/stacks/api/info/network-given-block-time.mdx @@ -5,7 +5,7 @@ toc: false --- import { Root, API, APIExample } from '@/components/layout'; -import { Property } from 'fumadocs-ui/components/api' +import { APIInfo, Property } from 'fumadocs-ui/components/api' import { Tabs, Tab } from 'fumadocs-ui/components/tabs' import { Accordion, Accordions } from 'fumadocs-ui/components/accordion'; @@ -13,14 +13,7 @@ import { Accordion, Accordions } from 'fumadocs-ui/components/accordion'; -
- -

-
- GET -
-

{`/extended/v1/info/network_block_time/{network}`}

-

+ Retrieves the target block time for a given network. The network can be mainnet or testnet. The block time is hardcoded and will change throughout the implementation phases of testnet. @@ -40,7 +33,7 @@ the target block time for a given network (testnet, mainnet). | ----------- | ----------- | | `200` | Success | -
+ diff --git a/content/docs/stacks/api/info/pox-details.mdx b/content/docs/stacks/api/info/pox-details.mdx index d32ba11a8..0753651be 100644 --- a/content/docs/stacks/api/info/pox-details.mdx +++ b/content/docs/stacks/api/info/pox-details.mdx @@ -5,7 +5,7 @@ toc: false --- import { Root, API, APIExample } from '@/components/layout'; -import { Property } from 'fumadocs-ui/components/api' +import { APIInfo, Property } from 'fumadocs-ui/components/api' import { Tabs, Tab } from 'fumadocs-ui/components/tabs' import { Accordion, Accordions } from 'fumadocs-ui/components/accordion'; @@ -13,14 +13,7 @@ import { Accordion, Accordions } from 'fumadocs-ui/components/accordion'; -
- -

-
- GET -
-

{`/v2/pox`}

-

+ Retrieves Proof-of-Transfer (PoX) information. Can be used for Stacking. @@ -28,7 +21,7 @@ Retrieves Proof-of-Transfer (PoX) information. Can be used for Stacking. |:------------|:--------------| | `200` | Success | -
+ diff --git a/content/docs/stacks/api/info/status.mdx b/content/docs/stacks/api/info/status.mdx index 9190dfa57..f38791a2b 100644 --- a/content/docs/stacks/api/info/status.mdx +++ b/content/docs/stacks/api/info/status.mdx @@ -5,7 +5,7 @@ toc: false --- import { Root, API, APIExample } from '@/components/layout'; -import { Property } from 'fumadocs-ui/components/api' +import { APIInfo, Property } from 'fumadocs-ui/components/api' import { Tabs, Tab } from 'fumadocs-ui/components/tabs' import { Accordion, Accordions } from 'fumadocs-ui/components/accordion'; @@ -13,14 +13,7 @@ import { Accordion, Accordions } from 'fumadocs-ui/components/accordion'; -
- -

-
- GET -
-

{`/extended`}

-

+ Retrieves the running status of the Stacks Blockchain API, including the server version and current chain tip information. @@ -32,7 +25,7 @@ No parameters. |:------------|:------------| | `200` | Success | -
+ diff --git a/content/docs/stacks/api/info/total-and-unlocked-stx-supply.mdx b/content/docs/stacks/api/info/total-and-unlocked-stx-supply.mdx index 17d869486..1953a0cfc 100644 --- a/content/docs/stacks/api/info/total-and-unlocked-stx-supply.mdx +++ b/content/docs/stacks/api/info/total-and-unlocked-stx-supply.mdx @@ -5,7 +5,7 @@ toc: false --- import { Root, API, APIExample } from '@/components/layout'; -import { Property } from 'fumadocs-ui/components/api' +import { APIInfo, Property } from 'fumadocs-ui/components/api' import { Tabs, Tab } from 'fumadocs-ui/components/tabs' import { Accordion, Accordions } from 'fumadocs-ui/components/accordion'; @@ -13,14 +13,7 @@ import { Accordion, Accordions } from 'fumadocs-ui/components/accordion'; -
- -

-
- GET -
-

{`/extended/v1/stx_supply`}

-

+ Retrieves the total and unlocked STX supply. More information on Stacking can be found [here](https://docs.stacks.co/understand-stacks/stacking). @@ -40,7 +33,7 @@ Supply details are queried from a specified block height. If the block height is |:------------|:--------------| | `200` | Success | -
+ diff --git a/content/docs/stacks/api/info/total-stx-supply-in-plain-text.mdx b/content/docs/stacks/api/info/total-stx-supply-in-plain-text.mdx index 7b4732b46..2892ba065 100644 --- a/content/docs/stacks/api/info/total-stx-supply-in-plain-text.mdx +++ b/content/docs/stacks/api/info/total-stx-supply-in-plain-text.mdx @@ -5,7 +5,7 @@ toc: false --- import { Root, API, APIExample } from '@/components/layout'; -import { Property } from 'fumadocs-ui/components/api' +import { APIInfo, Property } from 'fumadocs-ui/components/api' import { Tabs, Tab } from 'fumadocs-ui/components/tabs' import { Accordion, Accordions } from 'fumadocs-ui/components/accordion'; @@ -13,14 +13,7 @@ import { Accordion, Accordions } from 'fumadocs-ui/components/accordion'; -
- -

-
- GET -
-

{`/extended/v1/stx_supply/total/plain`}

-

+ Retrieves the total supply for STX tokens as plain text. @@ -30,7 +23,7 @@ Retrieves the total supply for STX tokens as plain text. |:------------|:------------| | `200` | success | -
+ diff --git a/content/docs/stacks/api/mempool/transaction-fee-priorities.mdx b/content/docs/stacks/api/mempool/transaction-fee-priorities.mdx index 6f7c31074..1c72d705f 100644 --- a/content/docs/stacks/api/mempool/transaction-fee-priorities.mdx +++ b/content/docs/stacks/api/mempool/transaction-fee-priorities.mdx @@ -5,8 +5,7 @@ toc: false --- import { Root, API, APIExample } from '@/components/layout'; -import { APIInfo } from "fumadocs-ui/components/api" -import { Property } from 'fumadocs-ui/components/api' +import { APIInfo, Property } from 'fumadocs-ui/components/api' import { Badge } from '@/components/ui/badge'; import { Tabs, Tab } from 'fumadocs-ui/components/tabs' import { Tabs as UITabs, TabsContent, TabsList, TabsTrigger } from '@/components/ui/tabs'; @@ -18,14 +17,7 @@ import { InlineCode } from '@/components/inline-code'; -
- -

-
- GET -
-

{`/extended/v2/mempool/fees`}

-

+ Returns estimated fee priorities (in micro-STX) for all transactions that are currently in the mempool. Also returns priorities separated by transaction type. @@ -33,7 +25,7 @@ Returns estimated fee priorities (in micro-STX) for all transactions that are cu | :----------- | :----------- | | `200` | Mempool fee priorities | -
+ diff --git a/content/docs/stacks/api/names/historical-zonefile.mdx b/content/docs/stacks/api/names/historical-zonefile.mdx index 625d0105b..86a0fcc47 100644 --- a/content/docs/stacks/api/names/historical-zonefile.mdx +++ b/content/docs/stacks/api/names/historical-zonefile.mdx @@ -5,8 +5,7 @@ toc: false --- import { Root, API, APIExample } from '@/components/layout'; -import { APIInfo } from "fumadocs-ui/components/api" -import { Property } from 'fumadocs-ui/components/api' +import { APIInfo, Property } from 'fumadocs-ui/components/api' import { Badge } from '@/components/ui/badge'; import { Tabs, Tab } from 'fumadocs-ui/components/tabs' import { Tabs as UITabs, TabsContent, TabsList, TabsTrigger } from '@/components/ui/tabs'; @@ -18,14 +17,7 @@ import { InlineCode } from '@/components/inline-code'; -
- -

-
- GET -
-

{`/v1/names/{name}/zonefile/{zoneFileHash}`}

-

+ Retrieves the historical zonefile specified by the username and zone hash. @@ -53,7 +45,7 @@ Zone file hash | `400` | Error | | `404` | Error | -
+ diff --git a/content/docs/stacks/api/names/name-details.mdx b/content/docs/stacks/api/names/name-details.mdx index 8f99fb513..6a7afea90 100644 --- a/content/docs/stacks/api/names/name-details.mdx +++ b/content/docs/stacks/api/names/name-details.mdx @@ -5,8 +5,7 @@ toc: false --- import { Root, API, APIExample } from '@/components/layout'; -import { APIInfo } from "fumadocs-ui/components/api" -import { Property } from 'fumadocs-ui/components/api' +import { APIInfo, Property } from 'fumadocs-ui/components/api' import { Badge } from '@/components/ui/badge'; import { Tabs, Tab } from 'fumadocs-ui/components/tabs' import { Tabs as UITabs, TabsContent, TabsList, TabsTrigger } from '@/components/ui/tabs'; @@ -18,14 +17,7 @@ import { InlineCode } from '@/components/inline-code'; -
- -

-
- GET -
-

{`/v1/names/{name}`}

-

+ Retrieves details of a given name including the `address`, `status` and last transaction ID `last_txid`. @@ -45,7 +37,7 @@ Fully-qualified name | `400` | Error | | `404` | Error | -
+ diff --git a/content/docs/stacks/api/names/name-price.mdx b/content/docs/stacks/api/names/name-price.mdx index ee44e5ec3..a46612986 100644 --- a/content/docs/stacks/api/names/name-price.mdx +++ b/content/docs/stacks/api/names/name-price.mdx @@ -5,8 +5,7 @@ toc: false --- import { Root, API, APIExample } from '@/components/layout'; -import { APIInfo } from "fumadocs-ui/components/api" -import { Property } from 'fumadocs-ui/components/api' +import { APIInfo, Property } from 'fumadocs-ui/components/api' import { Badge } from '@/components/ui/badge'; import { Tabs, Tab } from 'fumadocs-ui/components/tabs' import { Tabs as UITabs, TabsContent, TabsList, TabsTrigger } from '@/components/ui/tabs'; @@ -18,14 +17,7 @@ import { InlineCode } from '@/components/inline-code'; -
- -

-
- GET -
-

{`/v2/prices/names/{name}`}

-

+ Retrieves the price of a name. The `amount` given will be in the smallest possible units of the currency. @@ -43,7 +35,7 @@ The name to query price information for | :----------- | :----------- | | `200` | Success | -
+ diff --git a/content/docs/stacks/api/names/name-subdomains.mdx b/content/docs/stacks/api/names/name-subdomains.mdx index 1fbebd0ea..2325c5a36 100644 --- a/content/docs/stacks/api/names/name-subdomains.mdx +++ b/content/docs/stacks/api/names/name-subdomains.mdx @@ -5,8 +5,7 @@ toc: false --- import { Root, API, APIExample } from '@/components/layout'; -import { APIInfo } from "fumadocs-ui/components/api" -import { Property } from 'fumadocs-ui/components/api' +import { APIInfo, Property } from 'fumadocs-ui/components/api' import { Badge } from '@/components/ui/badge'; import { Tabs, Tab } from 'fumadocs-ui/components/tabs' import { Tabs as UITabs, TabsContent, TabsList, TabsTrigger } from '@/components/ui/tabs'; @@ -18,14 +17,7 @@ import { InlineCode } from '@/components/inline-code'; -
- -

-
- GET -
-

{`/v1/names/{name}/subdomains`}

-

+ Retrieves the list of subdomains for a specific name @@ -43,7 +35,7 @@ Fully-qualified name | :----------- | :----------- | | `200` | Success | -
+ diff --git a/content/docs/stacks/api/names/name-zonefile.mdx b/content/docs/stacks/api/names/name-zonefile.mdx index 29763e60f..c222eb008 100644 --- a/content/docs/stacks/api/names/name-zonefile.mdx +++ b/content/docs/stacks/api/names/name-zonefile.mdx @@ -5,8 +5,7 @@ toc: false --- import { Root, API, APIExample } from '@/components/layout'; -import { APIInfo } from "fumadocs-ui/components/api" -import { Property } from 'fumadocs-ui/components/api' +import { APIInfo, Property } from 'fumadocs-ui/components/api' import { Badge } from '@/components/ui/badge'; import { Tabs, Tab } from 'fumadocs-ui/components/tabs' import { Tabs as UITabs, TabsContent, TabsList, TabsTrigger } from '@/components/ui/tabs'; @@ -18,14 +17,7 @@ import { InlineCode } from '@/components/inline-code'; -
- -

-
- GET -
-

{`/v1/names/{name}/zonefile`}

-

+ Retrieves a user’s raw zone file. This only works for RFC-compliant zone files. This method returns an error for names that have non-standard zone files. @@ -45,7 +37,7 @@ Fully-qualified name | `400` | Error | | `404` | Error | -
+ diff --git a/content/docs/stacks/api/names/names.mdx b/content/docs/stacks/api/names/names.mdx index 82b05df5c..0e0ce8eb5 100644 --- a/content/docs/stacks/api/names/names.mdx +++ b/content/docs/stacks/api/names/names.mdx @@ -5,8 +5,7 @@ toc: false --- import { Root, API, APIExample } from '@/components/layout'; -import { APIInfo } from "fumadocs-ui/components/api" -import { Property } from 'fumadocs-ui/components/api' +import { APIInfo, Property } from 'fumadocs-ui/components/api' import { Badge } from '@/components/ui/badge'; import { Tabs, Tab } from 'fumadocs-ui/components/tabs' import { Tabs as UITabs, TabsContent, TabsList, TabsTrigger } from '@/components/ui/tabs'; @@ -18,14 +17,7 @@ import { InlineCode } from '@/components/inline-code'; -
- -

-
- GET -
-

{`/v1/names`}

-

+ Retrieves a list of all names known to the node. @@ -44,7 +36,7 @@ Names are defaulted to page 1 with 100 results. You can query specific page resu | `200` | Success | | `400` | Error | -
+ diff --git a/content/docs/stacks/api/names/namespace-names.mdx b/content/docs/stacks/api/names/namespace-names.mdx index 5829485fe..573f2d582 100644 --- a/content/docs/stacks/api/names/namespace-names.mdx +++ b/content/docs/stacks/api/names/namespace-names.mdx @@ -5,8 +5,7 @@ toc: false --- import { Root, API, APIExample } from '@/components/layout'; -import { APIInfo } from "fumadocs-ui/components/api" -import { Property } from 'fumadocs-ui/components/api' +import { APIInfo, Property } from 'fumadocs-ui/components/api' import { Badge } from '@/components/ui/badge'; import { Tabs, Tab } from 'fumadocs-ui/components/tabs' import { Tabs as UITabs, TabsContent, TabsList, TabsTrigger } from '@/components/ui/tabs'; @@ -18,14 +17,7 @@ import { InlineCode } from '@/components/inline-code'; -
- -

-
- GET -
-

{`/v1/namespaces/{tld}/names`}

-

+ Retrieves a list of names within a given namespace. @@ -55,7 +47,7 @@ Namespace values are defaulted to page 1 with 100 results. You can query specifi | `400` | Error | | `404` | Error | -
+ diff --git a/content/docs/stacks/api/names/namespace-price.mdx b/content/docs/stacks/api/names/namespace-price.mdx index 78aee7d49..db55087ce 100644 --- a/content/docs/stacks/api/names/namespace-price.mdx +++ b/content/docs/stacks/api/names/namespace-price.mdx @@ -5,8 +5,7 @@ toc: false --- import { Root, API, APIExample } from '@/components/layout'; -import { APIInfo } from "fumadocs-ui/components/api" -import { Property } from 'fumadocs-ui/components/api' +import { APIInfo, Property } from 'fumadocs-ui/components/api' import { Badge } from '@/components/ui/badge'; import { Tabs, Tab } from 'fumadocs-ui/components/tabs' import { Tabs as UITabs, TabsContent, TabsList, TabsTrigger } from '@/components/ui/tabs'; @@ -18,14 +17,7 @@ import { InlineCode } from '@/components/inline-code'; -
- -

-
- GET -
-

{`/v2/prices/namespaces/{tld}`}

-

+ Retrieves the price of a namespace. The `amount` given will be in the smallest possible units of the currency. @@ -43,7 +35,7 @@ The namespace to fetch price for | :----------- | :----------- | | `200` | Success | -
+ diff --git a/content/docs/stacks/api/names/namespaces.mdx b/content/docs/stacks/api/names/namespaces.mdx index b97ba87bf..e8dc575d1 100644 --- a/content/docs/stacks/api/names/namespaces.mdx +++ b/content/docs/stacks/api/names/namespaces.mdx @@ -5,8 +5,7 @@ toc: false --- import { Root, API, APIExample } from '@/components/layout'; -import { APIInfo } from "fumadocs-ui/components/api" -import { Property } from 'fumadocs-ui/components/api' +import { APIInfo, Property } from 'fumadocs-ui/components/api' import { Badge } from '@/components/ui/badge'; import { Tabs, Tab } from 'fumadocs-ui/components/tabs' import { Tabs as UITabs, TabsContent, TabsList, TabsTrigger } from '@/components/ui/tabs'; @@ -18,22 +17,15 @@ import { InlineCode } from '@/components/inline-code'; -
- -

-
- GET -
-

{`/v1/namespaces`}

-

+ Retrieves a list of all namespaces known to the node. | Status code | Description | -| ----------- | ----------- | +| :----------- | :----------- | | `200` | Success | -
+ diff --git a/content/docs/stacks/api/names/owned-by-address.mdx b/content/docs/stacks/api/names/owned-by-address.mdx index 2fe6a3c00..f3076c4b6 100644 --- a/content/docs/stacks/api/names/owned-by-address.mdx +++ b/content/docs/stacks/api/names/owned-by-address.mdx @@ -5,8 +5,7 @@ toc: false --- import { Root, API, APIExample } from '@/components/layout'; -import { APIInfo } from "fumadocs-ui/components/api" -import { Property } from 'fumadocs-ui/components/api' +import { APIInfo, Property } from 'fumadocs-ui/components/api' import { Badge } from '@/components/ui/badge'; import { Tabs, Tab } from 'fumadocs-ui/components/tabs' import { Tabs as UITabs, TabsContent, TabsList, TabsTrigger } from '@/components/ui/tabs'; @@ -18,14 +17,7 @@ import { InlineCode } from '@/components/inline-code'; -
- -

-
- GET -
-

{`/v1/addresses/{blockchain}/{address}`}

-

+ Retrieves a list of names owned by the address provided. @@ -52,7 +44,7 @@ The address to lookup | `200` | Success | | `404` | Error | -
+ diff --git a/content/docs/stacks/api/non-fungible-tokens/history.mdx b/content/docs/stacks/api/non-fungible-tokens/history.mdx index 97115b546..20dcdb1c9 100644 --- a/content/docs/stacks/api/non-fungible-tokens/history.mdx +++ b/content/docs/stacks/api/non-fungible-tokens/history.mdx @@ -5,8 +5,7 @@ toc: false --- import { Root, API, APIExample } from '@/components/layout'; -import { APIInfo } from "fumadocs-ui/components/api" -import { Property } from 'fumadocs-ui/components/api' +import { APIInfo, Property } from 'fumadocs-ui/components/api' import { Badge } from '@/components/ui/badge'; import { Tabs, Tab } from 'fumadocs-ui/components/tabs' import { Tabs as UITabs, TabsContent, TabsList, TabsTrigger } from '@/components/ui/tabs'; @@ -18,14 +17,7 @@ import { InlineCode } from '@/components/inline-code'; -
- -

-
- GET -
-

{`/extended/v1/tokens/nft/history`}

-

+ Retrieves all events relevant to a non-fungible token. This is useful when determining the ownership history of a particular asset. @@ -89,7 +81,7 @@ Whether or not to include the complete transaction metadata instead of just `tx_ | :----------- | :----------- | | `200` | Non-fungible token event history | -
+ diff --git a/content/docs/stacks/api/non-fungible-tokens/holdings.mdx b/content/docs/stacks/api/non-fungible-tokens/holdings.mdx index bac07a104..8ea374e68 100644 --- a/content/docs/stacks/api/non-fungible-tokens/holdings.mdx +++ b/content/docs/stacks/api/non-fungible-tokens/holdings.mdx @@ -5,8 +5,7 @@ toc: false --- import { Root, API, APIExample } from '@/components/layout'; -import { APIInfo } from "fumadocs-ui/components/api" -import { Property } from 'fumadocs-ui/components/api' +import { APIInfo, Property } from 'fumadocs-ui/components/api' import { Badge } from '@/components/ui/badge'; import { Tabs, Tab } from 'fumadocs-ui/components/tabs' import { Tabs as UITabs, TabsContent, TabsList, TabsTrigger } from '@/components/ui/tabs'; @@ -18,14 +17,7 @@ import { InlineCode } from '@/components/inline-code'; -
- -

-
- GET -
-

{`/extended/v1/tokens/nft/holdings`}

-

+ Retrieves a list of non-fungible tokens owned by the given principal (STX address or smart contract ID). Results can be filtered by one or more asset identifiers and can include metadata about the transaction that made the principal own each token. @@ -90,7 +82,7 @@ Whether or not to include the complete transaction metadata instead of just `tx_ | :----------- | :----------- | | `200` | List of non-fungible token holdings | -
+ diff --git a/content/docs/stacks/api/non-fungible-tokens/mints.mdx b/content/docs/stacks/api/non-fungible-tokens/mints.mdx index e6b948705..9456ef74e 100644 --- a/content/docs/stacks/api/non-fungible-tokens/mints.mdx +++ b/content/docs/stacks/api/non-fungible-tokens/mints.mdx @@ -5,8 +5,7 @@ toc: false --- import { Root, API, APIExample } from '@/components/layout'; -import { APIInfo } from "fumadocs-ui/components/api" -import { Property } from 'fumadocs-ui/components/api' +import { APIInfo, Property } from 'fumadocs-ui/components/api' import { Badge } from '@/components/ui/badge'; import { Tabs, Tab } from 'fumadocs-ui/components/tabs' import { Tabs as UITabs, TabsContent, TabsList, TabsTrigger } from '@/components/ui/tabs'; @@ -18,14 +17,7 @@ import { InlineCode } from '@/components/inline-code'; -
- -

-
- GET -
-

{`/extended/v1/tokens/nft/mints`}

-

+ Retrieves all mint events for a non-fungible token asset class. This is useful to determine which NFTs of a particular collection have been claimed. @@ -81,7 +73,7 @@ Whether or not to include the complete transaction metadata instead of just `tx_ | :----------- | :----------- | | `200` | Non-Fungible Token mints | -
+ diff --git a/content/docs/stacks/api/proof-of-transfer/cycle.mdx b/content/docs/stacks/api/proof-of-transfer/cycle.mdx index 85dc01c9f..b994ff946 100644 --- a/content/docs/stacks/api/proof-of-transfer/cycle.mdx +++ b/content/docs/stacks/api/proof-of-transfer/cycle.mdx @@ -5,8 +5,7 @@ toc: false --- import { Root, API, APIExample } from '@/components/layout'; -import { APIInfo } from "fumadocs-ui/components/api" -import { Property } from 'fumadocs-ui/components/api' +import { APIInfo, Property } from 'fumadocs-ui/components/api' import { Badge } from '@/components/ui/badge'; import { Tabs, Tab } from 'fumadocs-ui/components/tabs' import { Tabs as UITabs, TabsContent, TabsList, TabsTrigger } from '@/components/ui/tabs'; @@ -18,14 +17,7 @@ import { InlineCode } from '@/components/inline-code'; -
- -

-
- GET -
-

{`/extended/v2/pox/cycles/{cycle_number}`}

-

+ Retrieves details for a PoX cycle. @@ -43,7 +35,7 @@ PoX cycle number | :--------- | :---------- | | `200` | Details for cycle | -
+ diff --git a/content/docs/stacks/api/proof-of-transfer/cycles.mdx b/content/docs/stacks/api/proof-of-transfer/cycles.mdx index af5a03ab2..780b12d7e 100644 --- a/content/docs/stacks/api/proof-of-transfer/cycles.mdx +++ b/content/docs/stacks/api/proof-of-transfer/cycles.mdx @@ -5,8 +5,7 @@ toc: false --- import { Root, API, APIExample } from '@/components/layout'; -import { APIInfo } from "fumadocs-ui/components/api" -import { Property } from 'fumadocs-ui/components/api' +import { APIInfo, Property } from 'fumadocs-ui/components/api' import { Badge } from '@/components/ui/badge'; import { Tabs, Tab } from 'fumadocs-ui/components/tabs' import { Tabs as UITabs, TabsContent, TabsList, TabsTrigger } from '@/components/ui/tabs'; @@ -18,14 +17,7 @@ import { InlineCode } from '@/components/inline-code'; -
- -

-
- GET -
-

{`/extended/v2/pox/cycles`}

-

+ Retrieves a list of PoX cycles. @@ -53,7 +45,7 @@ index of first cycle to fetch | :--------- | :---------- | | `200` | List of cycles | -
+ diff --git a/content/docs/stacks/api/proof-of-transfer/signer-in-cycle.mdx b/content/docs/stacks/api/proof-of-transfer/signer-in-cycle.mdx index e141a3769..8b2ae0e39 100644 --- a/content/docs/stacks/api/proof-of-transfer/signer-in-cycle.mdx +++ b/content/docs/stacks/api/proof-of-transfer/signer-in-cycle.mdx @@ -5,8 +5,7 @@ toc: false --- import { Root, API, APIExample } from '@/components/layout'; -import { APIInfo } from "fumadocs-ui/components/api" -import { Property } from 'fumadocs-ui/components/api' +import { APIInfo, Property } from 'fumadocs-ui/components/api' import { Badge } from '@/components/ui/badge'; import { Tabs, Tab } from 'fumadocs-ui/components/tabs' import { Tabs as UITabs, TabsContent, TabsList, TabsTrigger } from '@/components/ui/tabs'; @@ -18,14 +17,7 @@ import { InlineCode } from '@/components/inline-code'; -
- -

-
- GET -
-

{`/extended/v2/pox/cycles/{cycle_number}/signers/{signer_key}`}

-

+ Retrieves details for a signer in a PoX cycle. @@ -51,7 +43,7 @@ Signer key | :--------- | :---------- | | `200` | Details for PoX signer | -
+ diff --git a/content/docs/stacks/api/proof-of-transfer/signers-in-cycle.mdx b/content/docs/stacks/api/proof-of-transfer/signers-in-cycle.mdx index a3a2e4a20..34c11c1de 100644 --- a/content/docs/stacks/api/proof-of-transfer/signers-in-cycle.mdx +++ b/content/docs/stacks/api/proof-of-transfer/signers-in-cycle.mdx @@ -5,8 +5,7 @@ toc: false --- import { Root, API, APIExample } from '@/components/layout'; -import { APIInfo } from "fumadocs-ui/components/api" -import { Property } from 'fumadocs-ui/components/api' +import { APIInfo, Property } from 'fumadocs-ui/components/api' import { Badge } from '@/components/ui/badge'; import { Tabs, Tab } from 'fumadocs-ui/components/tabs' import { Tabs as UITabs, TabsContent, TabsList, TabsTrigger } from '@/components/ui/tabs'; @@ -18,14 +17,7 @@ import { InlineCode } from '@/components/inline-code'; -
- -

-
- GET -
-

{`/extended/v2/pox/cycles/{cycle_number}/signers`}

-

+ Retrieves a list of signers in a PoX cycle. @@ -43,7 +35,7 @@ PoX cycle number | :--------- | :---------- | | `200` | List of signers for cycle | -
+ diff --git a/content/docs/stacks/api/proof-of-transfer/stackers-for-signer-in-cycle.mdx b/content/docs/stacks/api/proof-of-transfer/stackers-for-signer-in-cycle.mdx index a2cb6a9e9..408413bb7 100644 --- a/content/docs/stacks/api/proof-of-transfer/stackers-for-signer-in-cycle.mdx +++ b/content/docs/stacks/api/proof-of-transfer/stackers-for-signer-in-cycle.mdx @@ -5,8 +5,7 @@ toc: false --- import { Root, API, APIExample } from '@/components/layout'; -import { APIInfo } from "fumadocs-ui/components/api" -import { Property } from 'fumadocs-ui/components/api' +import { APIInfo, Property } from 'fumadocs-ui/components/api' import { Badge } from '@/components/ui/badge'; import { Tabs, Tab } from 'fumadocs-ui/components/tabs' import { Tabs as UITabs, TabsContent, TabsList, TabsTrigger } from '@/components/ui/tabs'; @@ -18,14 +17,7 @@ import { InlineCode } from '@/components/inline-code'; -
- -

-
- GET -
-

{`/extended/v2/pox/cycles/{cycle_number}/signers/{signer_key}/stackers`}

-

+ Retrieves a list of stackers for a signer in a PoX cycle. @@ -51,7 +43,7 @@ Signer key | :--------- | :---------- | | `200` | List of stackers | -
+ diff --git a/content/docs/stacks/api/search/search-by-id.mdx b/content/docs/stacks/api/search/search-by-id.mdx index 1bfb75e11..30ccfddf3 100644 --- a/content/docs/stacks/api/search/search-by-id.mdx +++ b/content/docs/stacks/api/search/search-by-id.mdx @@ -13,14 +13,7 @@ import { Accordion, Accordions } from 'fumadocs-ui/components/accordion'; -
- -

-
- GET -
-

{`/extended/v2/info`}

-

+ Search blocks, transactions, contracts, or accounts by hash/ID. @@ -43,11 +36,11 @@ This includes the detailed data for purticular hash in the response | Status code | Description | -| ----------- | ----------- | +| :----------- | :----------- | | `200` | Success | | `404` | Not found | -
+ diff --git a/content/docs/stacks/api/smart-contracts/by-trait.mdx b/content/docs/stacks/api/smart-contracts/by-trait.mdx index 543e88fe9..630f47c5c 100644 --- a/content/docs/stacks/api/smart-contracts/by-trait.mdx +++ b/content/docs/stacks/api/smart-contracts/by-trait.mdx @@ -5,8 +5,7 @@ toc: false --- import { Root, API, APIExample } from '@/components/layout'; -import { APIInfo } from "fumadocs-ui/components/api" -import { Property } from 'fumadocs-ui/components/api' +import { APIInfo, Property } from "fumadocs-ui/components/api" import { Badge } from '@/components/ui/badge'; import { Tabs, Tab } from 'fumadocs-ui/components/tabs' import { Tabs as UITabs, TabsContent, TabsList, TabsTrigger } from '@/components/ui/tabs'; @@ -18,14 +17,7 @@ import { InlineCode } from '@/components/inline-code'; -
- -

-
- GET -
-

{`/extended/v1/contract/by_trait`}

-

+ Retrieves a list of contracts based on the following traits listed in JSON format - functions, variables, maps, fungible tokens and non-fungible tokens. @@ -53,7 +45,7 @@ Index of first contract event to fetch | :----------- | :----------- | | `200` | List of contracts implement given trait | -
+ diff --git a/content/docs/stacks/api/smart-contracts/events.mdx b/content/docs/stacks/api/smart-contracts/events.mdx index be0edc84b..022376bf1 100644 --- a/content/docs/stacks/api/smart-contracts/events.mdx +++ b/content/docs/stacks/api/smart-contracts/events.mdx @@ -5,8 +5,7 @@ toc: false --- import { Root, API, APIExample } from '@/components/layout'; -import { APIInfo } from "fumadocs-ui/components/api" -import { Property } from 'fumadocs-ui/components/api' +import { APIInfo, Property } from "fumadocs-ui/components/api" import { Badge } from '@/components/ui/badge'; import { Tabs, Tab } from 'fumadocs-ui/components/tabs' import { Tabs as UITabs, TabsContent, TabsList, TabsTrigger } from '@/components/ui/tabs'; @@ -18,14 +17,7 @@ import { InlineCode } from '@/components/inline-code'; -
- -

-
- GET -
-

{`/extended/v1/contract/{contract_id}/events`}

-

+ Retrieves a list of events that have been triggered by a given `contract_id`. @@ -69,7 +61,7 @@ Include transaction data from unanchored (i.e. unconfirmed) microblocks | :----------- | :----------- | | `200` | List of events | -
+ diff --git a/content/docs/stacks/api/smart-contracts/info.mdx b/content/docs/stacks/api/smart-contracts/info.mdx index f483ebb1c..21e402b93 100644 --- a/content/docs/stacks/api/smart-contracts/info.mdx +++ b/content/docs/stacks/api/smart-contracts/info.mdx @@ -5,8 +5,7 @@ toc: false --- import { Root, API, APIExample } from '@/components/layout'; -import { APIInfo } from "fumadocs-ui/components/api" -import { Property } from 'fumadocs-ui/components/api' +import { APIInfo, Property } from "fumadocs-ui/components/api" import { Badge } from '@/components/ui/badge'; import { Tabs, Tab } from 'fumadocs-ui/components/tabs' import { Tabs as UITabs, TabsContent, TabsList, TabsTrigger } from '@/components/ui/tabs'; @@ -18,14 +17,7 @@ import { InlineCode } from '@/components/inline-code'; -
- -

-
- GET -
-

{`/extended/v1/contract/{contract_id}`}

-

+ Retrieves details of a contract with a given `contract_id`. @@ -34,7 +26,7 @@ Retrieves details of a contract with a given `contract_id`. | `200` | Contract found | | `404` | Cannot find contract of given ID | -
+ diff --git a/content/docs/stacks/api/smart-contracts/interface.mdx b/content/docs/stacks/api/smart-contracts/interface.mdx index 76f3d614d..7499343f2 100644 --- a/content/docs/stacks/api/smart-contracts/interface.mdx +++ b/content/docs/stacks/api/smart-contracts/interface.mdx @@ -5,8 +5,7 @@ toc: false --- import { Root, API, APIExample } from '@/components/layout'; -import { APIInfo } from "fumadocs-ui/components/api" -import { Property } from 'fumadocs-ui/components/api' +import { APIInfo, Property } from "fumadocs-ui/components/api" import { Badge } from '@/components/ui/badge'; import { Tabs, Tab } from 'fumadocs-ui/components/tabs' import { Tabs as UITabs, TabsContent, TabsList, TabsTrigger } from '@/components/ui/tabs'; @@ -18,14 +17,7 @@ import { InlineCode } from '@/components/inline-code'; -
- -

-
- GET -
-

{`/v2/contracts/interface/{contract_address}/{contract_name}`}

-

+ Retrieves a contract interface with a given `contract_address` and `contract name`. @@ -33,7 +25,7 @@ Retrieves a contract interface with a given `contract_address` and `contract nam | :----------- | :----------- | | `200` | Contract interface | -
+ diff --git a/content/docs/stacks/api/smart-contracts/map-entry.mdx b/content/docs/stacks/api/smart-contracts/map-entry.mdx index 1fde87afa..2cc3c7ac5 100644 --- a/content/docs/stacks/api/smart-contracts/map-entry.mdx +++ b/content/docs/stacks/api/smart-contracts/map-entry.mdx @@ -5,8 +5,7 @@ toc: false --- import { Root, API, APIExample } from '@/components/layout'; -import { APIInfo } from "fumadocs-ui/components/api" -import { Property } from 'fumadocs-ui/components/api' +import { APIInfo, Property } from 'fumadocs-ui/components/api' import { Badge } from '@/components/ui/badge'; import { Tabs, Tab } from 'fumadocs-ui/components/tabs' import { Tabs as UITabs, TabsContent, TabsList, TabsTrigger } from '@/components/ui/tabs'; @@ -18,14 +17,7 @@ import { InlineCode } from '@/components/inline-code'; -
- -

-
- POST -
-

{`/v2/map_entry/{contract_address}/{contract_name}/{map_name}`}

-

+ Attempt to fetch data from a contract data map. The contract is identified with a Stacks address `contract_address` and contract name `contract_address` in the URL path. The map is identified with [Map Name]. @@ -33,7 +25,6 @@ The key to look up in the map is supplied via the POST body. This should be supp In the response, `data` is the hex serialization of the map response. Note: map responses are Clarity option types. For non-existent values, this is a serialized none, and for all other responses, it is a serialized (some ...) object. - ### Request body Hex string serialization of the lookup key (which should be a Clarity value) @@ -88,7 +79,7 @@ The Stacks chain tip to query from | `200` | Success | | `400` | Failed loading data map | -
+ diff --git a/content/docs/stacks/api/smart-contracts/read-only.mdx b/content/docs/stacks/api/smart-contracts/read-only.mdx index c501c5944..a650adaa1 100644 --- a/content/docs/stacks/api/smart-contracts/read-only.mdx +++ b/content/docs/stacks/api/smart-contracts/read-only.mdx @@ -5,8 +5,7 @@ toc: false --- import { Root, API, APIExample } from '@/components/layout'; -import { APIInfo } from "fumadocs-ui/components/api" -import { Property } from 'fumadocs-ui/components/api' +import { APIInfo, Property } from 'fumadocs-ui/components/api' import { Badge } from '@/components/ui/badge'; import { Tabs, Tab } from 'fumadocs-ui/components/tabs' import { Tabs as UITabs, TabsContent, TabsList, TabsTrigger } from '@/components/ui/tabs'; @@ -18,14 +17,7 @@ import { InlineCode } from '@/components/inline-code'; -
- -

-
- POST -
-

{`/v2/contracts/call-read/{contract_address}/{contract_name}/{function_name}`}

-

+ Call a read-only public function on a given smart contract. @@ -85,7 +77,7 @@ The Stacks chain tip to query from | :----------- | :----------- | | `200` | Success | -
+ diff --git a/content/docs/stacks/api/smart-contracts/source.mdx b/content/docs/stacks/api/smart-contracts/source.mdx index f11dfd0b5..bffc09493 100644 --- a/content/docs/stacks/api/smart-contracts/source.mdx +++ b/content/docs/stacks/api/smart-contracts/source.mdx @@ -5,8 +5,7 @@ toc: false --- import { Root, API, APIExample } from '@/components/layout'; -import { APIInfo } from "fumadocs-ui/components/api" -import { Property } from 'fumadocs-ui/components/api' +import { APIInfo, Property } from "fumadocs-ui/components/api" import { Badge } from '@/components/ui/badge'; import { Tabs, Tab } from 'fumadocs-ui/components/tabs' import { Tabs as UITabs, TabsContent, TabsList, TabsTrigger } from '@/components/ui/tabs'; @@ -18,14 +17,7 @@ import { InlineCode } from '@/components/inline-code'; -
- -

-
- GET -
-

{`/v2/contracts/source/{contract_address}/{contract_name}`}

-

+ Retrieves the Clarity source code of a given contract, along with the block height it was published in and the MARF proof for the data. @@ -33,7 +25,7 @@ Retrieves the Clarity source code of a given contract, along with the block heig | :----------- | :----------- | | `200` | Success | -
+ diff --git a/content/docs/stacks/api/smart-contracts/status.mdx b/content/docs/stacks/api/smart-contracts/status.mdx index 467795e65..1f07ae74b 100644 --- a/content/docs/stacks/api/smart-contracts/status.mdx +++ b/content/docs/stacks/api/smart-contracts/status.mdx @@ -5,8 +5,7 @@ toc: false --- import { Root, API, APIExample } from '@/components/layout'; -import { APIInfo } from "fumadocs-ui/components/api" -import { Property } from 'fumadocs-ui/components/api' +import { APIInfo, Property } from "fumadocs-ui/components/api" import { Badge } from '@/components/ui/badge'; import { Tabs, Tab } from 'fumadocs-ui/components/tabs' import { Tabs as UITabs, TabsContent, TabsList, TabsTrigger } from '@/components/ui/tabs'; @@ -18,18 +17,10 @@ import { InlineCode } from '@/components/inline-code'; -
- -

-
- GET -
-

{`/extended/v2/smart-contracts/status`}

-

+ Retrieves the deployment status of multiple smart contracts. - ### Query parameters @@ -44,7 +35,7 @@ Contract IDs to fetch status for | :----------- | :----------- | | `200` | List of smart contract status | -
+ diff --git a/content/docs/stacks/api/stacking-pool/members.mdx b/content/docs/stacks/api/stacking-pool/members.mdx index 1b2ea7115..af72baf5d 100644 --- a/content/docs/stacks/api/stacking-pool/members.mdx +++ b/content/docs/stacks/api/stacking-pool/members.mdx @@ -5,7 +5,7 @@ toc: false --- import { Root, API, APIExample } from '@/components/layout'; -import { Property } from 'fumadocs-ui/components/api' +import { APIInfo, Property } from "fumadocs-ui/components/api" import { Badge } from '@/components/ui/badge'; import { Tabs, Tab } from 'fumadocs-ui/components/tabs' import { Tabs as UITabs, TabsContent, TabsList, TabsTrigger } from '@/components/ui/tabs'; @@ -17,14 +17,7 @@ import { InlineCode } from '@/components/inline-code'; -
- -

-
- GET -
-

{`/extended/beta/stacking/{pool_principal}/delegations`}

-

+ Retrieves the list of stacking pool members for a given delegator principal. @@ -77,10 +70,10 @@ Number of items to skip | Status code | Description | -| ----------- | ----------- | +| :----------- | :----------- | | `200` | Success | -
+ diff --git a/content/docs/stacks/api/stacking-rewards/recent-burnchain-reward-recipient.mdx b/content/docs/stacks/api/stacking-rewards/recent-burnchain-reward-recipient.mdx index d1e6d7502..e8dd8f37f 100644 --- a/content/docs/stacks/api/stacking-rewards/recent-burnchain-reward-recipient.mdx +++ b/content/docs/stacks/api/stacking-rewards/recent-burnchain-reward-recipient.mdx @@ -5,8 +5,7 @@ toc: false --- import { Root, API, APIExample } from '@/components/layout'; -import { APIInfo } from "fumadocs-ui/components/api" -import { Property } from 'fumadocs-ui/components/api' +import { APIInfo, Property } from "fumadocs-ui/components/api" import { Badge } from '@/components/ui/badge'; import { Tabs, Tab } from 'fumadocs-ui/components/tabs' import { Tabs as UITabs, TabsContent, TabsList, TabsTrigger } from '@/components/ui/tabs'; @@ -18,14 +17,7 @@ import { InlineCode } from '@/components/inline-code'; -
- -

-
- GET -
-

{`/extended/v1/burnchain/rewards/{address}`}

-

+ Retrieves a list of recent burnchain (e.g. Bitcoin) rewards for the given recipient with the associated amounts and block info. @@ -59,7 +51,7 @@ Index of first rewards to fetch | :----------- | :----------- | | `200` | List of burnchain reward recipients and amounts | -
+ diff --git a/content/docs/stacks/api/stacking-rewards/recent-burnchain-reward-recipients.mdx b/content/docs/stacks/api/stacking-rewards/recent-burnchain-reward-recipients.mdx index 97eb2f9bf..37ce8e694 100644 --- a/content/docs/stacks/api/stacking-rewards/recent-burnchain-reward-recipients.mdx +++ b/content/docs/stacks/api/stacking-rewards/recent-burnchain-reward-recipients.mdx @@ -5,8 +5,7 @@ toc: false --- import { Root, API, APIExample } from '@/components/layout'; -import { APIInfo } from "fumadocs-ui/components/api" -import { Property } from 'fumadocs-ui/components/api' +import { APIInfo, Property } from "fumadocs-ui/components/api" import { Badge } from '@/components/ui/badge'; import { Tabs, Tab } from 'fumadocs-ui/components/tabs' import { Tabs as UITabs, TabsContent, TabsList, TabsTrigger } from '@/components/ui/tabs'; @@ -18,14 +17,7 @@ import { InlineCode } from '@/components/inline-code'; -
- -

-
- GET -
-

{`/extended/v1/burnchain/rewards`}

-

+ Retrieves a list of recent burnchain (e.g. Bitcoin) reward recipients with the associated amounts and block info. @@ -53,7 +45,7 @@ Index of first rewards to fetch | :----------- | :----------- | | `200` | List of burnchain reward recipients and amounts | -
+ diff --git a/content/docs/stacks/api/stacking-rewards/recent-reward-slot-holder-entries.mdx b/content/docs/stacks/api/stacking-rewards/recent-reward-slot-holder-entries.mdx index 84a335420..efc49e85f 100644 --- a/content/docs/stacks/api/stacking-rewards/recent-reward-slot-holder-entries.mdx +++ b/content/docs/stacks/api/stacking-rewards/recent-reward-slot-holder-entries.mdx @@ -5,8 +5,7 @@ toc: false --- import { Root, API, APIExample } from '@/components/layout'; -import { APIInfo } from "fumadocs-ui/components/api" -import { Property } from 'fumadocs-ui/components/api' +import { APIInfo, Property } from "fumadocs-ui/components/api" import { Badge } from '@/components/ui/badge'; import { Tabs, Tab } from 'fumadocs-ui/components/tabs' import { Tabs as UITabs, TabsContent, TabsList, TabsTrigger } from '@/components/ui/tabs'; @@ -18,14 +17,7 @@ import { InlineCode } from '@/components/inline-code'; -
- -

-
- GET -
-

{`/extended/v1/burnchain/reward_slot_holders/{address}`}

-

+ Retrieves a list of the Bitcoin addresses that would validly receive Proof-of-Transfer commitments for a given reward slot holder recipient address. @@ -59,7 +51,7 @@ Index of the first items to fetch | :----------- | :----------- | | `200` | List of burnchain reward recipients and amounts | -
+ diff --git a/content/docs/stacks/api/stacking-rewards/recent-reward-slot-holders.mdx b/content/docs/stacks/api/stacking-rewards/recent-reward-slot-holders.mdx index e2db6fceb..0370826a9 100644 --- a/content/docs/stacks/api/stacking-rewards/recent-reward-slot-holders.mdx +++ b/content/docs/stacks/api/stacking-rewards/recent-reward-slot-holders.mdx @@ -5,8 +5,7 @@ toc: false --- import { Root, API, APIExample } from '@/components/layout'; -import { APIInfo } from "fumadocs-ui/components/api" -import { Property } from 'fumadocs-ui/components/api' +import { APIInfo, Property } from "fumadocs-ui/components/api" import { Badge } from '@/components/ui/badge'; import { Tabs, Tab } from 'fumadocs-ui/components/tabs' import { Tabs as UITabs, TabsContent, TabsList, TabsTrigger } from '@/components/ui/tabs'; @@ -18,14 +17,7 @@ import { InlineCode } from '@/components/inline-code'; -
- -

-
- GET -
-

{`/extended/v1/burnchain/reward_slot_holders`}

-

+ Retrieves a list of the Bitcoin addresses that would validly receive Proof-of-Transfer commitments. @@ -53,7 +45,7 @@ Index of the first items to fetch | :----------- | :----------- | | `200` | List of burnchain reward recipients and amounts | -
+ diff --git a/content/docs/stacks/api/stacking-rewards/total-burnchain-rewards-for-recipient.mdx b/content/docs/stacks/api/stacking-rewards/total-burnchain-rewards-for-recipient.mdx index a1564ad53..10b01ff50 100644 --- a/content/docs/stacks/api/stacking-rewards/total-burnchain-rewards-for-recipient.mdx +++ b/content/docs/stacks/api/stacking-rewards/total-burnchain-rewards-for-recipient.mdx @@ -5,8 +5,7 @@ toc: false --- import { Root, API, APIExample } from '@/components/layout'; -import { APIInfo } from "fumadocs-ui/components/api" -import { Property } from 'fumadocs-ui/components/api' +import { APIInfo, Property } from "fumadocs-ui/components/api" import { Badge } from '@/components/ui/badge'; import { Tabs, Tab } from 'fumadocs-ui/components/tabs' import { Tabs as UITabs, TabsContent, TabsList, TabsTrigger } from '@/components/ui/tabs'; @@ -18,14 +17,7 @@ import { InlineCode } from '@/components/inline-code'; -
- -

-
- GET -
-

{`/extended/v1/burnchain/rewards/{address}/total`}

-

+ Retrieves the total burnchain (e.g. Bitcoin) rewards for a given recipient `address`. @@ -43,7 +35,7 @@ Reward recipient address. Should either be in the native burnchain's format (e.g | :----------- | :----------- | | `200` | List of burnchain reward recipients and amounts | -
+ diff --git a/content/docs/stacks/api/transactions/broadcast-transaction.mdx b/content/docs/stacks/api/transactions/broadcast-transaction.mdx index b68aeacef..ceb5b0063 100644 --- a/content/docs/stacks/api/transactions/broadcast-transaction.mdx +++ b/content/docs/stacks/api/transactions/broadcast-transaction.mdx @@ -5,8 +5,7 @@ toc: false --- import { Root, API, APIExample } from '@/components/layout'; -import { APIInfo } from "fumadocs-ui/components/api" -import { Property } from 'fumadocs-ui/components/api' +import { APIInfo, Property } from 'fumadocs-ui/components/api' import { Badge } from '@/components/ui/badge'; import { Tabs, Tab } from 'fumadocs-ui/components/tabs' import { Tabs as UITabs, TabsContent, TabsList, TabsTrigger } from '@/components/ui/tabs'; @@ -18,14 +17,7 @@ import { InlineCode } from '@/components/inline-code'; -
- -

-
- POST -
-

{`/v2/transactions`}

-

+ Broadcasts raw transactions on the network. You can use the [@stacks/transactions](/stacks/stacks.js/packages/transactions) project to generate a raw transaction payload. @@ -42,7 +34,7 @@ Broadcasts raw transactions on the network. You can use the [@stacks/transaction | `200` | Transaction id of successful post of a raw tx to the node's mempool | | `400` | Rejections result in a 400 error | -
+ diff --git a/content/docs/stacks/token-metadata-api/info/status.mdx b/content/docs/stacks/token-metadata-api/info/status.mdx index cc2aa74eb..be8a37417 100644 --- a/content/docs/stacks/token-metadata-api/info/status.mdx +++ b/content/docs/stacks/token-metadata-api/info/status.mdx @@ -5,7 +5,7 @@ toc: false --- import { Root, API, APIExample } from '@/components/layout'; -import { Property } from 'fumadocs-ui/components/api' +import { APIInfo, Property } from "fumadocs-ui/components/api" import { Tabs, Tab } from 'fumadocs-ui/components/tabs' import { Accordion, Accordions } from 'fumadocs-ui/components/accordion'; @@ -13,14 +13,7 @@ import { Accordion, Accordions } from 'fumadocs-ui/components/accordion'; -
- -

-
- GET -
-

{`/metadata/v1/`}

-

+ Retrieves information about the Token Metadata API, including the server version. @@ -32,7 +25,7 @@ No parameters. | :---------- | :---------- | | `200` | Success | -
+ diff --git a/content/docs/stacks/token-metadata-api/tokens/fungible-token-metadata.mdx b/content/docs/stacks/token-metadata-api/tokens/fungible-token-metadata.mdx index 251c32e0b..f2e4fb423 100644 --- a/content/docs/stacks/token-metadata-api/tokens/fungible-token-metadata.mdx +++ b/content/docs/stacks/token-metadata-api/tokens/fungible-token-metadata.mdx @@ -5,7 +5,7 @@ toc: false --- import { Root, API, APIExample } from '@/components/layout'; -import { Property } from 'fumadocs-ui/components/api' +import { APIInfo, Property } from "fumadocs-ui/components/api" import { Tabs, Tab } from 'fumadocs-ui/components/tabs' import { Accordion, Accordions } from 'fumadocs-ui/components/accordion'; @@ -13,14 +13,7 @@ import { Accordion, Accordions } from 'fumadocs-ui/components/accordion'; -
- -

-
- GET -
-

{`/metadata/v1/ft/{principal}`}

-

+ Retrieves metadata for a SIP-010 fungible token. @@ -45,12 +38,12 @@ Principal for the contract which owns the SIP-010 token | Status code | Description | -| ----------- | ----------- | +| :----------- | :----------- | | `200` | Default response | | `404` | Default response | | `422` | Default response | -
+ diff --git a/content/docs/stacks/token-metadata-api/tokens/fungible-tokens.mdx b/content/docs/stacks/token-metadata-api/tokens/fungible-tokens.mdx index e9d0df534..e93e1b55b 100644 --- a/content/docs/stacks/token-metadata-api/tokens/fungible-tokens.mdx +++ b/content/docs/stacks/token-metadata-api/tokens/fungible-tokens.mdx @@ -5,7 +5,7 @@ toc: false --- import { Root, API, APIExample } from '@/components/layout'; -import { Property } from 'fumadocs-ui/components/api' +import { APIInfo, Property } from "fumadocs-ui/components/api" import { Tabs, Tab } from 'fumadocs-ui/components/tabs' import { Accordion, Accordions } from 'fumadocs-ui/components/accordion'; @@ -13,14 +13,7 @@ import { Accordion, Accordions } from 'fumadocs-ui/components/accordion'; -
- -

-
- GET -
-

{`/metadata/v1/ft`}

-

+ Retrieves a list of fungible tokens. @@ -82,7 +75,7 @@ Results order | :---------- | :-------------- | | `200` | Default response| -
+ diff --git a/content/docs/stacks/token-metadata-api/tokens/non-fungible-token-metadata.mdx b/content/docs/stacks/token-metadata-api/tokens/non-fungible-token-metadata.mdx index cf605e31b..8bdfbe924 100644 --- a/content/docs/stacks/token-metadata-api/tokens/non-fungible-token-metadata.mdx +++ b/content/docs/stacks/token-metadata-api/tokens/non-fungible-token-metadata.mdx @@ -5,7 +5,7 @@ toc: false --- import { Root, API, APIExample } from '@/components/layout'; -import { Property } from 'fumadocs-ui/components/api' +import { APIInfo, Property } from "fumadocs-ui/components/api" import { Tabs, Tab } from 'fumadocs-ui/components/tabs' import { Accordion, Accordions } from 'fumadocs-ui/components/accordion'; @@ -13,14 +13,7 @@ import { Accordion, Accordions } from 'fumadocs-ui/components/accordion'; -
- -

-
- GET -
-

{`/metadata/v1/nft/{principal}/{token_id}`}

-

+ Retrieves metadata for a SIP-009 non-fungible token. @@ -53,12 +46,12 @@ Token ID to retrieve | Status code | Description | -| ----------- | ----------- | +| :----------- | :----------- | | `200` | Default response | | `404` | Default response | | `422` | Default response | -
+ diff --git a/content/docs/stacks/token-metadata-api/tokens/semi-fungible-token-metadata.mdx b/content/docs/stacks/token-metadata-api/tokens/semi-fungible-token-metadata.mdx index 38bef1ee8..5b667cfa3 100644 --- a/content/docs/stacks/token-metadata-api/tokens/semi-fungible-token-metadata.mdx +++ b/content/docs/stacks/token-metadata-api/tokens/semi-fungible-token-metadata.mdx @@ -5,7 +5,7 @@ toc: false --- import { Root, API, APIExample } from '@/components/layout'; -import { Property } from 'fumadocs-ui/components/api' +import { APIInfo, Property } from "fumadocs-ui/components/api" import { Tabs, Tab } from 'fumadocs-ui/components/tabs' import { Accordion, Accordions } from 'fumadocs-ui/components/accordion'; @@ -13,14 +13,7 @@ import { Accordion, Accordions } from 'fumadocs-ui/components/accordion'; -
- -

-
- GET -
-

{`/metadata/v1/sft/{principal}/{token_id}`}

-

+ Retrieves metadata for a SIP-013 semi-fungible token. @@ -53,12 +46,12 @@ Token ID to retrieve | Status code | Description | -| ----------- | ----------- | +| :----------- | :----------- | | `200` | Default response | | `404` | Default response | | `422` | Default response | -
+