-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
making structure more consistent and adding latest apidoc updates
- Loading branch information
juraj.bacovcin
committed
Apr 11, 2024
1 parent
fbf53ee
commit f2519f9
Showing
244 changed files
with
8,393 additions
and
52,834 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
58 changes: 58 additions & 0 deletions
58
categories/blockchain/paths/v3_base_account_balance_{address}_get.yml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,58 @@ | ||
| description: '<p><b>1 credit per API call</b></p> | ||
| <p>Get the balance of <b>BASE</b> of an Base account.</p> | ||
| <p>To get the balance of <b>tokens</b>, use the APIs for getting the balance of | ||
| <a href="https://apidoc.tatum.io/tag/Fungible-Tokens-(ERC-20-or-compatible)#operation/Erc20GetBalanceAddress" | ||
| target="_blank">fungible tokens (ERC-20)</a> and <a href="https://apidoc.tatum.io/tag/NFT-(ERC-721-or-compatible)#operation/NftGetTokensByAddressErc721" | ||
| target="_blank">NFTs (ERC-721)</a>.</p> | ||
| ' | ||
| operationId: BaseGetBalance | ||
| parameters: | ||
| - description: Account address you want to get balance of | ||
| in: path | ||
| name: address | ||
| required: true | ||
| schema: | ||
| type: string | ||
| example: "0x3223AEB8404C7525FcAA6C512f91e287AE9FfE7B" | ||
| responses: | ||
| "200": | ||
| content: | ||
| application/json: | ||
| schema: | ||
| $ref: "../../../components/migrated.yml#/components/schemas/BaseBalance" | ||
| description: OK | ||
| "400": | ||
| content: | ||
| application/json: | ||
| schema: | ||
| $ref: "../../../components/migrated.yml#/components/schemas/Error400" | ||
| description: | ||
| Bad Request. Validation failed for the given object in the HTTP Body | ||
| or Request parameters. | ||
| "401": | ||
| content: | ||
| application/json: | ||
| schema: | ||
| oneOf: | ||
| - $ref: "../../../components/migrated.yml#/components/schemas/Error401NotActive" | ||
| - $ref: "../../../components/migrated.yml#/components/schemas/Error401Invalid" | ||
| description: | ||
| Unauthorized. Not valid or inactive subscription key present in the | ||
| HTTP Header. | ||
| "500": | ||
| content: | ||
| application/json: | ||
| schema: | ||
| $ref: "../../../components/migrated.yml#/components/schemas/Error500" | ||
| description: | ||
| Internal server error. There was an error on the server during the | ||
| processing of the request. | ||
| security: | ||
| - X-API-Key: [] | ||
| x-codeSamples: [] | ||
| summary: Get the BASE balance of an Base account | ||
| tags: | ||
| - Base |
63 changes: 63 additions & 0 deletions
63
categories/blockchain/paths/v3_base_address_{xpub}_{index}_get.yml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,63 @@ | ||
| description: "<h4>1 credit per API call.</h4><br/> | ||
| <p>Generates an Base account deposit address from an Extended public key. The deposit | ||
| address is generated for the specific index - each extended public key can generate | ||
| up to 2^31 addresses starting from index 0 until 2^31 - 1.</p> | ||
| " | ||
| operationId: BaseGenerateAddress | ||
| parameters: | ||
| - description: Extended public key of wallet. | ||
| in: path | ||
| name: xpub | ||
| required: true | ||
| schema: | ||
| type: string | ||
| example: xpub6EsCk1uU6cJzqvP9CdsTiJwT2rF748YkPnhv5Qo8q44DG7nn2vbyt48YRsNSUYS44jFCW9gwvD9kLQu9AuqXpTpM1c5hgg9PsuBLdeNncid | ||
| - description: Derivation index of the address to be generated. | ||
| in: path | ||
| name: index | ||
| required: true | ||
| schema: | ||
| type: number | ||
| example: 0 | ||
| responses: | ||
| "200": | ||
| content: | ||
| application/json: | ||
| schema: | ||
| $ref: "../../../components/migrated.yml#/components/schemas/GeneratedAddressBase" | ||
| description: OK | ||
| "400": | ||
| content: | ||
| application/json: | ||
| schema: | ||
| $ref: "../../../components/migrated.yml#/components/schemas/Error400" | ||
| description: | ||
| Bad Request. Validation failed for the given object in the HTTP Body | ||
| or Request parameters. | ||
| "401": | ||
| content: | ||
| application/json: | ||
| schema: | ||
| oneOf: | ||
| - $ref: "../../../components/migrated.yml#/components/schemas/Error401NotActive" | ||
| - $ref: "../../../components/migrated.yml#/components/schemas/Error401Invalid" | ||
| description: | ||
| Unauthorized. Not valid or inactive subscription key present in the | ||
| HTTP Header. | ||
| "500": | ||
| content: | ||
| application/json: | ||
| schema: | ||
| $ref: "../../../components/migrated.yml#/components/schemas/Error500" | ||
| description: | ||
| Internal server error. There was an error on the server during the | ||
| processing of the request. | ||
| security: | ||
| - X-API-Key: [] | ||
| x-codeSamples: [] | ||
| summary: Generate Base account address from Extended public key | ||
| tags: | ||
| - Base |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| description: | ||
| <h4>1 credit per API call.</h4><br/><p>Gets the current Base block number. | ||
| This is the number of the latest block in the blockchain.</p> | ||
| operationId: BaseGetCurrentBlock | ||
| responses: | ||
| "200": | ||
| content: | ||
| application/json: | ||
| schema: | ||
| type: number | ||
| description: Current block number | ||
| example: 6491272 | ||
| description: OK | ||
| "401": | ||
| content: | ||
| application/json: | ||
| schema: | ||
| oneOf: | ||
| - $ref: "../../../components/migrated.yml#/components/schemas/Error401NotActive" | ||
| - $ref: "../../../components/migrated.yml#/components/schemas/Error401Invalid" | ||
| description: | ||
| Unauthorized. Not valid or inactive subscription key present in the | ||
| HTTP Header. | ||
| "500": | ||
| content: | ||
| application/json: | ||
| schema: | ||
| $ref: "../../../components/migrated.yml#/components/schemas/Error500" | ||
| description: | ||
| Internal server error. There was an error on the server during the | ||
| processing of the request. | ||
| security: | ||
| - X-API-Key: [] | ||
| x-codeSamples: [] | ||
| summary: Get current block number | ||
| tags: | ||
| - Base |
Oops, something went wrong.