BondsByIssuerQuery

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/bigdata/json-schema/bigdata-bonds-by-issuer-query-schema.json",
  "title": "BondsByIssuerQuery",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/bigdata-fixed-income-api-openapi.yml#/components/schemas/BondsByIssuerQuery",
  "properties": {
    "identifier": {
      "$ref": "#/$defs/SingleIdentifier",
      "description": "Object specifying which identifier you are using to request the bonds the company has issued. You must supply one type and its corresponding value."
    },
    "status": {
      "anyOf": [
        {
          "$ref": "#/$defs/BondStatus"
        },
        {
          "type": "null"
        }
      ],
      "description": "Only return bonds in this status: 'active', 'inactive' or 'defaulted'. Defaults to 'active'; send null to return bonds in every status.",
      "default": "active"
    },
    "cursor": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Cursor",
      "description": "Token for the next page. Send back 'pagination.cursor' from the previous response, with the same identifier and status. Omit it for the first page."
    }
  },
  "additionalProperties": false,
  "type": "object",
  "required": [
    "identifier"
  ],
  "$defs": {
    "BondStatus": {
      "type": "string",
      "enum": [
        "active",
        "inactive",
        "defaulted"
      ],
      "title": "BondStatus",
      "description": "Where a bond stands in its life.\n\n'active' bonds are outstanding and have not reached their maturity date, 'inactive'\nbonds have reached it or been redeemed, and 'defaulted' bonds are in default."
    },
    "IdentifierTypeEnum": {
      "type": "string",
      "enum": [
        "rp_entity_id"
      ],
      "title": "IdentifierTypeEnum"
    },
    "SingleIdentifier": {
      "properties": {
        "type": {
          "$ref": "#/$defs/IdentifierTypeEnum",
          "description": "Object specifying which identifier you are using to request the data. You must supply one type and its corresponding value. Only one identifier should be provided per request."
        },
        "value": {
          "type": "string",
          "maxLength": 6,
          "minLength": 6,
          "title": "Value",
          "description": "Bigdata uses the RavenPack Entity identifier (RP_Entity_ID) to uniquely reference entities such as companies. This identifier is a 6-character alphanumeric code (letters and numbers only). Example: Alphabet Inc. (`4A6F00`)"
        }
      },
      "type": "object",
      "required": [
        "type",
        "value"
      ],
      "title": "SingleIdentifier"
    }
  }
}