Aelf

Aelf Net API

The Net API from Aelf — 3 operation(s) for net.

GitHub OpenAPI
Business capability
Node & RPC Infrastructure AE-240.40

Operations 4

POST /api/net/peer Attempts to add a node to the connected network nodes #
DELETE /api/net/peer Attempts to remove a node from the connected network nodes #
GET /api/net/peers Get peer info about the connected network nodes #
GET /api/net/networkInfo Get information about the node’s connection to the network #

Documentation

📖
Documentation
https://docs.aelf.com/tools/web-api/
📖
APIReference
https://docs.aelf.com/tools/web-api/chain-api/

Specifications

⚙
OpenAPI
https://artifacts.apis.io/aelf-inc/openapi/aelf-inc-net-api-openapi.yml

Other Resources

🔗
Console
https://aelf-public-node.aelf.io/swagger/index.html
🔗
ErrorCatalog
https://artifacts.apis.io/aelf-inc/errors/aelf-inc-error-codes.yml
🔗
DataModel
https://artifacts.apis.io/aelf-inc/data-model/aelf-inc-data-model.yml
🔗
SourceCode
https://github.com/AElfProject/aelf-agent-gateway

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/aelf-inc:aelf-inc-net-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

aelf-inc-net-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: AElf Net API
  version: v1
tags:
- name: Net
paths:
  /api/net/peer:
    post:
      tags:
      - Net
      summary: Attempts to add a node to the connected network nodes
      requestBody:
        content:
          application/json; v=1.0:
            schema:
              $ref: '#/components/schemas/AElf.WebApp.Application.Net.Dto.AddPeerInput'
          text/json; v=1.0:
            schema:
              $ref: '#/components/schemas/AElf.WebApp.Application.Net.Dto.AddPeerInput'
          application/*+json; v=1.0:
            schema:
              $ref: '#/components/schemas/AElf.WebApp.Application.Net.Dto.AddPeerInput'
          application/x-protobuf; v=1.0:
            schema:
              $ref: '#/components/schemas/AElf.WebApp.Application.Net.Dto.AddPeerInput'
      responses:
        '200':
          description: Success
          content:
            text/plain; v=1.0:
              schema:
                type: boolean
            application/json; v=1.0:
              schema:
                type: boolean
            text/json; v=1.0:
              schema:
                type: boolean
            application/x-protobuf; v=1.0:
              schema:
                type: boolean
        '403':
          description: Forbidden
          content:
            text/plain; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
            application/json; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
            text/json; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
            application/x-protobuf; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
        '401':
          description: Unauthorized
          content:
            text/plain; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
            application/json; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
            text/json; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
            application/x-protobuf; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
        '400':
          description: Bad Request
          content:
            text/plain; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
            application/json; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
            text/json; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
            application/x-protobuf; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
        '404':
          description: Not Found
          content:
            text/plain; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
            application/json; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
            text/json; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
            application/x-protobuf; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
        '501':
          description: Server Error
          content:
            text/plain; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
            application/json; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
            text/json; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
            application/x-protobuf; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
        '500':
          description: Server Error
          content:
            text/plain; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
            application/json; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
            text/json; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
            application/x-protobuf; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
      operationId: postApiNetPeer
      x-operation-id-source: derived
    delete:
      tags:
      - Net
      summary: Attempts to remove a node from the connected network nodes
      parameters:
      - name: address
        in: query
        description: ip address
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            text/plain; v=1.0:
              schema:
                type: boolean
            application/json; v=1.0:
              schema:
                type: boolean
            text/json; v=1.0:
              schema:
                type: boolean
            application/x-protobuf; v=1.0:
              schema:
                type: boolean
        '403':
          description: Forbidden
          content:
            text/plain; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
            application/json; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
            text/json; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
            application/x-protobuf; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
        '401':
          description: Unauthorized
          content:
            text/plain; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
            application/json; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
            text/json; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
            application/x-protobuf; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
        '400':
          description: Bad Request
          content:
            text/plain; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
            application/json; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
            text/json; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
            application/x-protobuf; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
        '404':
          description: Not Found
          content:
            text/plain; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
            application/json; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
            text/json; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
            application/x-protobuf; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
        '501':
          description: Server Error
          content:
            text/plain; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
            application/json; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
            text/json; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
            application/x-protobuf; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
        '500':
          description: Server Error
          content:
            text/plain; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
            application/json; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
            text/json; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
            application/x-protobuf; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
      operationId: deleteApiNetPeer
      x-operation-id-source: derived
  /api/net/peers:
    get:
      tags:
      - Net
      summary: Get peer info about the connected network nodes
      parameters:
      - name: withMetrics
        in: query
        schema:
          type: boolean
          default: false
      responses:
        '200':
          description: Success
          content:
            text/plain; v=1.0:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AElf.WebApp.Application.Net.Dto.PeerDto'
            application/json; v=1.0:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AElf.WebApp.Application.Net.Dto.PeerDto'
            text/json; v=1.0:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AElf.WebApp.Application.Net.Dto.PeerDto'
            application/x-protobuf; v=1.0:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AElf.WebApp.Application.Net.Dto.PeerDto'
        '403':
          description: Forbidden
          content:
            text/plain; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
            application/json; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
            text/json; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
            application/x-protobuf; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
        '401':
          description: Unauthorized
          content:
            text/plain; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
            application/json; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
            text/json; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
            application/x-protobuf; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
        '400':
          description: Bad Request
          content:
            text/plain; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
            application/json; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
            text/json; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
            application/x-protobuf; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
        '404':
          description: Not Found
          content:
            text/plain; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
            application/json; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
            text/json; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
            application/x-protobuf; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
        '501':
          description: Server Error
          content:
            text/plain; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
            application/json; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
            text/json; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
            application/x-protobuf; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
        '500':
          description: Server Error
          content:
            text/plain; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
            application/json; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
            text/json; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
            application/x-protobuf; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
      operationId: getApiNetPeers
      x-operation-id-source: derived
  /api/net/networkInfo:
    get:
      tags:
      - Net
      summary: Get information about the node’s connection to the network
      responses:
        '200':
          description: Success
          content:
            text/plain; v=1.0:
              schema:
                $ref: '#/components/schemas/AElf.WebApp.Application.Net.Dto.GetNetworkInfoOutput'
            application/json; v=1.0:
              schema:
                $ref: '#/components/schemas/AElf.WebApp.Application.Net.Dto.GetNetworkInfoOutput'
            text/json; v=1.0:
              schema:
                $ref: '#/components/schemas/AElf.WebApp.Application.Net.Dto.GetNetworkInfoOutput'
            application/x-protobuf; v=1.0:
              schema:
                $ref: '#/components/schemas/AElf.WebApp.Application.Net.Dto.GetNetworkInfoOutput'
        '403':
          description: Forbidden
          content:
            text/plain; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
            application/json; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
            text/json; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
            application/x-protobuf; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
        '401':
          description: Unauthorized
          content:
            text/plain; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
            application/json; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
            text/json; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
            application/x-protobuf; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
        '400':
          description: Bad Request
          content:
            text/plain; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
            application/json; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
            text/json; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
            application/x-protobuf; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
        '404':
          description: Not Found
          content:
            text/plain; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
            application/json; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
            text/json; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
            application/x-protobuf; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
        '501':
          description: Server Error
          content:
            text/plain; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
            application/json; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
            text/json; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
            application/x-protobuf; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
        '500':
          description: Server Error
          content:
            text/plain; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
            application/json; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
            text/json; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
            application/x-protobuf; v=1.0:
              schema:
                $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorResponse'
      operationId: getApiNetNetworkInfo
      x-operation-id-source: derived
components:
  schemas:
    Volo.Abp.Http.RemoteServiceErrorResponse:
      type: object
      properties:
        Error:
          $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceErrorInfo'
      additionalProperties: false
    Volo.Abp.Http.RemoteServiceValidationErrorInfo:
      type: object
      properties:
        Message:
          type:
          - string
          - 'null'
        Members:
          type:
          - array
          - 'null'
          items:
            type: string
      additionalProperties: false
    Volo.Abp.Http.RemoteServiceErrorInfo:
      type: object
      properties:
        Code:
          type:
          - string
          - 'null'
        Message:
          type:
          - string
          - 'null'
        Details:
          type:
          - string
          - 'null'
        Data:
          type:
          - object
          - 'null'
          additionalProperties: {}
        ValidationErrors:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Volo.Abp.Http.RemoteServiceValidationErrorInfo'
      additionalProperties: false
    AElf.OS.Network.Metrics.RequestMetric:
      type: object
      properties:
        RoundTripTime:
          type: integer
          format: int64
        MethodName:
          type:
          - string
          - 'null'
        Info:
          type:
          - string
          - 'null'
        RequestTime:
          $ref: '#/components/schemas/Google.Protobuf.WellKnownTypes.Timestamp'
      additionalProperties: false
    AElf.WebApp.Application.Net.Dto.GetNetworkInfoOutput:
      type: object
      properties:
        Version:
          type:
          - string
          - 'null'
          description: node version
        ProtocolVersion:
          type: integer
          description: network protocol version
          format: int32
        Connections:
          type: integer
          description: total number of open connections between this node and other nodes
          format: int32
      additionalProperties: false
    AElf.WebApp.Application.Net.Dto.AddPeerInput:
      type: object
      properties:
        Address:
          type:
          - string
          - 'null'
          description: ip address
      additionalProperties: false
    AElf.WebApp.Application.Net.Dto.PeerDto:
      type: object
      properties:
        IpAddress:
          type:
          - string
          - 'null'
        ProtocolVersion:
          type: integer
          format: int32
        ConnectionTime:
          type: integer
          format: int64
        ConnectionStatus:
          type:
          - string
          - 'null'
        Inbound:
          type: boolean
        BufferedTransactionsCount:
          type: integer
          format: int32
        BufferedBlocksCount:
          type: integer
          format: int32
        BufferedAnnouncementsCount:
          type: integer
          format: int32
        RequestMetrics:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/AElf.OS.Network.Metrics.RequestMetric'
        NodeVersion:
          type:
          - string
          - 'null'
      additionalProperties: false
    Google.Protobuf.WellKnownTypes.Timestamp:
      type: object
      properties:
        Seconds:
          type: integer
          format: int64
        Nanos:
          type: integer
          format: int32
      additionalProperties: false
x-provenance:
  method: harvested
  publisher: Aelf
  source: https://aelf-public-node.aelf.io/swagger/v1/swagger.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)