Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
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. By signing up you are subscribing to the APIs.io and API Evangelist
newsletters — you can unsubscribe from any issue. See our
Privacy Policy and Terms.
openapi: 3.2.0
info:
title: Admiral Places API
version: 0.1.0
tags:
- name: Places
paths:
/accounts/{account_id}/places:
get:
tags:
- Places
summary: List Places
operationId: list_places_accounts__account_id__places_get
parameters:
- name: account_id
in: path
required: true
schema:
type: string
format: uuid
title: Account Id
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/accounts/{account_id}/places/presence:
post:
tags:
- Places
summary: Show Only Where Picked
description: 'Stop showing to people who are merely INTERESTED in the places picked.
One campaign per call on purpose. Batching several into one transaction
loses the receipt for every write that already landed at Google when a
later one fails — the caller loops and reports per campaign instead.'
operationId: show_only_where_picked_accounts__account_id__places_presence_post
parameters:
- name: account_id
in: path
required: true
schema:
type: string
format: uuid
title: Account Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PresenceRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
PresenceRequest:
properties:
campaign_id:
type: string
title: Campaign Id
prev_positive_geo_target_type:
anyOf:
- type: string
- type: 'null'
title: Prev Positive Geo Target Type
type: object
required:
- campaign_id
title: PresenceRequest
description: '`prev` is what the campaign is set to now, so History can put it back.
Optional: an older snapshot may not carry it, and a fix that cannot name
the previous value is still better than a fix nobody can make.'
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
input:
title: Input
ctx:
type: object
title: Context
type: object
required:
- loc
- msg
- type
title: ValidationError
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError