# SSL Certificate Information API Documentation


# Domain SSL Certificate Information Parsing API

> **Category**: Web Tools  
> **Endpoint**: `/v1/websitetools/sslcertinfo`  
> **Method**: `GET`  
> **Description**: Retrieves and parses detailed SSL certificate information for a given domain.

## Overview

The **Domain SSL Certificate Information Parsing API** by [GuGuData](https://gugudata.io/) enables **millisecond-speed** retrieval of comprehensive SSL/TLS certificate details. From **subject and issuer** data to **signature algorithms, key usage**, and **validity periods**, this API provides **granular insights** into any domain's security posture.

Whether you're performing **security audits**, **compliance checks**, or simply monitoring certificate **expiration dates**, this API delivers accurate and up-to-date results. With its **nationwide multi-node CDN deployment** and **high concurrency** support, you can analyze thousands of SSL certificates in seconds.

Key highlights include:

- **Complete SSL property parsing**: Extract Subject DN, Issuer DN, Serial Number, Validity, Signature Algorithm, Public Key details, and more.
- **Millisecond response times**: Rapid analysis suitable for real-time security workflows.
- **Load-balanced infrastructure**: Ensures stable performance under heavy usage.
- **HTTPS/TLS integration**: End-to-end support for TLS versions 1.0 through 1.3, fully Apple ATS-compatible.

## Request URL

```
GET https://api.gugudata.io/v1/websitetools/sslcertinfo
```

### Demo URL

You can test this API using our live demo endpoint:
[https://api.gugudata.io/v1/websitetools/sslcertinfo/demo](https://api.gugudata.io/v1/websitetools/sslcertinfo/demo)

## Request Parameters

Send a **GET** request to the above endpoint with the following query parameters:

| **Parameter** | **Type** | **Required** | **Default Value** | **Description**                                                                                                        |
| :-----------: | :------: | :----------: | :---------------: | :--------------------------------------------------------------------------------------------------------------------- |
|   `appkey`    | `string` |     Yes      |   `YOUR_APPKEY`   | Your unique APPKEY obtained from GuGuData's Developer Center.                                                          |
|   `domain`    | `string` |     Yes      |   `YOUR_VALUE`    | The domain to analyze. Must be formatted as `https://www.gugudata.com` (or a valid domain with the `https://` prefix). |

## Response Parameters

The API returns a JSON structure containing detailed SSL certificate information. Below is an overview of key fields:

|         **Parameter**          | **Type**  | **Required** | **Description**                                              |
| :----------------------------: | :-------: | :----------: | :----------------------------------------------------------- |
| `dataStatus.requestParameter`  | `string`  |     Yes      | The requested domain parameter.                              |
|    `dataStatus.statusCode`     | `integer` |     Yes      | The HTTP status code.                                        |
|      `dataStatus.status`       | `string`  |     Yes      | Request status (e.g., _OK_, _Error_).                        |
| `dataStatus.statusDescription` | `string`  |     Yes      | Description of the request status.                           |
| `dataStatus.responseDateTime`  | `string`  |     Yes      | The timestamp for when the data was returned.                |
|  `dataStatus.dataTotalCount`   | `integer` |     Yes      | The total number of returned data items.                     |
|        `data.subjectDN`        | `string`  |     Yes      | Subject Distinguished Name.                                  |
|        `data.issuerDN`         | `string`  |     Yes      | Issuer Distinguished Name.                                   |
|      `data.serialNumber`       | `string`  |     Yes      | Certificate serial number.                                   |
|        `data.validFrom`        | `string`  |     Yes      | Start date of the certificate's validity period.             |
|         `data.validTo`         | `string`  |     Yes      | End date of the certificate's validity period.               |
|   `data.signatureAlgorithm`    | `string`  |     Yes      | The algorithm used for the certificate's signature.          |
|        `data.publicKey`        | `string`  |     Yes      | Public key information.                                      |
|        `data.keyUsage`         | `string`  |      No      | Key usage extensions.                                        |
|    `data.extendedKeyUsage`     | `string`  |      No      | Extended key usage extensions.                               |
|    `data.basicConstraints`     | `string`  |      No      | Basic constraints (e.g., CA=true).                           |
| `data.subjectAlternativeNames` | `string`  |      No      | Subject Alternative Names (SAN) included in the certificate. |
| `data.issuerAlternativeNames`  | `string`  |      No      | Alternative names for the issuing CA.                        |
|         `data.version`         | `string`  |     Yes      | Certificate version (e.g., V3).                              |
|        `data.signature`        | `string`  |     Yes      | The certificate signature.                                   |
|   `data.publicKeyAlgorithm`    | `string`  |     Yes      | Algorithm used for the public key.                           |
|       `data.extensions`        | `string`  |     Yes      | Detailed SSL extension information.                          |

## Error Codes

Encountering issues? Below are some common error codes:

| **Error Code** |     **Error Content**     | **Notes**                                                                          |
| :------------: | :-----------------------: | :--------------------------------------------------------------------------------- |
|     `200`      |       Normal return       | Request successful.                                                                |
|     `400`      |      Parameter error      | Check if your query parameters are correct and properly encoded.                   |
|     `429`      | Request frequency limited | Requests exceed the limit of 100 per second.                                       |
|     `403`      |    Account in arrears     | Resolve any payment issues to reactivate your account.                             |
|     `402`      |       APPKEY error        | Verify that the APPKEY is correct from your Developer Center.                      |
|     `500`      |    API response error     | A generic error from the server, possibly indicating downtime or misconfiguration. |

## Features

1. **Domain SSL Certificate Parsing** – Retrieves core certificate properties for in-depth inspection.
2. **Extensive SSL Property Extraction** – Subject DN, Issuer DN, validity, public key data, usage constraints, and more.
3. **Millisecond Parsing** – Designed for real-time queries in high-throughput environments.
4. **HTTPS (TLS 1.0 - 1.3) Compliance** – Ensures secure connections and Apple ATS compatibility.
5. **Nationwide Multi-Node CDN** – Distributes load and provides rapid response times across various regions.
6. **High Concurrency Support** – Handles large-scale monitoring or analysis workflows efficiently.
7. **Load-Balanced Architecture** – Ensures stable, fast performance even during traffic peaks.

## Additional Notes for Developers

- **Domain Format**: Always include `https://` in the domain parameter for accurate SSL parsing.
- **Status Monitoring**: Regularly check your usage stats and concurrency limits to avoid rate-limiting.
- **Security Insights**: Use the certificate data to validate domain security, track expiration dates, or evaluate CA trustworthiness.

## Getting Started

1. **Sign up at [GuGuData.io](https://gugudata.io/)** – Obtain your `appkey` from the Developer Center.
2. **Construct a GET request** – Include both `appkey` and `domain` as query parameters.
3. **Check the Response** – A detailed JSON structure with certificate metadata is returned upon success.
4. **Integrate** – Use this information for auditing, certificate expiration checks, or enhanced analytics dashboards.

## About GuGuData

[**GuGuData**](https://gugudata.io/) is a proven provider of **data solutions** with nearly a decade of innovation in developing **advanced APIs**. Our wide-ranging offerings extend beyond SSL inspection; we also provide [Webpage Readable Content Extraction](https://gugudata.io/), [Image Recognition](https://gugudata.io/), and more. Through **continuous data cleaning, organization, and integration**, we ensure businesses, researchers, and developers have quick access to powerful, reliable endpoints.

**Key Highlights**:

- **Nine years in business** – Our experience translates into stability and reliability.
- **4.2k+ APIs** – Explore diverse data functions to scale your operations.
- **95% happy customers** – Trusted by organizations worldwide.

With the **Domain SSL Certificate Information Parsing API**, **guarantee the security and validity** of your sites or your clients' domains. Visit our [official website](https://gugudata.io/) for more innovative, cost-effective data solutions.