openapi: 3.0.3
info:
title: Flickr 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: Activity
description: Recent activity on the calling user's photos and contacts
- name: Auth
description: OAuth 1.0a token exchange
- name: Blogs
description: Configured blogs and posting to them
- name: Cameras
description: Camera brand and model metadata
- name: Collections
description: Hierarchical collections of photosets
- name: Commons
description: Flickr Commons institutions
- name: Contacts
description: Calling user's contacts and recent contact activity
- name: Favorites
description: Photos a user has marked as favorites
- name: Galleries
description: Curated, themed galleries of photos
- name: Groups
description: Group metadata, membership, and pool management
- name: Groups Discuss
description: Group discussion topics and replies
- name: Interestingness
description: The day's most interesting photos
- name: Machine Tags
description: Namespace, predicate, and value lookups for machine tags
- name: Panda
description: The Flickr Panda firehose of "interesting" photos
- name: People
description: People (users), their info, public photos, and groups
- name: Photos
description: Core photo metadata, search, comments, and lifecycle
- name: Photos Geo
description: Geotagging photos with latitude/longitude
- name: Photos Licenses
description: License catalog and per-photo license assignment
- name: Photos Notes
description: Notes drawn on photos
- name: Photos Transform
description: Rotate photos server-side
- name: Photos Upload
description: Asynchronous upload status polling
- name: Photosets
description: Photo albums (photosets)
- name: Places
description: Place IDs, hierarchies, and resolution
- name: Prefs
description: Calling user's posting preferences
- name: Profile
description: User profile fields
- name: Push
description: PubSubHubbub push subscriptions
- name: Reflection
description: Programmatic discovery of available API methods
- name: Stats
description: View counts and referrers for photos/photosets/collections
- name: Tags
description: Tag clusters, hot lists, and tag-based lookups
- name: Test
description: Echo, login, and null test methods
- name: URLs
description: Look up Flickr URLs by user, group, gallery
paths:
/rest:
get:
operationId: invokeFlickrMethod
summary: Invoke Any Flickr Method
description: |
Dispatches a call to any flickr.* method. The `method` query parameter
selects which method to invoke and the remaining query parameters are
the arguments for that method. This single endpoint backs every
per-method operation defined below.
tags:
- Reflection
parameters:
- $ref: '#/components/parameters/Method'
- $ref: '#/components/parameters/ApiKey'
- $ref: '#/components/parameters/Format'
- $ref: '#/components/parameters/NoJsonCallback'
responses:
'200':
description: Method response (shape depends on method)
content:
application/json:
schema:
$ref: '#/components/schemas/MethodResponse'
examples:
InvokeFlickrMethod200Example:
summary: Default invokeFlickrMethod 200 response
x-microcks-default: true
value: {}
'400':
$ref: '#/components/responses/FlickrError'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/rest/flickr.activity.userPhotos:
get:
operationId: activityUserPhotos
summary: Get Activity On The User's Photos
description: Returns recent activity on photos belonging to the calling user.
tags:
- Activity
parameters:
- $ref: '#/components/parameters/ApiKey'
- name: timeframe
in: query
description: Time window such as "1h" or "12h".
schema:
type: string
example: 12h
- $ref: '#/components/parameters/PerPage'
- $ref: '#/components/parameters/Page'
responses:
'200':
description: Activity items
content:
application/json:
schema:
$ref: '#/components/schemas/ActivityList'
examples:
ActivityUserPhotos200Example:
summary: Default activityUserPhotos 200 response
x-microcks-default: true
value:
page: 1
pages: 12
total: 1183
item:
- type: photo
id: '52345678901'
owner: 12345678@N00
secret: abc1234def
server: '65535'
farm: 66
title: Golden Gate Sunset
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/rest/flickr.auth.oauth.checkToken:
get:
operationId: authOauthCheckToken
summary: Check OAuth Token
description: Returns the credentials attached to an OAuth authentication token.
tags:
- Auth
parameters:
- $ref: '#/components/parameters/ApiKey'
- name: oauth_token
in: query
required: true
description: The OAuth authentication token to check.
schema:
type: string
example: 72157712345-abcdef0123456789
responses:
'200':
description: OAuth credentials
content:
application/json:
schema:
$ref: '#/components/schemas/OAuthCredentials'
examples:
AuthOauthCheckToken200Example:
summary: Default authOauthCheckToken 200 response
x-microcks-default: true
value:
oauth:
token:
_content: '100'
perms:
_content: '100'
user:
nsid: 12345678@N00
username: shutterbug
fullname: Jane Photographer
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/rest/flickr.blogs.getList:
get:
operationId: blogsGetList
summary: Get Configured Blogs
description: Returns a list of Flickr-supported blogging services the calling user has configured.
tags:
- Blogs
parameters:
- $ref: '#/components/parameters/ApiKey'
- name: service
in: query
description: Optional service ID filter.
schema:
type: string
example: blogger
responses:
'200':
description: Configured blogs
content:
application/json:
schema:
$ref: '#/components/schemas/BlogList'
examples:
BlogsGetList200Example:
summary: Default blogsGetList 200 response
x-microcks-default: true
value:
blog:
- id: '52345678901'
name: Bay Area Photographers
service: blogger
url: https://www.flickr.com/galleries/12345678@N00/72157712345/
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/rest/flickr.cameras.getBrands:
get:
operationId: camerasGetBrands
summary: List Camera Brands
description: Returns all camera brands supported in the Flickr camera taxonomy.
tags:
- Cameras
parameters:
- $ref: '#/components/parameters/ApiKey'
responses:
'200':
description: Brand list
content:
application/json:
schema:
$ref: '#/components/schemas/BrandList'
examples:
CamerasGetBrands200Example:
summary: Default camerasGetBrands 200 response
x-microcks-default: true
value:
brand:
- id: '52345678901'
name: Bay Area Photographers
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/rest/flickr.cameras.getBrandModels:
get:
operationId: camerasGetBrandModels
summary: List Camera Models For A Brand
description: Returns all camera models for the given brand.
tags:
- Cameras
parameters:
- $ref: '#/components/parameters/ApiKey'
- name: brand
in: query
required: true
description: The brand ID.
schema:
type: string
example: nikon
responses:
'200':
description: Model list
content:
application/json:
schema:
$ref: '#/components/schemas/CameraList'
examples:
CamerasGetBrandModels200Example:
summary: Default camerasGetBrandModels 200 response
x-microcks-default: true
value:
camera:
- id: '52345678901'
name: Bay Area Photographers
details: {}
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/rest/flickr.collections.getTree:
get:
operationId: collectionsGetTree
summary: Get The Collection Tree
description: Returns a tree (or sub-tree) of collections belonging to a user.
tags:
- Collections
parameters:
- $ref: '#/components/parameters/ApiKey'
- name: collection_id
in: query
schema:
type: string
example: 12345678-72157712345
- $ref: '#/components/parameters/UserId'
responses:
'200':
description: Collection tree
content:
application/json:
schema:
$ref: '#/components/schemas/CollectionTree'
examples:
CollectionsGetTree200Example:
summary: Default collectionsGetTree 200 response
x-microcks-default: true
value:
collection:
- id: '52345678901'
title: Golden Gate Sunset
description: Detailed photo metadata.
iconlarge: https://www.flickr.com/services/api/
set:
- id: '52345678901'
title: Golden Gate Sunset
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/rest/flickr.commons.getInstitutions:
get:
operationId: commonsGetInstitutions
summary: List Flickr Commons Institutions
description: Returns the list of institutions participating in The Commons.
tags:
- Commons
parameters:
- $ref: '#/components/parameters/ApiKey'
responses:
'200':
description: Institutions
content:
application/json:
schema:
$ref: '#/components/schemas/InstitutionList'
examples:
CommonsGetInstitutions200Example:
summary: Default commonsGetInstitutions 200 response
x-microcks-default: true
value:
institution:
- nsid: 12345678@N00
name: Bay Area Photographers
date_launch: '1232409600'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/rest/flickr.contacts.getList:
get:
operationId: contactsGetList
summary: Get Contacts For The Calling User
description: Returns the contact list for the authenticated user.
tags:
- Contacts
parameters:
- $ref: '#/components/parameters/ApiKey'
- name: filter
in: query
description: 'One of: friends, family, both, neither.'
schema:
type: string
enum: [friends, family, both, neither]
example: friends
- $ref: '#/components/parameters/Page'
- $ref: '#/components/parameters/PerPage'
responses:
'200':
description: Contact list
content:
application/json:
schema:
$ref: '#/components/schemas/ContactList'
examples:
ContactsGetList200Example:
summary: Default contactsGetList 200 response
x-microcks-default: true
value:
page: 1
pages: 12
total: 1183
contact:
- nsid: 12345678@N00
username: shutterbug
iconserver: '7402'
realname: Jane Photographer
friend: 1
family: 0
ignored: 0
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/rest/flickr.favorites.getList:
get:
operationId: favoritesGetList
summary: Get A User's Favorites
description: Returns a list of the user's favorite photos. Only photos which the calling user has permission to see are returned.
tags:
- Favorites
parameters:
- $ref: '#/components/parameters/ApiKey'
- $ref: '#/components/parameters/UserId'
- $ref: '#/components/parameters/Page'
- $ref: '#/components/parameters/PerPage'
responses:
'200':
description: Favorites
content:
application/json:
schema:
$ref: '#/components/schemas/PhotoList'
examples:
FavoritesGetList200Example:
summary: Default favoritesGetList 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.favorites.add:
post:
operationId: favoritesAdd
summary: Mark Photo As Favorite
description: Adds a photo to the calling user's favorites list.
tags:
- Favorites
parameters:
- $ref: '#/components/parameters/ApiKey'
- $ref: '#/components/parameters/PhotoId'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessResponse'
examples:
FavoritesAdd200Example:
summary: Default favoritesAdd 200 response
x-microcks-default: true
value:
stat: ok
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/rest/flickr.galleries.getList:
get:
operationId: galleriesGetList
summary: List A User's Galleries
description: Returns a list of galleries created by a user.
tags:
- Galleries
parameters:
- $ref: '#/components/parameters/ApiKey'
- $ref: '#/components/parameters/UserId'
- $ref: '#/components/parameters/Page'
- $ref: '#/components/parameters/PerPage'
responses:
'200':
description: Galleries
content:
application/json:
schema:
$ref: '#/components/schemas/GalleryList'
examples:
GalleriesGetList200Example:
summary: Default galleriesGetList 200 response
x-microcks-default: true
value:
page: 1
pages: 12
total: 1183
gallery:
- id: '52345678901'
url: https://www.flickr.com/galleries/12345678@N00/72157712345/
owner: 12345678@N00
date_create: '1715000000'
count_photos: 18
count_videos: 0
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/rest/flickr.galleries.getPhotos:
get:
operationId: galleriesGetPhotos
summary: List Photos In A Gallery
description: Returns the photos for a given gallery.
tags:
- Galleries
parameters:
- $ref: '#/components/parameters/ApiKey'
- name: gallery_id
in: query
required: true
schema:
type: string
example: 12345678-72157712345
- $ref: '#/components/parameters/Page'
- $ref: '#/components/parameters/PerPage'
- $ref: '#/components/parameters/Extras'
responses:
'200':
description: Gallery photos
content:
application/json:
schema:
$ref: '#/components/schemas/PhotoList'
examples:
GalleriesGetPhotos200Example:
summary: Default galleriesGetPhotos 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.groups.getInfo:
get:
operationId: groupsGetInfo
summary: Get Group Info
description: Returns information about a group.
tags:
- Groups
parameters:
- $ref: '#/components/parameters/ApiKey'
- name: group_id
in: query
required: true
schema:
type: string
example: 12345678@N00
responses:
'200':
description: Group info
content:
application/json:
schema:
$ref: '#/components/schemas/Group'
examples:
GroupsGetInfo200Example:
summary: Default groupsGetInfo 200 response
x-microcks-default: true
value:
id: '52345678901'
nsid: 12345678@N00
name: Bay Area Photographers
members: 18324
pool_count: 942113
topic_count: 8421
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/rest/flickr.groups.search:
get:
operationId: groupsSearch
summary: Search Groups By Text
description: Searches groups by text.
tags:
- Groups
parameters:
- $ref: '#/components/parameters/ApiKey'
- name: text
in: query
required: true
schema:
type: string
example: golden gate
- $ref: '#/components/parameters/Page'
- $ref: '#/components/parameters/PerPage'
responses:
'200':
description: Matching groups
content:
application/json:
schema:
$ref: '#/components/schemas/GroupList'
examples:
GroupsSearch200Example:
summary: Default groupsSearch 200 response
x-microcks-default: true
value:
page: 1
pages: 12
total: 1183
group:
- id: '52345678901'
nsid: 12345678@N00
name: Bay Area Photographers
members: 18324
pool_count: 942113
topic_count: 8421
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/rest/flickr.groups.pools.getPhotos:
get:
operationId: groupsPoolsGetPhotos
summary: List Photos In A Group Pool
description: Returns photos in a group's pool.
tags:
- Groups
parameters:
- $ref: '#/components/parameters/ApiKey'
- name: group_id
in: query
required: true
schema:
type: string
example: 12345678@N00
- $ref: '#/components/parameters/Page'
- $ref: '#/components/parameters/PerPage'
- $ref: '#/components/parameters/Extras'
responses:
'200':
description: Pool photos
content:
application/json:
schema:
$ref: '#/components/schemas/PhotoList'
examples:
GroupsPoolsGetPhotos200Example:
summary: Default groupsPoolsGetPhotos 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.groups.discuss.topics.getList:
get:
operationId: groupsDiscussTopicsGetList
summary: List Group Discussion Topics
description: Returns discussion topics for a group.
tags:
- Groups Discuss
parameters:
- $ref: '#/components/parameters/ApiKey'
- name: group_id
in: query
required: true
schema:
type: string
example: 12345678@N00
- $ref: '#/components/parameters/Page'
- $ref: '#/components/parameters/PerPage'
responses:
'200':
description: Topics
content:
application/json:
schema:
$ref: '#/components/schemas/TopicList'
examples:
GroupsDiscussTopicsGetList200Example:
summary: Default groupsDiscussTopicsGetList 200 response
x-microcks-default: true
value:
page: 1
pages: 12
total: 1183
topic:
- id: '52345678901'
subject: Tips for sunset photography
author: 12345678@N00
author_name: shutterbug
datecreate: '1715000000'
count_replies: 7
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/rest/flickr.groups.discuss.replies.getList:
get:
operationId: groupsDiscussRepliesGetList
summary: List Replies For A Discussion Topic
description: Returns the replies for a discussion topic.
tags:
- Groups Discuss
parameters:
- $ref: '#/components/parameters/ApiKey'
- name: topic_id
in: query
required: true
schema:
type: string
example: '72157712345'
- $ref: '#/components/parameters/Page'
- $ref: '#/components/parameters/PerPage'
responses:
'200':
description: Replies
content:
application/json:
schema:
$ref: '#/components/schemas/TopicReplyList'
examples:
GroupsDiscussRepliesGetList200Example:
summary: Default groupsDiscussRepliesGetList 200 response
x-microcks-default: true
value:
page: 1
pages: 12
total: 1183
reply:
- id: '52345678901'
author: 12345678@N00
message:
_content: '100'
datecreate: '1715000000'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/rest/flickr.interestingness.getList:
get:
operationId: interestingnessGetList
summary: List Interesting Photos
description: Returns the most interesting photos for the given date.
tags:
- Interestingness
parameters:
- $ref: '#/components/parameters/ApiKey'
- name: date
in: query
description: YYYY-MM-DD date.
schema:
type: string
format: date
example: '2026-04-30'
- $ref: '#/components/parameters/Page'
- $ref: '#/components/parameters/PerPage'
- $ref: '#/components/parameters/Extras'
responses:
'200':
description: Interesting photos
content:
application/json:
schema:
$ref: '#/components/schemas/PhotoList'
examples:
InterestingnessGetList200Example:
summary: Default interestingnessGetList 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.machinetags.getNamespaces:
get:
operationId: machinetagsGetNamespaces
summary: List Machine Tag Namespaces
description: Returns a list of machine tag namespaces.
tags:
- Machine Tags
parameters:
- $ref: '#/components/parameters/ApiKey'
- $ref: '#/components/parameters/Page'
- $ref: '#/components/parameters/PerPage'
responses:
'200':
description: Namespaces
content:
application/json:
schema:
$ref: '#/components/schemas/MachineTagNamespaceList'
examples:
MachinetagsGetNamespaces200Example:
summary: Default machinetagsGetNamespaces 200 response
x-microcks-default: true
value:
page: 1
pages: 12
total: 1183
namespace:
- usage: 18421
predicates: 14
_content: '100'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/rest/flickr.panda.getList:
get:
operationId: pandaGetList
summary: List Flickr Panda Feeds
description: Returns a list of available Flickr Panda firehose feeds.
tags:
- Panda
parameters:
- $ref: '#/components/parameters/ApiKey'
responses:
'200':
description: Panda feeds
content:
application/json:
schema:
$ref: '#/components/schemas/PandaList'
examples:
PandaGetList200Example:
summary: Default pandaGetList 200 response
x-microcks-default: true
value:
panda:
- _content: '100'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/rest/flickr.panda.getPhotos:
get:
operationId: pandaGetPhotos
summary: Get Panda Firehose Photos
description: Returns photos for the given Panda feed.
tags:
- Panda
parameters:
- $ref: '#/components/parameters/ApiKey'
- name: panda_name
in: query
required: true
schema:
type: string
example: example
- $ref: '#/components/parameters/Extras'
responses:
'200':
description: Panda photos
content:
application/json:
schema:
$ref: '#/components/schemas/PhotoList'
examples:
PandaGetPhotos200Example:
summary: Default pandaGetPhotos 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.people.getInfo:
get:
operationId: peopleGetInfo
summary: Get Person Info
description: Returns information about a person.
tags:
- People
parameters:
- $ref: '#/components/parameters/ApiKey'
- $ref: '#/components/parameters/UserId'
responses:
'200':
des
# --- truncated at 32 KB (96 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/flickr/refs/heads/main/openapi/flickr-openapi.yml