NudgeLink Map API

The map API from NudgeLink — 3 operation(s) for map.

GitHub OpenAPI

Operations 4

POST /api/v1/map-requests Create Map Request #
GET /api/v1/map/{token} Get Map #
GET /api/v1/map/{token}/preview Get Preview #
POST /api/v1/map/{token}/preview Start Preview #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/nudgelink-co:nudgelink-co-map-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

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.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

nudgelink-co-map-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: NudgeLink Map API
  version: 0.1.0
tags:
- name: Map
paths:
  /api/v1/map-requests:
    post:
      tags:
      - Map
      summary: Create Map Request
      operationId: create_map_request_api_v1_map_requests_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MapRequestIn'
        required: true
      responses:
        '202':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MapRequestAccepted'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/map/{token}:
    get:
      tags:
      - Map
      summary: Get Map
      operationId: get_map_api_v1_map__token__get
      parameters:
      - name: token
        in: path
        required: true
        schema:
          type: string
          title: Token
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Get Map Api V1 Map  Token  Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/map/{token}/preview:
    get:
      tags:
      - Map
      summary: Get Preview
      description: The instant preview's state for ``/map/``. 404 for an unknown link.
      operationId: get_preview_api_v1_map__token__preview_get
      parameters:
      - name: token
        in: path
        required: true
        schema:
          type: string
          title: Token
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Get Preview Api V1 Map  Token  Preview Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    post:
      tags:
      - Map
      summary: Start Preview
      description: Start the instant preview. Opening the emailed link is the confirmation.
      operationId: start_preview_api_v1_map__token__preview_post
      parameters:
      - name: token
        in: path
        required: true
        schema:
          type: string
          title: Token
      responses:
        '202':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Start Preview Api V1 Map  Token  Preview Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    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
    MapRequestAccepted:
      properties:
        ok:
          type: boolean
          title: Ok
          default: true
      type: object
      title: MapRequestAccepted
    MapRequestIn:
      properties:
        name:
          type: string
          maxLength: 200
          minLength: 1
          title: Name
        email:
          type: string
          format: email
          title: Email
        website:
          type: string
          maxLength: 500
          minLength: 3
          title: Website
        sells_to:
          type: string
          maxLength: 1000
          minLength: 3
          title: Sells To
        region:
          type: string
          maxLength: 200
          minLength: 2
          title: Region
        locale:
          type: string
          pattern: ^(en|pl|ru)$
          title: Locale
          default: en
        src:
          type: string
          maxLength: 64
          title: Src
          default: ''
        website_confirm:
          type: string
          maxLength: 500
          title: Website Confirm
          default: ''
      type: object
      required:
      - name
      - email
      - website
      - sells_to
      - region
      title: MapRequestIn
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer