Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
title: Shlink URL Shortener API
version: '3.0'
description: 'Operations tagged URL Shortener across 3 of this provider''s published API definitions: shlink-openapi-v5.1.4.json, shlink-openapi-v5.1.0.json, shlink-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: '{scheme}://{host}'
variables:
scheme:
enum:
- https
- http
default: https
host:
default: ''
tags:
- name: URL Shortener
description: Non-rest endpoints, used to be publicly exposed
paths:
/{shortCode}:
get:
tags:
- URL Shortener
summary: Short URL
description: Represents a short URL. Tracks the visit and redirects tio the corresponding long URL
operationId: shortUrl
parameters:
- name: shortCode
in: path
description: The short code for the short URL.
required: true
schema:
type: string
responses:
'302':
description: Visit properly tracked and redirected
servers:
- url: '{scheme}://{host}'
variables:
scheme:
enum:
- https
- http
default: https
host:
default: ''
/{shortCode}/track:
get:
tags:
- URL Shortener
summary: Short URL tracking pixel
description: Generates a 1px transparent image which can be used to track emails with a short URL
operationId: trackShortUrl
parameters:
- name: shortCode
in: path
description: The short code for the short URL.
required: true
schema:
type: string
responses:
'200':
description: Image in GIF format
content:
image/gif:
schema:
type: string
format: binary
servers:
- url: '{scheme}://{host}'
variables:
scheme:
enum:
- https
- http
default: https
host:
default: ''
components:
securitySchemes:
ApiKey:
type: apiKey
description: A valid shlink API key
name: X-Api-Key
in: header
externalDocs:
description: Find more info on how to start using this API here
url: https://shlink.io/documentation/api-docs
x-refined-from:
- shlink-openapi-v5.1.4.json
- shlink-openapi-v5.1.0.json
- shlink-openapi.json