Become A Partner
Commercial
BMS
ROI
Commercial Retrofitting
Chains
Hospitality
Offices
Apartments and MDUs
AAL
Smart Home
Overview
Retrofitting
How much does it cost?
Passive House
Products
HIGHLIGHTS
Miniserver
Software
Energy
Exosphere
Touch Pure Flex
AREAS OF APPLICATION
HVAC
Lighting
Security
Intercom
Controls
Access Control
Shading
Audio
Blog
Backstage
Know How
Technology
For Partners
Case Studies
References
Get Loxone
References
Experience Loxone
Find an Installer
Discuss Your Project
Partner Webshop
Installers
Become an Installer
Training
M&E Designers
Property Developers
Designers & Architects
Support
Documentation
Datasheets
Downloads
Loxone Library
Contact
Reference Projects

API

API – Programming Interface

The following information describes the programming interface (API) of the Miniserver:

Communicating with the Miniserver
– describes the basics of communication with the Miniserver.

Structure File
– describes the structure file.

Usermanagement
– describes User and Rights Management.

Operating Mode Schedule
– describes the management of Operating Times, to activate Operating Modes.

This information is intended for experienced developers who develop third party software based on the Loxone Miniserver.
Please note that Loxone does not provide technical support for the API.
If necessary, this information is updated when Loxone Config or the Miniserver is updated.
We reserve the right to make changes to the interfaces during updates. We recommend that developers of third-party software always check the current API descriptions.

Ports and Domains

The Miniserver and Loxone Config use different protocols to communicate via network and internet with other devices and Loxone services.
The following document lists the used ports and domains (addresses) in detail:

Loxone Ports & Domains

API Connector

The following document contains a list of possible commands with the API Connector:

API Commands

  • Commercial
    • ROI 
      Array
(
    [ID] => 250206
    [title] => ROI
    [url] => https://www.loxone.com/enen/commercial/energy-management-roi/
    [classes] => Array
        (
            [0] => 
        )

    [object_id] => 250206
    [children] => Array
        (
        )

    [target] => 
)
    • MDU 
      Array
(
    [ID] => 250207
    [title] => MDU
    [url] => https://www.loxone.com/enen/commercial/apartments-and-mdus/
    [classes] => Array
        (
            [0] => 
        )

    [object_id] => 250207
    [children] => Array
        (
        )

    [target] => 
)
    • Office 
      Array
(
    [ID] => 250208
    [title] => Office
    [url] => https://www.loxone.com/enen/commercial/offices/
    [classes] => Array
        (
            [0] => 
        )

    [object_id] => 250208
    [children] => Array
        (
        )

    [target] => 
)
    • AAL 
      Array
(
    [ID] => 250209
    [title] => AAL
    [url] => https://www.loxone.com/enen/commercial/ambient-assisted-living-aal/
    [classes] => Array
        (
            [0] => 
        )

    [object_id] => 250209
    [children] => Array
        (
        )

    [target] => 
)
    • Hospitality 
      Array
(
    [ID] => 250210
    [title] => Hospitality
    [url] => https://www.loxone.com/enen/commercial/hospitality/
    [classes] => Array
        (
            [0] => 
        )

    [object_id] => 250210
    [children] => Array
        (
        )

    [target] => 
)
    • BMS 
      Array
(
    [ID] => 250211
    [title] => BMS
    [url] => https://www.loxone.com/enen/commercial/building-management-system/
    [classes] => Array
        (
            [0] => 
        )

    [object_id] => 250211
    [children] => Array
        (
        )

    [target] => 
)
    • References 
      Array
(
    [ID] => 250212
    [title] => References
    [url] => https://www.loxone.com/enen/commercial/building-automation-case-studies/
    [classes] => Array
        (
            [0] => 
        )

    [object_id] => 250212
    [children] => Array
        (
        )

    [target] => 
)
  • Smart Home
    • Overview 
      Array
(
    [ID] => 250201
    [title] => Overview
    [url] => https://www.loxone.com/enen/smart-home/
    [classes] => Array
        (
            [0] => 
        )

    [object_id] => 250201
    [children] => Array
        (
        )

    [target] => 
)
    • References 
      Array
(
    [ID] => 250202
    [title] => References
    [url] => https://www.loxone.com/enen/smart-home/case-studies/
    [classes] => Array
        (
            [0] => 
        )

    [object_id] => 250202
    [children] => Array
        (
        )

    [target] => 
)
    • How much does it cost? 
      Array
(
    [ID] => 250241
    [title] => How much does it cost?
    [url] => https://www.loxone.com/enen/info/smart-home-brochure/
    [classes] => Array
        (
            [0] => 
        )

    [object_id] => 250241
    [children] => Array
        (
        )

    [target] => 
)
    • Smart Home Advice 
      Array
(
    [ID] => 250204
    [title] => Smart Home Advice
    [url] => https://www.loxone.com/enen/smart-home/#projectrequest
    [classes] => Array
        (
            [0] => 
        )

    [object_id] => 250204
    [children] => Array
        (
        )

    [target] => 
)
    • Retrofitting 
      Array
(
    [ID] => 294598
    [title] => Retrofitting
    [url] => https://www.loxone.com/enen/products/retrofitting/
    [classes] => Array
        (
            [0] => 
        )

    [object_id] => 294598
    [children] => Array
        (
        )

    [target] => 
)
    • Passive House 
      Array
(
    [ID] => 295799
    [title] => Passive House
    [url] => https://www.loxone.com/enen/smart-home/passive-house/
    [classes] => Array
        (
            [0] => 
        )

    [object_id] => 295799
    [children] => Array
        (
        )

    [target] => 
)
  • Products
    • Miniservers 
      Array
(
    [ID] => 250215
    [title] => Miniservers
    [url] => https://www.loxone.com/enen/products/miniserver/
    [classes] => Array
        (
            [0] => 
        )

    [object_id] => 250215
    [children] => Array
        (
        )

    [target] => 
)
    • Audioserver 
      Array
(
    [ID] => 250216
    [title] => Audioserver
    [url] => https://www.loxone.com/enen/products/audioserver/
    [classes] => Array
        (
            [0] => 
        )

    [object_id] => 250216
    [children] => Array
        (
        )

    [target] => 
)
    • Energy Management 
      Array
(
    [ID] => 250224
    [title] => Energy Management
    [url] => https://www.loxone.com/enen/products/energy-management/
    [classes] => Array
        (
            [0] => 
        )

    [object_id] => 250224
    [children] => Array
        (
        )

    [target] => 
)
    • Software 
      Array
(
    [ID] => 250225
    [title] => Software
    [url] => https://www.loxone.com/enen/products/software/
    [classes] => Array
        (
            [0] => 
        )

    [object_id] => 250225
    [children] => Array
        (
        )

    [target] => 
)
    • Heating 
      Array
(
    [ID] => 250220
    [title] => Heating
    [url] => https://www.loxone.com/enen/products/heating/
    [classes] => Array
        (
            [0] => 
        )

    [object_id] => 250220
    [children] => Array
        (
        )

    [target] => 
)
    • Lighting 
      Array
(
    [ID] => 250218
    [title] => Lighting
    [url] => https://www.loxone.com/enen/products/lighting-products/
    [classes] => Array
        (
            [0] => 
        )

    [object_id] => 250218
    [children] => Array
        (
        )

    [target] => 
)
    • Controls 
      Array
(
    [ID] => 250227
    [title] => Controls
    [url] => https://www.loxone.com/enen/products/controls/
    [classes] => Array
        (
            [0] => 
        )

    [object_id] => 250227
    [children] => Array
        (
        )

    [target] => 
)
    • Security 
      Array
(
    [ID] => 250221
    [title] => Security
    [url] => https://www.loxone.com/enen/products/security-products/
    [classes] => Array
        (
            [0] => 
        )

    [object_id] => 250221
    [children] => Array
        (
        )

    [target] => 
)
    • Multiroom Audio 
      Array
(
    [ID] => 250222
    [title] => Multiroom Audio
    [url] => https://www.loxone.com/enen/products/multiroom-audio/
    [classes] => Array
        (
            [0] => 
        )

    [object_id] => 250222
    [children] => Array
        (
        )

    [target] => 
)
    • Access Control 
      Array
(
    [ID] => 250223
    [title] => Access Control
    [url] => https://www.loxone.com/enen/products/access-control/
    [classes] => Array
        (
            [0] => 
        )

    [object_id] => 250223
    [children] => Array
        (
        )

    [target] => 
)
    • Intercom 
      Array
(
    [ID] => 250217
    [title] => Intercom
    [url] => https://www.loxone.com/enen/products/intercom/
    [classes] => Array
        (
            [0] => 
        )

    [object_id] => 250217
    [children] => Array
        (
        )

    [target] => 
)
    • Shading 
      Array
(
    [ID] => 294434
    [title] => Shading
    [url] => https://www.loxone.com/enen/products/smart-blinds/
    [classes] => Array
        (
            [0] => 
        )

    [object_id] => 294434
    [children] => Array
        (
        )

    [target] => 
)
  • Blog
    • Backstage 
      Array
(
    [ID] => 293727
    [title] => Backstage
    [url] => https://www.loxone.com/enen/blog/backstage/
    [classes] => Array
        (
            [0] => 
        )

    [object_id] => 293727
    [children] => Array
        (
        )

    [target] => 
)
    • Know How 
      Array
(
    [ID] => 293728
    [title] => Know How
    [url] => https://www.loxone.com/enen/blog/know-how/
    [classes] => Array
        (
            [0] => 
        )

    [object_id] => 293728
    [children] => Array
        (
        )

    [target] => 
)
    • Technology 
      Array
(
    [ID] => 293729
    [title] => Technology
    [url] => https://www.loxone.com/enen/blog/technology/
    [classes] => Array
        (
            [0] => 
        )

    [object_id] => 293729
    [children] => Array
        (
        )

    [target] => 
)
    • For Partners 
      Array
(
    [ID] => 293730
    [title] => For Partners
    [url] => https://www.loxone.com/enen/blog/for-partners/
    [classes] => Array
        (
            [0] => 
        )

    [object_id] => 293730
    [children] => Array
        (
        )

    [target] => 
)
    • Case Studies 
      Array
(
    [ID] => 293731
    [title] => Case Studies
    [url] => https://www.loxone.com/enen/blog/case-studies/
    [classes] => Array
        (
            [0] => 
        )

    [object_id] => 293731
    [children] => Array
        (
        )

    [target] => 
)
  • Get Loxone
    • Find an Installer 
      Array
(
    [ID] => 250237
    [title] => Find an Installer
    [url] => https://www.loxone.com/enen/shop/find-a-partner/
    [classes] => Array
        (
            [0] => 
        )

    [object_id] => 250237
    [children] => Array
        (
        )

    [target] => 
)
    • Discuss Your Project 
      Array
(
    [ID] => 293732
    [title] => Discuss Your Project
    [url] => https://www.loxone.com/enen/info/book-project-consultation/
    [classes] => Array
        (
            [0] => 
        )

    [object_id] => 293732
    [children] => Array
        (
        )

    [target] => 
)
    • Partner Webshop 
      Array
(
    [ID] => 250238
    [title] => Partner Webshop
    [url] => https://shop.loxone.com/enuk/
    [classes] => Array
        (
            [0] => 
        )

    [object_id] => 250238
    [children] => Array
        (
        )

    [target] => 
)
  • Installers
    • Become an Installer 
      Array
(
    [ID] => 250243
    [title] => Become an Installer
    [url] => https://www.loxone.com/enen/partners/become-an-installer/
    [classes] => Array
        (
            [0] => 
        )

    [object_id] => 250243
    [children] => Array
        (
        )

    [target] => 
)
    • Kickstart Course 
      Array
(
    [ID] => 250246
    [title] => Kickstart Course
    [url] => https://www.loxone.com/enen/lp/installer-introduction-course/
    [classes] => Array
        (
            [0] => 
        )

    [object_id] => 250246
    [children] => Array
        (
        )

    [target] => 
)
    • Training 
      Array
(
    [ID] => 250244
    [title] => Training
    [url] => https://www.loxone.com/enen/partners/training/
    [classes] => Array
        (
            [0] => 
        )

    [object_id] => 250244
    [children] => Array
        (
        )

    [target] => 
)
    • M&E Designers 
      Array
(
    [ID] => 250248
    [title] => M&E Designers
    [url] => https://www.loxone.com/enen/partners/me-designers/
    [classes] => Array
        (
            [0] => 
        )

    [object_id] => 250248
    [children] => Array
        (
        )

    [target] => 
)
    • Property Developers 
      Array
(
    [ID] => 250245
    [title] => Property Developers
    [url] => https://www.loxone.com/enen/partners/property-developers/
    [classes] => Array
        (
            [0] => 
        )

    [object_id] => 250245
    [children] => Array
        (
        )

    [target] => 
)
    • Designers & Architects 
      Array
(
    [ID] => 250247
    [title] => Designers & Architects
    [url] => https://www.loxone.com/enen/partners/designers-architects/
    [classes] => Array
        (
            [0] => 
        )

    [object_id] => 250247
    [children] => Array
        (
        )

    [target] => 
)
  • Support
    • Documentation 
      Array
(
    [ID] => 293734
    [title] => Documentation
    [url] => https://www.loxone.com/enen/kb/
    [classes] => Array
        (
            [0] => 
        )

    [object_id] => 293734
    [children] => Array
        (
        )

    [target] => 
)
    • Datasheets 
      Array
(
    [ID] => 293735
    [title] => Datasheets
    [url] => https://www.loxone.com/enen/datasheets/
    [classes] => Array
        (
            [0] => 
        )

    [object_id] => 293735
    [children] => Array
        (
        )

    [target] => 
)
    • Experience Loxone 
      Array
(
    [ID] => 250203
    [title] => Experience Loxone
    [url] => https://www.loxone.com/enen/smart-home/experience-loxone/
    [classes] => Array
        (
            [0] => 
        )

    [object_id] => 250203
    [children] => Array
        (
        )

    [target] => 
)
    • Contact 
      Array
(
    [ID] => 293737
    [title] => Contact
    [url] => https://www.loxone.com/enen/about-us/contact/
    [classes] => Array
        (
            [0] => 
        )

    [object_id] => 293737
    [children] => Array
        (
        )

    [target] => 
)
    • Downloads 
      Array
(
    [ID] => 293745
    [title] => Downloads
    [url] => https://www.loxone.com/enen/support/downloads/
    [classes] => Array
        (
            [0] => 
        )

    [object_id] => 293745
    [children] => Array
        (
        )

    [target] => 
)
    • Loxone Library 
      Array
(
    [ID] => 293738
    [title] => Loxone Library
    [url] => https://library.loxone.com/
    [classes] => Array
        (
            [0] => 
        )

    [object_id] => 293738
    [children] => Array
        (
        )

    [target] => 
)
  • About Us
    • Mission 
      Array
(
    [ID] => 250229
    [title] => Mission
    [url] => https://www.loxone.com/enen/about-us/mission/
    [classes] => Array
        (
            [0] => 
        )

    [object_id] => 250229
    [children] => Array
        (
        )

    [target] => 
)
    • Careers 
      Array
(
    [ID] => 250230
    [title] => Careers
    [url] => https://www.loxone.com/enen/about-us/careers/
    [classes] => Array
        (
            [0] => 
        )

    [object_id] => 250230
    [children] => Array
        (
        )

    [target] => 
)
    • Loxone Group 
      Array
(
    [ID] => 250231
    [title] => Loxone Group
    [url] => https://www.loxone.com/enen/about-us/loxone-group/
    [classes] => Array
        (
            [0] => 
        )

    [object_id] => 250231
    [children] => Array
        (
        )

    [target] => 
)
    • Contact 
      Array
(
    [ID] => 250232
    [title] => Contact
    [url] => https://www.loxone.com/enen/about-us/contact/
    [classes] => Array
        (
            [0] => 
        )

    [object_id] => 250232
    [children] => Array
        (
        )

    [target] => 
)
    • Press 
      Array
(
    [ID] => 250233
    [title] => Press
    [url] => https://www.loxone.com/enen/about-us/press/
    [classes] => Array
        (
            [0] => 
        )

    [object_id] => 250233
    [children] => Array
        (
        )

    [target] => 
)
    • Terms & Conditions 
      Array
(
    [ID] => 250234
    [title] => Terms & Conditions
    [url] => https://www.loxone.com/enen/info/terms-and-conditions/
    [classes] => Array
        (
            [0] => 
        )

    [object_id] => 250234
    [children] => Array
        (
        )

    [target] => 
)
    • Data Policy 
      Array
(
    [ID] => 250235
    [title] => Data Policy
    [url] => https://www.loxone.com/enen/info/data-protection-statement/
    [classes] => Array
        (
            [0] => 
        )

    [object_id] => 250235
    [children] => Array
        (
        )

    [target] => 
)