OpenAPI Specification
openapi: 3.0.3
info:
title: Flickr Activity Photosets API
description: 'The Flickr API exposes the photo, group, people, place, tag, gallery, and
photoset capabilities that power flickr.com. Almost all flickr.com
functionality is reachable through a single REST-like endpoint
`https://api.flickr.com/services/rest` using a `method=flickr.{namespace}.{method}`
query parameter and `format=json&nojsoncallback=1` for JSON output.
This OpenAPI specification models a curated set of the most widely used
methods across the Flickr API''s 250+ method namespaces (activity, auth,
blogs, cameras, collections, commons, contacts, favorites, galleries,
groups, groupsDiscuss, interestingness, machinetags, panda, people, photos,
photos.geo, photos.licenses, photos.notes, photos.transform, photos.upload,
photosets, places, prefs, profile, push, reflection, stats, tags, test, urls).
Authentication is API key + OAuth 1.0a (HMAC-SHA1). Commercial use of the
API requires prior permission from Flickr.
'
version: 1.0.0
termsOfService: https://www.flickr.com/services/api/tos/
contact:
name: Flickr API Support
url: https://www.flickr.com/help/api/
license:
name: Flickr API Terms of Use
url: https://www.flickr.com/services/api/tos/
x-generated-from: documentation
x-last-validated: '2026-05-30'
servers:
- url: https://api.flickr.com/services
description: Flickr REST API
- url: https://up.flickr.com/services
description: Flickr Upload endpoint
security:
- ApiKeyAuth: []
- OAuth1:
- read
- write
- delete
tags:
- name: Photosets
description: Photo albums (photosets)
paths:
/rest/flickr.photosets.getList:
get:
operationId: photosetsGetList
summary: List A User's Photosets
description: Returns photosets belonging to a user.
tags:
- Photosets
parameters:
- $ref: '#/components/parameters/ApiKey'
- $ref: '#/components/parameters/UserIdOptional'
- $ref: '#/components/parameters/Page'
- $ref: '#/components/parameters/PerPage'
responses:
'200':
description: Photosets
content:
application/json:
schema:
$ref: '#/components/schemas/PhotosetList'
examples:
PhotosetsGetList200Example:
summary: Default photosetsGetList 200 response
x-microcks-default: true
value:
page: 1
pages: 12
perpage: 100
total: 1183
photoset:
- id: '52345678901'
primary: '52345678901'
owner: 12345678@N00
title:
_content: '100'
description:
_content: '100'
photos: 248
videos: 3
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/rest/flickr.photosets.getPhotos:
get:
operationId: photosetsGetPhotos
summary: List Photos In A Photoset
description: Returns the photos in a given photoset.
tags:
- Photosets
parameters:
- $ref: '#/components/parameters/ApiKey'
- name: photoset_id
in: query
required: true
schema:
type: string
example: '72157712345'
- $ref: '#/components/parameters/UserIdOptional'
- $ref: '#/components/parameters/Page'
- $ref: '#/components/parameters/PerPage'
- $ref: '#/components/parameters/Extras'
responses:
'200':
description: Photoset photos
content:
application/json:
schema:
$ref: '#/components/schemas/PhotoList'
examples:
PhotosetsGetPhotos200Example:
summary: Default photosetsGetPhotos 200 response
x-microcks-default: true
value:
page: 1
pages: 12
perpage: 100
total: 1183
photo:
- id: '52345678901'
owner: 12345678@N00
secret: abc1234def
server: '65535'
farm: 66
title: Golden Gate Sunset
ispublic: 1
isfriend: 0
isfamily: 0
datetaken: '2026-04-12 18:24:11'
url_o: https://live.staticflickr.com/65535/52345678901_abc1234def_o.jpg
height_o: 4032
width_o: 6048
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/rest/flickr.photosets.create:
post:
operationId: photosetsCreate
summary: Create A New Photoset
description: Creates a new photoset for the calling user.
tags:
- Photosets
parameters:
- $ref: '#/components/parameters/ApiKey'
- name: title
in: query
required: true
schema:
type: string
example: Sunsets
- name: description
in: query
schema:
type: string
example: Best sunsets I have shot.
- name: primary_photo_id
in: query
required: true
schema:
type: string
example: '52345678901'
responses:
'200':
description: Photoset created
content:
application/json:
schema:
$ref: '#/components/schemas/Photoset'
examples:
PhotosetsCreate200Example:
summary: Default photosetsCreate 200 response
x-microcks-default: true
value:
id: '52345678901'
primary: '52345678901'
owner: 12345678@N00
title:
_content: '100'
description:
_content: '100'
photos: 248
videos: 3
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
components:
parameters:
PerPage:
name: per_page
in: query
schema:
type: integer
default: 100
maximum: 500
example: 100
UserIdOptional:
name: user_id
in: query
schema:
type: string
example: 12345678@N00
Page:
name: page
in: query
schema:
type: integer
default: 1
example: 1
Extras:
name: extras
in: query
description: Comma-delimited list of extra fields (e.g. owner_name, url_o, geo).
schema:
type: string
example: owner_name,description,url_o,date_taken,geo
ApiKey:
name: api_key
in: query
required: true
description: Application API key.
schema:
type: string
example: ab1234567890cdef1234567890abcd12
schemas:
Photoset:
type: object
properties:
id:
type: string
example: '52345678901'
primary:
type: string
example: '52345678901'
owner:
type: string
example: 12345678@N00
title:
type: object
properties:
_content:
type: string
example: '100'
description:
type: object
properties:
_content:
type: string
example: '100'
photos:
type: integer
example: 248
videos:
type: integer
example: 3
PhotosetList:
type: object
properties:
page:
type: integer
example: 1
pages:
type: integer
example: 12
perpage:
type: integer
example: 100
total:
type: integer
example: 1183
photoset:
type: array
items:
$ref: '#/components/schemas/Photoset'
Photo:
type: object
description: A photo.
properties:
id:
type: string
example: '52345678901'
owner:
type: string
example: 12345678@N00
secret:
type: string
example: abc1234def
server:
type: string
example: '65535'
farm:
type: integer
example: 66
title:
type: string
example: Golden Gate Sunset
ispublic:
type: integer
example: 1
isfriend:
type: integer
example: 0
isfamily:
type: integer
example: 0
datetaken:
type: string
example: '2026-04-12 18:24:11'
url_o:
type: string
format: uri
example: https://live.staticflickr.com/65535/52345678901_abc1234def_o.jpg
height_o:
type: integer
example: 4032
width_o:
type: integer
example: 6048
PhotoList:
type: object
properties:
page:
type: integer
example: 1
pages:
type: integer
example: 12
perpage:
type: integer
example: 100
total:
type: integer
example: 1183
photo:
type: array
items:
$ref: '#/components/schemas/Photo'
securitySchemes:
ApiKeyAuth:
type: apiKey
in: query
name: api_key
description: Application API key for non-authenticated and read-only public requests.
OAuth1:
type: oauth2
description: 'Flickr uses OAuth 1.0a (HMAC-SHA1). The OpenAPI 3 schema cannot model
OAuth 1.0a directly, so this entry approximates the flow. Token URLs:
- Request token: https://www.flickr.com/services/oauth/request_token
- Authorize: https://www.flickr.com/services/oauth/authorize
- Access token: https://www.flickr.com/services/oauth/access_token
'
flows:
authorizationCode:
authorizationUrl: https://www.flickr.com/services/oauth/authorize
tokenUrl: https://www.flickr.com/services/oauth/access_token
scopes:
read: Read access to private content owned by the user
write: Modify content owned by the user
delete: Delete content owned by the user