Overview

The market API is the public interface allowing the client to connect and interact with the marketplace. The REST API handles short connections in a requests and response pattern. The WebSocket API alllows clients to create a permanent connection to receive live order updates or market data updates.


graph LR
    %% Define nodes
    subgraph Seller
        SBC[Flexibility Asset]
        TA[Trading Agent]
    end

    subgraph GLocalFlexMarket
        FTM[Market Backend]
        API[Rest API / WebSocket]
    end

    subgraph Buyer
        TA2[Trading Agent]
    end



    %% Define connections
    SBC --> TA


    TA -- Trading/Market Data <--> API
    TA2 -- Trading/Market Data <--> API

    API <--> FTM

The REST API provides endpoints for authentication, trading, receiving market data, flexibility delivery verification and smart contracts. Explore the REST API functionality with the Swagger UI interactively or check the detailed OpenAPI reference specification.

The WebSocket API complements the REST API by providing a bidirectional connection between client and marketplace where clients receive live updates from the market. Time sensistive updates including trading and market information are delivered through a WebSocket connection immediately to the client.

Quick links: