PVcase

PVcase Project API

The Project API from PVcase — 12 operation(s) for project.

GitHub OpenAPI

Operations 16

GET /api/companies/{cid}/projects/{z}/{x}/{y} Get Vector Tile
POST /api/companies/{cid}/projects/{z}/{x}/{y} Query Vector Tile
GET /api/teams/{teamId}/projects/{projectId} Get Project
PATCH /api/teams/{teamId}/projects/{projectId} Update Project
DELETE /api/teams/{teamId}/projects/{projectId} Delete Project
GET /api/teams/{teamId}/projects/{z}/{x}/{y} Get Vector Tile
POST /api/teams/{teamId}/projects/{z}/{x}/{y} Query Vector Tile
GET /api/teams/{teamId}/projects Get All Projects
POST /api/teams/{teamId}/projects/ Create Project
POST /api/projects/query Query Projects
POST /api/projects/query/column Distinct Column Values
POST /api/teams/{teamId}/projects/query Query Projects
POST /api/projects/query/favorite Query Projects, Favorites
POST /api/teams/{teamId}/projects/query/favorite Query Projects, Favorites
POST /api/projects/query/recent Query Projects, Recent
POST /api/teams/{teamId}/projects/query/recent Query Projects, Recent

Documentation

📖
Documentation
https://pvcase-prospect.gitbook.io/pvcase-prospect-user-documentation/prospect/advanced-tools/api-future-offering/api-technical-overview-future-offering
📖
APIReference
https://pvcase-prospect.gitbook.io/pvcase-prospect-user-documentation/prospect/advanced-tools/api-future-offering/api-reference-future-offering
📖
GettingStarted
https://pvcase-prospect.gitbook.io/pvcase-prospect-user-documentation/prospect/advanced-tools/api-future-offering/quick-start-future-offering

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/pvcase/refs/heads/main/openapi/pvcase-project-api-openapi.yml

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/pvcase-project-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

GitHub Google LinkedIn

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

OpenAPI Specification

pvcase-project-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Anderson Optimization Project API
  description: API to access AO resources
  version: 1.0.0-beta
servers:
- url: https://core-v1.carbon.prod.andersonopt.com
security:
- basicAuth: []
tags:
- name: Project
paths:
  /api/companies/{cid}/projects/{z}/{x}/{y}:
    get:
      summary: Get Vector Tile
      tags:
      - Project
      description: Retrieve Vector Tile for given coordinates company
      parameters:
      - schema:
          type: string
        in: path
        name: cid
        required: true
        description: A unique identifier for a company
      - schema:
          type: number
        in: path
        name: x
        required: true
      - schema:
          type: number
        in: path
        name: y
        required: true
      - schema:
          type: number
        in: path
        name: z
        required: true
      responses:
        '401':
          description: Authorization unsuccessful. See error message for more details
          content:
            application/json:
              schema:
                type: string
                description: Authorization unsuccessful. See error message for more details
                example: Requires Authentication
              example: Requires Authentication
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                type: string
                description: Resource not found
                example: Resource not found
              example: Resource not found
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                type: string
                description: Internal server error
                example: Internal server error
              example: Internal server error
    post:
      summary: Query Vector Tile
      tags:
      - Project
      description: Retrieve Vector Tile for given coordinates and company, filtered based on provided Query
      requestBody:
        content:
          application/json:
            schema:
              type: object
              description: The body to query resources
              properties:
                rowGroupCols:
                  type: array
                  items:
                    type: object
                    properties:
                      id:
                        type: string
                      displayName:
                        type: string
                      field:
                        type: string
                      aggFunc:
                        type: string
                valueCols:
                  type: array
                  items:
                    type: object
                    properties:
                      id:
                        type: string
                      displayName:
                        type: string
                      field:
                        type: string
                      aggFunc:
                        type: string
                sortModel:
                  type: array
                  items:
                    type: object
                    properties:
                      colId:
                        type: string
                      sort:
                        type: string
                        enum:
                        - asc
                        - desc
                groupKeys:
                  type: array
                  items:
                    type: string
                filterModel:
                  type: object
                  additionalProperties:
                    type: object
                    properties:
                      filterType:
                        type: string
                      type:
                        type: string
                      filter:
                        type: string
                      filterTo:
                        type: string
                      operator:
                        type: string
                startRow:
                  type: integer
                endRow:
                  type: integer
                setColumn:
                  type: string
                projectQuery:
                  type: object
                  description: The Project Query to be applied on Asset queries.
                  additionalProperties: true
      parameters:
      - schema:
          type: string
        in: path
        name: cid
        required: true
        description: A unique identifier for a company
      - schema:
          type: number
        in: path
        name: x
        required: true
      - schema:
          type: number
        in: path
        name: y
        required: true
      - schema:
          type: number
        in: path
        name: z
        required: true
      responses:
        '401':
          description: Authorization unsuccessful. See error message for more details
          content:
            application/json:
              schema:
                type: string
                description: Authorization unsuccessful. See error message for more details
                example: Requires Authentication
              example: Requires Authentication
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                type: string
                description: Resource not found
                example: Resource not found
              example: Resource not found
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                type: string
                description: Internal server error
                example: Internal server error
              example: Internal server error
  /api/teams/{teamId}/projects/{projectId}:
    get:
      summary: Get Project
      tags:
      - Project
      description: Retrieve a specific Project from a given team
      parameters:
      - schema:
          type: string
        in: path
        name: teamId
        required: true
        description: A unique identifier for a team, typically in the format of "<company-name>-<state-name>"
      - schema:
          type: string
        in: path
        name: projectId
        required: true
        description: A unique identifier for a project. These project IDs are UUIDs generated by Anderson Optimization
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: false
                properties:
                  id:
                    type: string
                    readOnly: true
                    description: A unique identifier for an project. These project IDs are UUIDs generated by Anderson Optimization
                  created:
                    type: integer
                    readOnly: true
                    description: The Unix timestamp of when the project was created
                  createdBy:
                    type: string
                    readOnly: true
                    description: The user ID that created the project
                  modified:
                    type: integer
                    readOnly: true
                    description: The Unix timestamp of when the project was last modified
                  modifiedBy:
                    type: string
                    readOnly: true
                    description: The user ID that last modified the project
                  meta:
                    type: object
                    readOnly: true
                    description: The metadata for the project
                    additionalProperties: true
                  parameter:
                    type: object
                    description: Project specific data fields
                    additionalProperties: true
                  start:
                    type: object
                    readOnly: true
                    description: Contains initial location values for the project, project name and descripton, and project metadata.
                    additionalProperties: true
                  rn:
                    type: string
                    readOnly: true
                    description: The Resource Path of the Project
                  type:
                    type: string
                    readOnly: true
                    description: The type of project
                  assets:
                    type: object
                    description: Basic Asset information for all assets associated with the project.
                    additionalProperties: true
                example:
                  id: -N0rCjgIfcdviskTq
                  created: 1588888888
                  createdBy: user-id
                  modified: 1588888888
                  modifiedBy: user-id
                  meta: {}
                  parameter: {}
                  start: {}
                  rn: team/company-ny/project/-N0rCjgIfcdviskTq
                  type: project:greenfieldoff
                  assets: {}
              example:
                id: -N0rCjgIfcdviskTq
                created: 1588888888
                createdBy: user-id
                modified: 1588888888
                modifiedBy: user-id
                meta: {}
                parameter: {}
                start: {}
                rn: team/company-ny/project/-N0rCjgIfcdviskTq
                type: project:greenfieldoff
                assets: {}
        '401':
          description: Authorization unsuccessful. See error message for more details
          content:
            application/json:
              schema:
                type: string
                description: Authorization unsuccessful. See error message for more details
                example: Requires Authentication
              example: Requires Authentication
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                type: string
                description: Resource not found
                example: Resource not found
              example: Resource not found
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                type: string
                description: Internal server error
                example: Internal server error
              example: Internal server error
    patch:
      summary: Update Project
      tags:
      - Project
      description: Update a specific Project on a given team from partial JSON
      requestBody:
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              properties:
                assets:
                  type: object
                  description: Basic Asset information for all assets associated with the project.
                  additionalProperties: true
                parameter:
                  type: object
                  description: Project specific data fields
                  additionalProperties: true
                start:
                  type: object
                  description: Contains initial location values for the project, project name and descripton, and project metadata.
                  additionalProperties: true
      parameters:
      - schema:
          type: string
        in: path
        name: teamId
        required: true
        description: A unique identifier for a team, typically in the format of "<company-name>-<state-name>"
      - schema:
          type: string
        in: path
        name: projectId
        required: true
        description: A unique identifier for a project. These project IDs are UUIDs generated by Anderson Optimization
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: false
                properties:
                  id:
                    type: string
                    readOnly: true
                    description: A unique identifier for an project. These project IDs are UUIDs generated by Anderson Optimization
                  created:
                    type: integer
                    readOnly: true
                    description: The Unix timestamp of when the project was created
                  createdBy:
                    type: string
                    readOnly: true
                    description: The user ID that created the project
                  modified:
                    type: integer
                    readOnly: true
                    description: The Unix timestamp of when the project was last modified
                  modifiedBy:
                    type: string
                    readOnly: true
                    description: The user ID that last modified the project
                  meta:
                    type: object
                    readOnly: true
                    description: The metadata for the project
                    additionalProperties: true
                  parameter:
                    type: object
                    description: Project specific data fields
                    additionalProperties: true
                  start:
                    type: object
                    readOnly: true
                    description: Contains initial location values for the project, project name and descripton, and project metadata.
                    additionalProperties: true
                  rn:
                    type: string
                    readOnly: true
                    description: The Resource Path of the Project
                  type:
                    type: string
                    readOnly: true
                    description: The type of project
                  assets:
                    type: object
                    description: Basic Asset information for all assets associated with the project.
                    additionalProperties: true
                example:
                  id: -N0rCjgIfcdviskTq
                  created: 1588888888
                  createdBy: user-id
                  modified: 1588888888
                  modifiedBy: user-id
                  meta: {}
                  parameter: {}
                  start: {}
                  rn: team/company-ny/project/-N0rCjgIfcdviskTq
                  type: project:greenfieldoff
                  assets: {}
              example:
                id: -N0rCjgIfcdviskTq
                created: 1588888888
                createdBy: user-id
                modified: 1588888888
                modifiedBy: user-id
                meta: {}
                parameter: {}
                start: {}
                rn: team/company-ny/project/-N0rCjgIfcdviskTq
                type: project:greenfieldoff
                assets: {}
        '401':
          description: Authorization unsuccessful. See error message for more details
          content:
            application/json:
              schema:
                type: string
                description: Authorization unsuccessful. See error message for more details
                example: Requires Authentication
              example: Requires Authentication
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                type: string
                description: Internal server error
                example: Internal server error
              example: Internal server error
    delete:
      summary: Delete Project
      tags:
      - Project
      description: Delete a specific Project from a given team
      parameters:
      - schema:
          type: string
        in: path
        name: teamId
        required: true
      - schema:
          type: string
        in: path
        name: projectId
        required: true
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: false
                properties:
                  id:
                    type: string
                    readOnly: true
                    description: A unique identifier for an project. These project IDs are UUIDs generated by Anderson Optimization
                  created:
                    type: integer
                    readOnly: true
                    description: The Unix timestamp of when the project was created
                  createdBy:
                    type: string
                    readOnly: true
                    description: The user ID that created the project
                  modified:
                    type: integer
                    readOnly: true
                    description: The Unix timestamp of when the project was last modified
                  modifiedBy:
                    type: string
                    readOnly: true
                    description: The user ID that last modified the project
                  meta:
                    type: object
                    readOnly: true
                    description: The metadata for the project
                    additionalProperties: true
                  parameter:
                    type: object
                    description: Project specific data fields
                    additionalProperties: true
                  start:
                    type: object
                    readOnly: true
                    description: Contains initial location values for the project, project name and descripton, and project metadata.
                    additionalProperties: true
                  rn:
                    type: string
                    readOnly: true
                    description: The Resource Path of the Project
                  type:
                    type: string
                    readOnly: true
                    description: The type of project
                  assets:
                    type: object
                    description: Basic Asset information for all assets associated with the project.
                    additionalProperties: true
                example:
                  id: -N0rCjgIfcdviskTq
                  created: 1588888888
                  createdBy: user-id
                  modified: 1588888888
                  modifiedBy: user-id
                  meta: {}
                  parameter: {}
                  start: {}
                  rn: team/company-ny/project/-N0rCjgIfcdviskTq
                  type: project:greenfieldoff
                  assets: {}
              example:
                id: -N0rCjgIfcdviskTq
                created: 1588888888
                createdBy: user-id
                modified: 1588888888
                modifiedBy: user-id
                meta: {}
                parameter: {}
                start: {}
                rn: team/company-ny/project/-N0rCjgIfcdviskTq
                type: project:greenfieldoff
                assets: {}
        '401':
          description: Authorization unsuccessful. See error message for more details
          content:
            application/json:
              schema:
                type: string
                description: Authorization unsuccessful. See error message for more details
                example: Requires Authentication
              example: Requires Authentication
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                type: string
                description: Resource not found
                example: Resource not found
              example: Resource not found
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                type: string
                description: Internal server error
                example: Internal server error
              example: Internal server error
  /api/teams/{teamId}/projects/{z}/{x}/{y}:
    get:
      summary: Get Vector Tile
      tags:
      - Project
      description: Retrieve Vector Tile for given coordinates and team
      parameters:
      - schema:
          type: string
        in: path
        name: teamId
        required: true
        description: A unique identifier for a team, typically in the format of "<company-name>-<state-name>"
      - schema:
          type: number
        in: path
        name: x
        required: true
      - schema:
          type: number
        in: path
        name: y
        required: true
      - schema:
          type: number
        in: path
        name: z
        required: true
      responses:
        '401':
          description: Authorization unsuccessful. See error message for more details
          content:
            application/json:
              schema:
                type: string
                description: Authorization unsuccessful. See error message for more details
                example: Requires Authentication
              example: Requires Authentication
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                type: string
                description: Resource not found
                example: Resource not found
              example: Resource not found
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                type: string
                description: Internal server error
                example: Internal server error
              example: Internal server error
    post:
      summary: Query Vector Tile
      tags:
      - Project
      description: Retrieve Vector Tile for given coordinates and team, filtered based on provided Query
      requestBody:
        content:
          application/json:
            schema:
              type: object
              description: The body to query resources
              properties:
                rowGroupCols:
                  type: array
                  items:
                    type: object
                    properties:
                      id:
                        type: string
                      displayName:
                        type: string
                      field:
                        type: string
                      aggFunc:
                        type: string
                valueCols:
                  type: array
                  items:
                    type: object
                    properties:
                      id:
                        type: string
                      displayName:
                        type: string
                      field:
                        type: string
                      aggFunc:
                        type: string
                sortModel:
                  type: array
                  items:
                    type: object
                    properties:
                      colId:
                        type: string
                      sort:
                        type: string
                        enum:
                        - asc
                        - desc
                groupKeys:
                  type: array
                  items:
                    type: string
                filterModel:
                  type: object
                  additionalProperties:
                    type: object
                    properties:
                      filterType:
                        type: string
                      type:
                        type: string
                      filter:
                        type: string
                      filterTo:
                        type: string
                      operator:
                        type: string
                startRow:
                  type: integer
                endRow:
                  type: integer
                setColumn:
                  type: string
                projectQuery:
                  type: object
                  description: The Project Query to be applied on Asset queries.
                  additionalProperties: true
      parameters:
      - schema:
          type: string
        in: path
        name: teamId
        required: true
        description: A unique identifier for a team, typically in the format of "<company-name>-<state-name>"
      - schema:
          type: number
        in: path
        name: x
        required: true
      - schema:
          type: number
        in: path
        name: y
        required: true
      - schema:
          type: number
        in: path
        name: z
        required: true
      responses:
        '401':
          description: Authorization unsuccessful. See error message for more details
          content:
            application/json:
              schema:
                type: string
                description: Authorization unsuccessful. See error message for more details
                example: Requires Authentication
              example: Requires Authentication
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                type: string
                description: Resource not found
                example: Resource not found
              example: Resource not found
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                type: string
                description: Internal server error
                example: Internal server error
              example: Internal server error
  /api/teams/{teamId}/projects:
    get:
      summary: Get All Projects
      tags:
      - Project
      description: Retrieve all Projects from a given team
      parameters:
      - schema:
          type: string
        in: path
        name: teamId
        required: true
        description: A unique identifier for a team, typically in the format of "<company-name>-<state-name>"
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  additionalProperties: false
                  properties:
                    id:
                      type: string
                      readOnly: true
                      description: A unique identifier for an project. These project IDs are UUIDs generated by Anderson Optimization
                    created:
                      type: integer
                      readOnly: true
                      description: The Unix timestamp of when the project was created
                    createdBy:
                      type: string
                      readOnly: true
                      description: The user ID that created the project
                    modified:
                      type: integer
                      readOnly: true
                      description: The Unix timestamp of when the project was last modified
                    modifiedBy:
                      type: string
                      readOnly: true
                      description: The user ID that last modified the project
                    meta:
                      type: object
                      readOnly: true
                      description: The metadata for the project
                      additionalProperties: true
                    parameter:
                      type: object
                      description: Project specific data fields
                      additionalProperties: true
                    start:
                      type: object
                      readOnly: true
                      description: Contains initial location values for the project, project name and descripton, and project metadata.
                      additionalProperties: true
                    rn:
                      type: string
                      readOnly: true
                      description: The Resource Path of the Project
                    type:
                      type: string
                      readOnly: true
                      description: The type of project
                    assets:
                      type: object
                      description: Basic Asset information for all assets associated with the project.
                      additionalProperties: true
                  title: projectOutputSchema
                  example:
                    id: -N0rCjgIfcdviskTq
                    created: 1588888888
                    createdBy: user-id
                    modified: 1588888888
                    modifiedBy: user-id
                    meta: {}
                    parameter: {}
                    start: {}
                    rn: team/company-ny/project/-N0rCjgIfcdviskTq
                    type: project:greenfieldoff
                    assets: {}
        '401':
          description: Authorization unsuccessful. See error message for more details
          content:
            application/json:
              schema:
                type: string
                description: Authorization unsuccessful. See error message for more details
                example: Requires Authentication
              example: Requires Authentication
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                type: string
                description: Resource not found
                example: Resource not found
              example: Resource not found
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                type: string
                description: Internal server error
                example: Internal server error
              example: Internal server error
  /api/teams/{teamId}/projects/:
    post:
      summary: Create Project
      tags:
      - Project
      description: Create a project on a given team
      requestBody:
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              properties:
                assets:
                  type: object
                  description: Basic Asset information for all assets associated with the project.
                  additionalProperties: true
                parameter:
                  type: object
                  description: Project specific data fields
                  additionalProperties: true
                start:
                  type: object
                  description: Contains initial location values for the project, project name and descripton, and project metadata.
                  additionalProperties: true
      parameters:
      - schema:
          type: string
        in: path
        name: teamId
        required: true
        description: A unique identifier for a team, typically in the format of "<company-name>-<state-name>"
      responses:
        '201':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: false
                properties:
                  id:
                    type: string
                    readOnly: true
                    description: A unique identifier for an project. These project IDs are UUIDs generated by Anderson Optimization
                  created:
                    type: integer
                    readOnly: true
                    description: The Unix timestamp of when the project was created
                  createdBy:
                    type: string
                    readOnly: true
                    description: The user ID that created the project
                  modified:
                    type: integer
                    readOnly: true
                    description: The Unix timestamp of when the project was last modified
                  modifiedBy

# --- truncated at 32 KB (60 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/pvcase/refs/heads/main/openapi/pvcase-project-api-openapi.yml