mirror of
https://github.com/pheralb/svgl.git
synced 2025-12-29 08:01:36 +08:00
pheralb
46 lines
1.1 KiB
Markdown
46 lines
1.1 KiB
Markdown
---
|
|
title: API Reference
|
|
description: The API reference is a detailed documentation of all the endpoints available in the SVGL API.
|
|
---
|
|
|
|
<script>
|
|
import { PUBLIC_SVGL_API_LIMIT } from '$env/static/public'
|
|
import Endpoint from '../components/endpoints.svelte';
|
|
</script>
|
|
|
|
## Introduction
|
|
|
|
SVGL API is a RESTFul API that allows you to get all the information of the SVGs that are in the repository.
|
|
|
|
## Limitations
|
|
|
|
The API is currently open to everyone and does not require any authentication. However, there is a limit of **{PUBLIC_SVGL_API_LIMIT}** requests per day. If you exceed this limit, you will receive a _429_ error.
|
|
|
|
## Base URL
|
|
|
|
The base URL for the API is:
|
|
|
|
```bash
|
|
https://svgl.vercel.app/api/svgs
|
|
```
|
|
|
|
## Endpoints
|
|
|
|
<div class="flex flex-col space-y-2">
|
|
<Endpoint title="Get all SVGs" method="GET" description="Returns all the SVGs in the repository.">
|
|
|
|
```
|
|
https://svgl.vercel.app/api/svgs
|
|
```
|
|
|
|
</Endpoint>
|
|
|
|
<Endpoint title="Get a limited number of SVGs" method="GET" description="Returns a limited number of SVGs in the repository.">
|
|
|
|
```
|
|
https://svgl.vercel.app/api/svgs?limit=10
|
|
```
|
|
|
|
</Endpoint>
|
|
</div>
|