# AlphaX API Reference Documentation

## API Reference Documentation

- [API Introduction](https://apidocs.alphax.cloud/api-introduction.md): AlphaX Cloud's API codenamed Conduit, is our modern API designed to seamlessly transport data from the edge into the enterprise for downstream consumption.
- [General Architecture](https://apidocs.alphax.cloud/general-architecture.md): AlphaX splits its services into 2 general components, Data In and Data Out, these are sometimes referred to as upstream and downstream.
- [Authentication](https://apidocs.alphax.cloud/authentication.md): The Conduit feature enhances data import/export security via a token and server-side validation, activated individually for users, allowing token-authenticated access to user-specific data.
- [Rate Limits](https://apidocs.alphax.cloud/rate-limits.md): The conduit API service is throttled by default.
- [HTTP](https://apidocs.alphax.cloud/http.md): Using the HTTP API in AlphaX is a relatively simple process. The user must format his/her data in the correct format and simply use the method of choice to send and receive data from the provided URL.
- [HTTP Headers](https://apidocs.alphax.cloud/http/http-headers.md): AlphaX conduit service utilizes specific HTTP headers for authentication, data format specification, compression, and method override within requests and responses.
- [HTTP Parameters](https://apidocs.alphax.cloud/http/http-parameters.md): API Resource requests commonly result in a response containing the current representation of one or more resources.
- [HTTP Compression](https://apidocs.alphax.cloud/http/http-compression.md): HTTP compression is supported on both incoming and outgoing requests.
- [HTTP Error and Status Codes](https://apidocs.alphax.cloud/http/http-error-and-status-codes.md): The Conduit service will return appropriate HTTP status codes for every request.
- [SSL Requests](https://apidocs.alphax.cloud/http/ssl-requests.md): All conduit API requests must be made over HTTPS
- [Sending Data](https://apidocs.alphax.cloud/http/sending-data.md): How to identify the correct uplink data format and prepare your data for uplink into the AlphaX system.
- [Uplink Data Format V2](https://apidocs.alphax.cloud/http/sending-data/uplink-data-format-v2.md): AlphaX API expects JSON with token, networkId, timestamp, and data array containing channelId and value. Supports advanced data integration and security features.
- [Retrieve Data](https://apidocs.alphax.cloud/http/retrieve-data.md)
- [Conduit V4](https://apidocs.alphax.cloud/http/retrieve-data/conduit-v4.md): Conduit V4 provides a minimal set of data, best used for applications that require values for updates where device data is already known.
- [Conduit V6](https://apidocs.alphax.cloud/http/retrieve-data/conduit-v6.md): Conduit V6 provides a full set of device data for each data point requested. Best used to register devices and update devices in other systems.
- [Conduit V7](https://apidocs.alphax.cloud/http/retrieve-data/conduit-v7.md): This guide provides detailed support for the API endpoint that supports multi-stage aggregations for time series data.
- [Using Conduit V7](https://apidocs.alphax.cloud/http/retrieve-data/conduit-v7/using-conduit-v7.md): API Parameters When timerange Applied and Valid, return the data from last timerange seconds. When timerange Not Applied or Invalid and fcdt & tcdt Applied and Valid, return the data from fcdtto tcdt.
- [Aggregation Features (Optional)](https://apidocs.alphax.cloud/http/retrieve-data/conduit-v7/aggregation-features-optional.md): Aggregations are used to transform the data before loading into a downstream application. It can be useful to reduce the amount of data transfer and apply simple calculations on the fly.
- [Common Issues & Troubleshooting](https://apidocs.alphax.cloud/http/retrieve-data/conduit-v7/common-issues-and-troubleshooting.md): The ConduitV7 API is complicated. Below are some common issues and troubleshooting tips to help you solve problems you may encounter while using the ConduitV7 API.
- [Usage Examples](https://apidocs.alphax.cloud/http/retrieve-data/conduit-v7/usage-examples.md): These examples provide a starting point and can be modified based on your specific requirements. Always ensure that you are using the correct parameters and their values for successful data retrieval
- [MQTT](https://apidocs.alphax.cloud/mqtt.md): MQTT is a lightweight IoT protocol useful for connections with remote locations where a small code footprint is required.
- [MQTT Authentication](https://apidocs.alphax.cloud/mqtt/mqtt-authentication.md)
- [MQTT Broker Address](https://apidocs.alphax.cloud/mqtt/mqtt-broker-address.md): Connect to the MQTT broker using the following addresses.
- [Publishing Data](https://apidocs.alphax.cloud/mqtt/publishing-data.md)
- [MQTT Publish Format V1](https://apidocs.alphax.cloud/mqtt/publishing-data/mqtt-publish-format-v1.md): MQTT Publish format V1 is the compressed format, useful for data constrained devices. Data remains in byte array and decoded in AlphaX cloud.
- [MQTT Publish Format V2](https://apidocs.alphax.cloud/mqtt/publishing-data/mqtt-publish-format-v2.md): MQTT Publish format V2 is a user friendly, human readable JSON package for sending data to a device on AlphaX Cloud.