Data

Antibody records

Antibody metadata with per-application recommendations and figure URLs.

This endpoint has a side effect. Called without preview=true it returns only what is new since your last call and advances your review cursor, and is limited to one such call an hour - so a client that fails while parsing loses that delta. Use preview=true, or advance_cursor=false, or prefer /manifest/ with an ETag, which is idempotent.

get/antibodies/

Request

Base URL: https://onlygoodantibodies.co.uk/api/v1
URL: https://onlygoodantibodies.co.uk/api/v1/antibodies/
Auth: none required

Query parameters

previewboolean

Full set, no hourly gate, cursor untouched.

advance_cursorboolean

false reads the delta without consuming it.

sincestring

genestring

applicationstring

Example:WB

Recommended for that application: WB, IP, ICC-IF, FC, IHC. Everyday names are accepted too — IF or ICC for ICC-IF, western blot, immunoprecipitation, flow, immunohistochemistry; case, spaces and punctuation are ignored. An unknown value is refused with 400 (since 2.3.0 — it was ignored), and application_filter in the reply is the code it was read as.

recommended_onlyboolean

limitinteger

offsetinteger

Response

Success.

consumerstring

countinteger

matchedinteger

application_filter'WB' | 'IP' | 'ICC-IF' | 'FC' | 'IHC' | 'null' nullable

The application code ?application= was read as; null when not asked.

completeboolean

cursor_advancedboolean

previewboolean

sincestring nullable

recommendation_scopestring

What an OGA recommendation does and does not cover. The same sentence on every response, and the same one the public pages carry.

application_notesobject

Temporary notices keyed by application (WB, IP, ICC-IF, FC, IHC). Show the sentence beside that application's results. Empty when no notice is in force.

Example response

{
  "recommendation_scope": "Results are based on consensus protocols. Antibody performance is assay, protocol and sample dependent, so performance in your own experimental context may differ and needs its own controls.",
  "application_notes": {
    "WB": "The criteria for support in western blot are being re-evaluated. Look at the blot before relying on a western blot result."
  },
  "antibodies": [
    {
      "antibody_name": "ab138501",
      "gene": "ACE",
      "metadata": {
        "rrid": "AB_2687467",
        "supplier": "Abcam",
        "host": "Rabbit",
        "clonality": "Recombinant monoclonal"
      },
      "oga_support": {
        "WB": "limited_support",
        "IP": "limited_support",
        "ICC-IF": "limited_support",
        "FC": "limited_support",
        "IHC": "limited_support"
      },
      "oga_recommendations": {
        "WB": "recommended",
        "IP": "recommended",
        "ICC-IF": "recommended",
        "FC": "recommended",
        "IHC": "recommended"
      },
      "oga_display": {
        "WB": {
          "support": "limited_support",
          "sentence": "Limited support - detects the target"
        },
        "IP": {
          "support": "limited_support",
          "sentence": "Limited support - detects the target"
        },
        "ICC-IF": {
          "support": "limited_support",
          "sentence": "Limited support - detects the target"
        },
        "FC": {
          "support": "limited_support",
          "sentence": "Limited support - detects the target"
        },
        "IHC": {
          "support": "limited_support",
          "sentence": "Limited support - detects the target"
        }
      },
      "oga_methods": {
        "WB": {
          "amount": "1/500"
        },
        "IP": {
          "amount": "1/500"
        },
        "ICC-IF": {
          "amount": "1/500"
        },
        "FC": {
          "amount": "1/500"
        },
        "IHC": {
          "amount": "1/500"
        }
      },
      "experiments": [
        {
          "experiment_type_display": "Western Blot"
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.