https://github.com/MCBanners/banner-api

MCBanners banner generation service
https://github.com/MCBanners/banner-api

Last synced: 2 months ago
JSON representation

MCBanners banner generation service

• Host: GitHub
• URL: https://github.com/MCBanners/banner-api
• Owner: MCBanners
• License: gpl-3.0
• Created: 2019-12-14T00:52:16.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2024-10-24T22:23:03.000Z (2 months ago)
• Last Synced: 2024-10-25T10:51:03.501Z (2 months ago)
• Language: Java
• Homepage:
• Size: 3.42 MB
• Stars: 6
• Watchers: 2
• Forks: 0
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome - MCBanners/banner-api - A banner generator with a banner for Modrinth project information (Miscellaneous / In-game)

README

        

# MCBanners/mc-api

Service designed to interact with Minecraft Servers and return JSON data on the status of the server.

## API Reference

Base URL: https://api.mcbanners.com

#### Supported Platforms (and their parameter type)

spigot -> number\

sponge -> string\

curseforge -> number

#### Check valid author

```http

  GET /author/${platform}/${id}/isValid

```

| Parameter  | Type                 | Description                            |

|:-----------|:---------------------|:---------------------------------------|

| `platform` | `string`             | Platform type from the above list      |

| `id`       | `string` or `number` | The id in the form from the above list |

### Get author banner

```http

  GET /author/${platform}/${id}/banner.${outputType}

```

| Parameter    | Type                 | Description                            |

|:-------------|:---------------------|:---------------------------------------|

| `platform`   | `string`             | Platform type from the above list      |

| `id`         | `string` or `number` | The id in the form from the above list |

| `outputType` | `string`             | Either `png` or `jpg`                  |

#### Check valid resource

```http

  GET /resource/${platform}/${id}/isValid

```

| Parameter  | Type                 | Description                            |

|:-----------|:---------------------|:---------------------------------------|

| `platform` | `string`             | Platform type from the above list      |

| `id`       | `string` or `number` | The id in the form from the above list |

### Get resource banner

```http

  GET /resource/${platform}/${id}/banner.${outputType}

```

| Parameter    | Type                 | Description                            |

|:-------------|:---------------------|:---------------------------------------|

| `platform`   | `string`             | Platform type from the above list      |

| `id`         | `string` or `number` | The id in the form from the above list |

| `outputType` | `string`             | Either `png` or `jpg`                  |

### Check valid server

```http

  GET /server/${host}/${port}/isValid

```

| Parameter | Type     | Description     |

|:----------|:---------|:----------------|

| `host`    | `string` | The server ip   |

| `port`    | `number` | The server port |

### Get server banner

```http

  GET /server/${host}/${port}/banner.${outputType}

```

| Parameter    | Type     | Description           |

|:-------------|:---------|:----------------------|

| `host`       | `string` | The server ip         |

| `port`       | `number` | The server port       |

| `outputType` | `string` | Either `png` or `jpg` |