Skip to content

Instantly share code, notes, and snippets.

@frol

frol/near-enhanced-api-spec-v3.json

Last active June 28, 2022 10:38
Show Gist options

  • Select an option

    Learn more about clone URLs
  • Save frol/644d611bdbd6740fdb8b84fb718e8bc6 to your computer and use it in GitHub Desktop.

Select an option

Learn more about clone URLs
Save frol/644d611bdbd6740fdb8b84fb718e8bc6 to your computer and use it in GitHub Desktop.
Download ZIP
Raw
near-enhanced-api-spec-v3.json
{
"openapi": "3.0.0",
"info": {
"title": "NEAR Enchanced API (by Pagoda Inc)",
"version": "0.1"
},
"servers": [{
"url": "https://near-enhanced-api-mainnet.fly.dev/"
}],
"paths": {
"/accounts/{account_id}/coins": {
"get": {
"summary": "Get the user's balance",
"description": "This endpoint returns the balance of the given account_id,\n for the specified token_contract_id | near.",
"parameters": [{
"in": "path",
"name": "account_id",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}, {
"in": "query",
"name": "block_height",
"schema": {
"type": "string"
},
"style": "form"
}, {
"in": "query",
"name": "block_timestamp_nanos",
"schema": {
"type": "string"
},
"style": "form"
}, {
"in": "query",
"name": "limit",
"schema": {
"type": "integer",
"format": "int32"
},
"style": "form"
}, {
"in": "query",
"name": "offset",
"schema": {
"type": "integer",
"format": "int32"
},
"style": "form"
}],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BalancesResponse"
}
}
}
},
"500": {
"description": "See the inner `code` value to get more details"
}
}
}
},
"/accounts/{account_id}/coins/NEAR": {
"get": {
"summary": "Get the user's balance",
"description": "This endpoint returns the balance of the given account_id,\n for the specified token_contract_id | near.",
"parameters": [{
"in": "path",
"name": "account_id",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}, {
"in": "query",
"name": "block_height",
"schema": {
"type": "string"
},
"style": "form"
}, {
"in": "query",
"name": "block_timestamp_nanos",
"schema": {
"type": "string"
},
"style": "form"
}],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NearBalanceResponse"
}
}
}
},
"500": {
"description": "See the inner `code` value to get more details"
}
}
}
},
"/accounts/{account_id}/coins/NEAR/history": {
"get": {
"parameters": [{
"in": "path",
"name": "account_id",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}, {
"in": "query",
"name": "block_height",
"schema": {
"type": "string"
},
"style": "form"
}, {
"in": "query",
"name": "block_timestamp_nanos",
"schema": {
"type": "string"
},
"style": "form"
}, {
"in": "query",
"name": "limit",
"schema": {
"type": "integer",
"format": "int32"
},
"style": "form"
}, {
"in": "query",
"name": "offset",
"schema": {
"type": "integer",
"format": "int32"
},
"style": "form"
}],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NearHistoryResponse"
}
}
}
},
"500": {
"description": "See the inner `code` value to get more details"
}
}
}
},
"/accounts/{account_id}/coins/{contract_account_id}": {
"get": {
"parameters": [{
"in": "path",
"name": "account_id",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}, {
"in": "path",
"name": "contract_account_id",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}, {
"in": "query",
"name": "block_height",
"schema": {
"type": "string"
},
"style": "form"
}, {
"in": "query",
"name": "block_timestamp_nanos",
"schema": {
"type": "string"
},
"style": "form"
}],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BalancesResponse"
}
}
}
},
"500": {
"description": "See the inner `code` value to get more details"
}
}
}
},
"/accounts/{account_id}/coins/{contract_account_id}/history": {
"get": {
"parameters": [{
"in": "path",
"name": "account_id",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}, {
"in": "path",
"name": "contract_account_id",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}, {
"in": "query",
"name": "block_height",
"schema": {
"type": "string"
},
"style": "form"
}, {
"in": "query",
"name": "block_timestamp_nanos",
"schema": {
"type": "string"
},
"style": "form"
}, {
"in": "query",
"name": "limit",
"schema": {
"type": "integer",
"format": "int32"
},
"style": "form"
}, {
"in": "query",
"name": "offset",
"schema": {
"type": "integer",
"format": "int32"
},
"style": "form"
}],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HistoryResponse"
}
}
}
},
"500": {
"description": "See the inner `code` value to get more details"
}
}
}
},
"/accounts/{account_id}/collectibles": {
"get": {
"parameters": [{
"in": "path",
"name": "account_id",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}, {
"in": "query",
"name": "block_height",
"schema": {
"type": "string"
},
"style": "form"
}, {
"in": "query",
"name": "block_timestamp_nanos",
"schema": {
"type": "string"
},
"style": "form"
}, {
"in": "query",
"name": "limit",
"schema": {
"type": "integer",
"format": "int32"
},
"style": "form"
}, {
"in": "query",
"name": "offset",
"schema": {
"type": "integer",
"format": "int32"
},
"style": "form"
}],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NftCountResponse"
}
}
}
},
"500": {
"description": "See the inner `code` value to get more details"
}
}
}
},
"/accounts/{account_id}/collectibles/{contract_account_id}": {
"get": {
"parameters": [{
"in": "path",
"name": "account_id",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}, {
"in": "path",
"name": "contract_account_id",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}, {
"in": "query",
"name": "block_height",
"schema": {
"type": "string"
},
"style": "form"
}, {
"in": "query",
"name": "block_timestamp_nanos",
"schema": {
"type": "string"
},
"style": "form"
}, {
"in": "query",
"name": "limit",
"schema": {
"type": "integer",
"format": "int32"
},
"style": "form"
}, {
"in": "query",
"name": "offset",
"schema": {
"type": "integer",
"format": "int32"
},
"style": "form"
}],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NftBalanceResponse"
}
}
}
},
"500": {
"description": "See the inner `code` value to get more details"
}
}
}
},
"/accounts/{account_id}/collectibles/{contract_account_id}/{token_id}": {
"get": {
"parameters": [{
"in": "path",
"name": "account_id",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}, {
"in": "path",
"name": "contract_account_id",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}, {
"in": "path",
"name": "token_id",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}, {
"in": "query",
"name": "block_height",
"schema": {
"type": "string"
},
"style": "form"
}, {
"in": "query",
"name": "block_timestamp_nanos",
"schema": {
"type": "string"
},
"style": "form"
}],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NftItemResponse"
}
}
}
},
"500": {
"description": "See the inner `code` value to get more details"
}
}
}
},
"/accounts/{account_id}/collectibles/{contract_account_id}/{token_id}/history": {
"get": {
"parameters": [{
"in": "path",
"name": "account_id",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}, {
"in": "path",
"name": "contract_account_id",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}, {
"in": "path",
"name": "token_id",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}, {
"in": "query",
"name": "block_height",
"schema": {
"type": "string"
},
"style": "form"
}, {
"in": "query",
"name": "block_timestamp_nanos",
"schema": {
"type": "string"
},
"style": "form"
}, {
"in": "query",
"name": "limit",
"schema": {
"type": "integer",
"format": "int32"
},
"style": "form"
}, {
"in": "query",
"name": "offset",
"schema": {
"type": "integer",
"format": "int32"
},
"style": "form"
}],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NftHistoryResponse"
}
}
}
},
"500": {
"description": "See the inner `code` value to get more details"
}
}
}
},
"/nep141/metadata/{contract_account_id}": {
"get": {
"parameters": [{
"in": "path",
"name": "contract_account_id",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}, {
"in": "query",
"name": "block_height",
"schema": {
"type": "string"
},
"style": "form"
}, {
"in": "query",
"name": "block_timestamp_nanos",
"schema": {
"type": "string"
},
"style": "form"
}],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FtMetadataResponse"
}
}
}
},
"500": {
"description": "See the inner `code` value to get more details"
}
}
}
},
"/nep171/metadata/{contract_account_id}": {
"get": {
"parameters": [{
"in": "path",
"name": "contract_account_id",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}, {
"in": "query",
"name": "block_height",
"schema": {
"type": "string"
},
"style": "form"
}, {
"in": "query",
"name": "block_timestamp_nanos",
"schema": {
"type": "string"
},
"style": "form"
}],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NftMetadataResponse"
}
}
}
},
"500": {
"description": "See the inner `code` value to get more details"
}
}
}
}
},
"components": {
"schemas": {
"BalancesResponse": {
"type": "object",
"properties": {
"balances": {
"type": "array",
"items": {
"type": "object",
"properties": {
"balance": {
"type": "string"
},
"contract_account_id": {
"type": "string"
},
"metadata": {
"type": "object",
"properties": {
"decimals": {
"type": "integer",
"format": "int32"
},
"icon": {
"type": "string"
},
"name": {
"type": "string"
},
"symbol": {
"type": "string"
}
},
"required": ["decimals", "name", "symbol"]
},
"standard": {
"type": "string"
}
},
"required": ["balance", "metadata", "standard"]
}
},
"block_height": {
"type": "string"
},
"block_timestamp_nanos": {
"type": "string"
}
},
"required": ["balances", "block_height", "block_timestamp_nanos"]
},
"FtMetadataResponse": {
"type": "object",
"properties": {
"block_height": {
"type": "string"
},
"block_timestamp_nanos": {
"type": "string"
},
"metadata": {
"type": "object",
"properties": {
"decimals": {
"type": "integer",
"format": "int32"
},
"icon": {
"type": "string"
},
"name": {
"type": "string"
},
"reference": {
"type": "string"
},
"reference_hash": {
"type": "string"
},
"spec": {
"type": "string"
},
"symbol": {
"type": "string"
}
},
"required": ["decimals", "name", "spec", "symbol"]
}
},
"required": ["block_height", "block_timestamp_nanos", "metadata"]
},
"HistoryResponse": {
"type": "object",
"properties": {
"block_height": {
"type": "string"
},
"block_timestamp_nanos": {
"type": "string"
},
"history": {
"type": "array",
"items": {
"type": "object",
"properties": {
"action_kind": {
"type": "string"
},
"balance": {
"type": "string"
},
"block_height": {
"type": "string"
},
"block_timestamp_nanos": {
"type": "string"
},
"delta_balance": {
"type": "string"
},
"involved_account_id": {
"type": "string"
},
"metadata": {
"type": "object",
"properties": {
"decimals": {
"type": "integer",
"format": "int32"
},
"icon": {
"type": "string"
},
"name": {
"type": "string"
},
"symbol": {
"type": "string"
}
},
"required": ["decimals", "name", "symbol"]
}
},
"required": ["action_kind", "balance", "block_height", "block_timestamp_nanos", "delta_balance", "metadata"]
}
}
},
"required": ["block_height", "block_timestamp_nanos", "history"]
},
"NearBalanceResponse": {
"type": "object",
"properties": {
"available_balance": {
"type": "string"
},
"block_height": {
"type": "string"
},
"block_timestamp_nanos": {
"type": "string"
},
"metadata": {
"type": "object",
"properties": {
"decimals": {
"type": "integer",
"format": "int32"
},
"icon": {
"type": "string"
},
"name": {
"type": "string"
},
"symbol": {
"type": "string"
}
},
"required": ["decimals", "name", "symbol"]
},
"staked_balance": {
"type": "string"
},
"total_balance": {
"type": "string"
}
},
"required": ["available_balance", "block_height", "block_timestamp_nanos", "metadata", "staked_balance", "total_balance"]
},
"NearHistoryResponse": {
"type": "object",
"properties": {
"block_height": {
"type": "string"
},
"block_timestamp_nanos": {
"type": "string"
},
"history": {
"type": "array",
"items": {
"type": "object",
"properties": {
"available_balance": {
"type": "string"
},
"block_height": {
"type": "string"
},
"block_timestamp_nanos": {
"type": "string"
},
"cause": {
"type": "string"
},
"delta_available_balance": {
"type": "string"
},
"delta_balance": {
"type": "string"
},
"delta_staked_balance": {
"type": "string"
},
"involved_account_id": {
"type": "string"
},
"staked_balance": {
"type": "string"
},
"total_balance": {
"type": "string"
}
},
"required": ["available_balance", "block_height", "block_timestamp_nanos", "cause", "delta_available_balance", "delta_balance", "delta_staked_balance", "staked_balance", "total_balance"]
}
},
"metadata": {
"type": "object",
"properties": {
"decimals": {
"type": "integer",
"format": "int32"
},
"icon": {
"type": "string"
},
"name": {
"type": "string"
},
"symbol": {
"type": "string"
}
},
"required": ["decimals", "name", "symbol"]
}
},
"required": ["block_height", "block_timestamp_nanos", "history", "metadata"]
},
"NftBalanceResponse": {
"type": "object",
"properties": {
"block_height": {
"type": "string"
},
"block_timestamp_nanos": {
"type": "string"
},
"contract_metadata": {
"type": "object",
"properties": {
"base_uri": {
"type": "string"
},
"icon": {
"type": "string"
},
"name": {
"type": "string"
},
"reference": {
"type": "string"
},
"reference_hash": {
"type": "string"
},
"spec": {
"type": "string"
},
"symbol": {
"type": "string"
}
},
"required": ["name", "spec", "symbol"]
},
"nfts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"metadata": {
"type": "object",
"properties": {
"copies": {
"type": "integer",
"format": "int64"
},
"description": {
"type": "string"
},
"expires_at": {
"type": "string"
},
"extra": {
"type": "string"
},
"issued_at": {
"type": "string"
},
"media": {
"type": "string"
},
"media_hash": {
"type": "string"
},
"reference": {
"type": "string"
},
"reference_hash": {
"type": "string"
},
"starts_at": {
"type": "string"
},
"title": {
"type": "string"
},
"updated_at": {
"type": "string"
}
}
},
"owner_account_id": {
"type": "string"
},
"token_id": {
"type": "string"
}
},
"required": ["owner_account_id", "token_id"]
}
}
},
"required": ["block_height", "block_timestamp_nanos", "contract_metadata", "nfts"]
},
"NftCountResponse": {
"type": "object",
"properties": {
"block_height": {
"type": "string"
},
"block_timestamp_nanos": {
"type": "string"
},
"nft_count": {
"type": "array",
"items": {
"type": "object",
"properties": {
"contract_account_id": {
"type": "string"
},
"metadata": {
"type": "object",
"properties": {
"base_uri": {
"type": "string"
},
"icon": {
"type": "string"
},
"name": {
"type": "string"
},
"reference": {
"type": "string"
},
"reference_hash": {
"type": "string"
},
"spec": {
"type": "string"
},
"symbol": {
"type": "string"
}
},
"required": ["name", "spec", "symbol"]
},
"nft_count": {
"type": "integer",
"format": "int32"
}
},
"required": ["contract_account_id", "metadata", "nft_count"]
}
}
},
"required": ["block_height", "block_timestamp_nanos", "nft_count"]
},
"NftHistoryResponse": {
"type": "object",
"properties": {
"block_height": {
"type": "string"
},
"block_timestamp_nanos": {
"type": "string"
},
"contract_metadata": {
"type": "object",
"properties": {
"base_uri": {
"type": "string"
},
"icon": {
"type": "string"
},
"name": {
"type": "string"
},
"reference": {
"type": "string"
},
"reference_hash": {
"type": "string"
},
"spec": {
"type": "string"
},
"symbol": {
"type": "string"
}
},
"required": ["name", "spec", "symbol"]
},
"history": {
"type": "array",
"items": {
"type": "object",
"properties": {
"action_kind": {
"type": "string"
},
"block_height": {
"type": "string"
},
"block_timestamp_nanos": {
"type": "string"
},
"new_account_id": {
"type": "string"
},
"old_account_id": {
"type": "string"
}
},
"required": ["action_kind", "block_height", "block_timestamp_nanos"]
}
},
"token_metadata": {
"type": "object",
"properties": {
"metadata": {
"type": "object",
"properties": {
"copies": {
"type": "integer",
"format": "int64"
},
"description": {
"type": "string"
},
"expires_at": {
"type": "string"
},
"extra": {
"type": "string"
},
"issued_at": {
"type": "string"
},
"media": {
"type": "string"
},
"media_hash": {
"type": "string"
},
"reference": {
"type": "string"
},
"reference_hash": {
"type": "string"
},
"starts_at": {
"type": "string"
},
"title": {
"type": "string"
},
"updated_at": {
"type": "string"
}
}
},
"owner_account_id": {
"type": "string"
},
"token_id": {
"type": "string"
}
},
"required": ["owner_account_id", "token_id"]
}
},
"required": ["block_height", "block_timestamp_nanos", "contract_metadata", "history", "token_metadata"]
},
"NftItemResponse": {
"type": "object",
"properties": {
"block_height": {
"type": "string"
},
"block_timestamp_nanos": {
"type": "string"
},
"contract_metadata": {
"type": "object",
"properties": {
"base_uri": {
"type": "string"
},
"icon": {
"type": "string"
},
"name": {
"type": "string"
},
"reference": {
"type": "string"
},
"reference_hash": {
"type": "string"
},
"spec": {
"type": "string"
},
"symbol": {
"type": "string"
}
},
"required": ["name", "spec", "symbol"]
},
"nft": {
"type": "object",
"properties": {
"metadata": {
"type": "object",
"properties": {
"copies": {
"type": "integer",
"format": "int64"
},
"description": {
"type": "string"
},
"expires_at": {
"type": "string"
},
"extra": {
"type": "string"
},
"issued_at": {
"type": "string"
},
"media": {
"type": "string"
},
"media_hash": {
"type": "string"
},
"reference": {
"type": "string"
},
"reference_hash": {
"type": "string"
},
"starts_at": {
"type": "string"
},
"title": {
"type": "string"
},
"updated_at": {
"type": "string"
}
}
},
"owner_account_id": {
"type": "string"
},
"token_id": {
"type": "string"
}
},
"required": ["owner_account_id", "token_id"]
}
},
"required": ["block_height", "block_timestamp_nanos", "contract_metadata", "nft"]
},
"NftMetadataResponse": {
"type": "object",
"properties": {
"block_height": {
"type": "string"
},
"block_timestamp_nanos": {
"type": "string"
},
"metadata": {
"type": "object",
"properties": {
"base_uri": {
"type": "string"
},
"icon": {
"type": "string"
},
"name": {
"type": "string"
},
"reference": {
"type": "string"
},
"reference_hash": {
"type": "string"
},
"spec": {
"type": "string"
},
"symbol": {
"type": "string"
}
},
"required": ["name", "spec", "symbol"]
}
},
"required": ["block_height", "block_timestamp_nanos", "metadata"]
}
}
},
"tags": [{
"name": "Accounts",
"description": "Most common actions with accounts in NEAR"
}, {
"name": "Standards",
"description": "Manipulate with NEAR Enhancement Proposal (NEP) Standards"
}]
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment