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. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
title: Fast data update API
version: 0.1.0
tags:
- name: data update
paths:
/api/v2/update/states:
post:
tags:
- data update
summary: Update States
description: 'Update states data from the API as a background task
Returns a task ID that can be used to check the status'
operationId: update_states_api_v2_update_states_post
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
/api/v2/update/states/single:
post:
tags:
- data update
summary: Update States Single
description: 'Update states data from the API as a background task for a single state
Returns a task ID that can be used to check the status
You can call this endpoint in two ways:
1. With a JSON body (recommended for Swagger): {"state": "Maryland"}
2. With query parameters: ?state=Maryland
Args:
request: Request body with state (use this OR query parameters)
state: State name to update (query parameter, use this OR request body)
Note: If both request body and query parameters are provided, request body takes precedence.'
operationId: update_states_single_api_v2_update_states_single_post
parameters:
- name: state
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: State name to update (used if not provided in request body)
title: State
description: State name to update (used if not provided in request body)
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateStateRequest'
description: Request body with state. If state is empty, query parameters will be used.
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v2/update/task/{task_id}:
get:
tags:
- data update
summary: Get Task Status
description: Get the status of a background task by task ID
operationId: get_task_status_api_v2_update_task__task_id__get
parameters:
- name: task_id
in: path
required: true
schema:
type: string
title: Task Id
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
UpdateStateRequest:
properties:
state:
anyOf:
- type: string
- type: 'null'
title: State
type: object
title: UpdateStateRequest
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
type: object
required:
- loc
- msg
- type
title: ValidationError
securitySchemes:
HTTPBearer:
type: http
scheme: bearer