StaticFrame OpenAPI

REST API endpoints for searching and retrieving StaticFrame documentation. The schema is available at the base endpoint. Use this URL to configure ChatGPT Actions or other OpenAPI clients. The API uses standard JSON request/response format over HTTPS.

Available Endpoints

POST /api/openapi/search

Search StaticFrame API signatures by method name or pattern.

Request Body

{
  "query": "Frame.from_dict",
  "fullSigSearch": false,  // optional
  "reSearch": false        // optional
}

Response

{
  "count": 4,
  "signatures": [
    "Frame.from_dict()",
    "Frame.from_dict_fields()",
    "Frame.from_dict_records()",
    "Frame.from_dict_records_items()"
  ]
}

POST /api/openapi/get_doc

Get documentation for a StaticFrame API signature.

Request Body

{
  "sig": "Frame.from_dict()"
}

Response

{
  "signature": "Frame.from_dict()",
  "documentation": "Create a Frame from a dictionary..."
}

POST /api/openapi/get_example

Get code example for a StaticFrame API signature.

Request Body

{
  "sig": "Frame.from_dict()"
}

Response

{
  "signature": "Frame.from_dict()",
  "example": ">>> import static_frame as sf\n>>> sf.Frame.from_dict(dict(a=(1,2), b=(3,4)))\n<Frame>..."
}

StaticFrame site v2.0.2. Report issues or feature requests at the static-frame-www GitHub repository.